Fix three PyChecker-detected gotchas.
[python/dscho.git] / Mac / Contrib / PythonDetector / readme.txt
blobe6b61da052ed7998978107f32de268054932f215
1 ========================================================================
2               Copyright (c) 1999 Bill Bedford                           
3 ========================================================================
4 Permission to use, copy, modify, and distribute this software and its
5 documentation for any purpose and without fee is hereby granted,
6 provided that the above copyright notice appear in all copies and that
7 both that the copyright notice and warranty disclaimer appear in
8 supporting documentation.
10 Bill Bedford disclaims all warranties with regard to this software,
11 including all implied warranties of merchantability and fitness.  In
12 no event shall Bill Bedford be liable for any special, indirect or
13 consequential damages or any damages whatsoever resulting from loss of
14 use, data or profits, whether in an action of contract, negligence or
15 other tortuous action, arising out of or in connection with the use or
16 performance of this software.
17 ========================================================================
20 PythonDetectors is a set of Apple Data Detectors that will open an entry in 
21 the Python Library from a keyword in contextual menus.  It looks up either 
22 module name and open the relevant page or looks up a built in function and 
23 opens at the entry in the Builtin functions page. 
25 If anyone would like more functionality please contact me.
27 To use it you must have Apple Data Detectors 1.0.2 installed This can be 
28 obtained from http://www.apple.com/applescript/data_detectors/ 
30 Two action files are provided "OpenPythonLib" will open the library file 
31 with whatever application is defined as the Internet Config 'file' helper.  
32 "OpenPythonLib with NS" opens the library file with Netscape.  
34 Instructions
35 ============
37 1/ Open the two apple script files with the Script Editor and change the 
38 first compiled line to point to the location of your Python Library 
39 folder.
41 2/ Open the Apple Data Detectors Control Panel and choose Install Detector 
42 File...  from the File menu.
44 3/  Pick a Detector file from the dialog.
46 4/  Let the Data Detectors Control Panel optimize the detector.
48 5/ Choose Install Action File...  from the File menu.
50 6/ Pick an action file from the dialog.
52 7/ The Data Detectors Control Panel will automatically place the new action 
53 with its detector.  You can click on the action in the control panel window 
54 to view information about its use.
57 Gotchas
58 =======
60 Unfortunately ADD only works with the US keyboard installed.