blob: dfba6c0caf20b6a40ce4688f442ebe4fa5297de0 [file] [log] [blame]
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +00001[See end for ** TIPS ]
David Scherer7aced172000-08-15 01:13:23 +00002
3Click on the dotted line at the top of a menu to "tear it off": a
4separate window containing the menu is created.
5
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +00006File Menu:
David Scherer7aced172000-08-15 01:13:23 +00007
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +00008 New Window -- create a new editing window
David Scherer7aced172000-08-15 01:13:23 +00009 Open... -- open an existing file
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000010 Recent Files... -- open a list of recent files
11 Open Module... -- open an existing module (searches sys.path)
12 Class Browser -- show classes and methods in current file
13 Path Browser -- show sys.path directories, modules, classes
14 and methods
David Scherer7aced172000-08-15 01:13:23 +000015 ---
16 Save -- save current window to the associated file (unsaved
17 windows have a * before and after the window title)
18
19 Save As... -- save current window to new file, which becomes
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000020 the associated file
David Scherer7aced172000-08-15 01:13:23 +000021 Save Copy As... -- save current window to different file
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000022 without changing the associated file
23 ---
24 Print Window -- print the current window
David Scherer7aced172000-08-15 01:13:23 +000025 ---
26 Close -- close current window (asks to save if unsaved)
27 Exit -- close all windows and quit IDLE (asks to save if unsaved)
28
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000029Edit Menu:
David Scherer7aced172000-08-15 01:13:23 +000030
31 Undo -- Undo last change to current window (max 1000 changes)
32 Redo -- Redo last undone change to current window
33 ---
34 Cut -- Copy selection into system-wide clipboard; then delete selection
35 Copy -- Copy selection into system-wide clipboard
36 Paste -- Insert system-wide clipboard into window
37 Select All -- Select the entire contents of the edit buffer
38 ---
39 Find... -- Open a search dialog box with many options
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000040 Find Again -- Repeat last search
41 Find Selection -- Search for the string in the selection
David Scherer7aced172000-08-15 01:13:23 +000042 Find in Files... -- Open a search dialog box for searching files
43 Replace... -- Open a search-and-replace dialog box
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000044 Go to Line -- Ask for a line number and show that line
45 Expand Word -- Expand the word you have typed to match another
46 word in the same buffer; repeat to get a different
47 expansion
48
49Format Menu (only in Edit window):
50
51 Indent Region -- Shift selected lines right 4 spaces
52 Dedent Region -- Shift selected lines left 4 spaces
53 Comment Out Region -- Insert ## in front of selected lines
54 Uncomment Region -- Remove leading # or ## from selected lines
55 Tabify Region -- Turns *leading* stretches of spaces into tabs
56 Untabify Region -- Turn *all* tabs into the right number of spaces
57 New Indent Width... -- Open dialog to change indent width
David Scherer7aced172000-08-15 01:13:23 +000058 Format Paragraph -- Reformat the current blank-line-separated paragraph
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000059
60Run Menu (only in Edit window):
61
62 Python Shell -- Open or wake up the Python shell window
David Scherer7aced172000-08-15 01:13:23 +000063 ---
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000064 Check Module -- Run a syntax check on the module
65 Run Script -- Execute the current file in the __main__ namespace
David Scherer7aced172000-08-15 01:13:23 +000066
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000067Settings Menu:
David Scherer7aced172000-08-15 01:13:23 +000068
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000069 Configure IDLE -- Open a configuration dialog. Fonts, indentation,
70 keybindings, and color themes may be altered.
71 Startup preferences may be set.
72 ---
73 Revert to Default Settings -- Restore original settings
74
75Windows Menu:
76
77 Zoom Height -- toggles the window between configured size
David Scherer7aced172000-08-15 01:13:23 +000078 and maximum height.
79 ---
80 The rest of this menu lists the names of all open windows;
81 select one to bring it to the foreground (deiconifying it if
82 necessary).
83
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000084Debug Menu (in the Python Shell window only):
David Scherer7aced172000-08-15 01:13:23 +000085
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +000086 Go to File/Line -- look around the insert point for a filename
87 and linenumber, open the file, and show the line
88 Stack Viewer -- show the stack traceback of the last exception
89 Debugger (toggle) -- Run commands in the shell under the debugger
90 Auto-open Stack Viewer (toggle) -- Open stack viewer on traceback
91
92Help Menu:
93
94 IDLE Help -- Display this file
95 Python Documentation -- Access local Python documentation, if
96 installed. Otherwise access python.org.
97 Advice -- Emergency Only!
98 IDLE Readme -- Background discussion and change details
99 ---
100 About IDLE --- Version, copyright, license, credits
101
102** TIPS
103========
David Scherer7aced172000-08-15 01:13:23 +0000104
105Basic editing and navigation:
106
107 Backspace deletes to the left; DEL deletes to the right
108 Arrow keys and Page Up/Down to move around
109 Home/End go to begin/end of line
110 Control-Home/End go to begin/end of file
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +0000111 Some Emacs or standard Windows bindings may work.
112 Keybindings are selected in the Settings Dialog, look there.
David Scherer7aced172000-08-15 01:13:23 +0000113
114Automatic indentation:
115
116 After a block-opening statement, the next line is indented by
117 4 spaces (in the Python Shell window by one tab). After
118 certain keywords (break, return etc.) the next line is
119 dedented. In leading indentation, Backspace deletes up to 4
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +0000120 spaces if they are there. Tab inserts spaces (in the
121 Python Shell window one tab), number depends on Indent Width
122 See also the indent/dedent region commands in the edit menu.
David Scherer7aced172000-08-15 01:13:23 +0000123
124Python Shell window:
125
126 ^C interrupts executing command
127 ^D sends end-of-file; closes window if typed at >>> prompt
128
129 Command history:
130
131 Alt-p retrieves previous command matching what you have typed
132 Alt-n retrieves next
133 Return while on any previous command retrieves that command
134 Alt-/ (Expand word) is also useful here
135
136Syntax colors:
137
138 The coloring is applied in a background "thread", so you may
139 occasionally see uncolorized text. To change the color
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +0000140 scheme, use the Settings/Highlighting dialog.
David Scherer7aced172000-08-15 01:13:23 +0000141
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +0000142 Python default syntax colors:
David Scherer7aced172000-08-15 01:13:23 +0000143
144 Keywords orange
145 Strings green
146 Comments red
147 Definitions blue
148
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +0000149 Shell default colors:
David Scherer7aced172000-08-15 01:13:23 +0000150
151 Console output brown
152 stdout blue
153 stderr dark green
154 stdin black
155
156Other preferences:
157
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +0000158 The font preferences, keybinding, and startup preferences can
159 be changed using the Settings dialog.
David Scherer7aced172000-08-15 01:13:23 +0000160
161Command line usage:
Kurt B. Kaiser39c7b452002-12-11 04:42:39 +0000162
163 Enter idle -h at the command prompt to get a usage message.