[Patches] [ python-Patches-470607 ] HTML version of the Idle "documentation"
noreply@sourceforge.net
noreply@sourceforge.net
Fri, 12 Oct 2001 08:13:39 -0700
Patches item #470607, was opened at 2001-10-12 08:13
You can respond by visiting:
http://sourceforge.net/tracker/?func=detail&atid=305470&aid=470607&group_id=5470
Category: IDLE
Group: None
Status: Open
Resolution: None
Priority: 5
Submitted By: Internet Discovery (idiscovery)
Assigned to: Nobody/Anonymous (nobody)
Summary: HTML version of the Idle "documentation"
Initial Comment:
<HTML>
<HEAD>
<TITLE>Idle Help</TITLE>
</HEAD>
<BODY>
<H2>Features</H2>
IDLE has the following features:
<UL>
<LI> coded in 100% pure Python, using the Tkinter GUI toolkit (i.e. Tcl/Tk)
<LI> cross-platform: works on Windows and Unix (on the Mac, there are
currently problems with Tcl/Tk)
<LI> multi-window text editor with multiple undo, Python colorizing
and many other features, e.g. smart indent and call tips
<LI> Python shell window (a.k.a. interactive interpreter)
<LI> debugger (not complete, but you can set breakpoints, view and step)
</UL>
<H2> Menus</H2>
<H3>File menu:</H3>
<DL>
<DT>New window</DT><DD>create a new editing window
<DT>Open...</DT><DD>open an existing file
<DT>Open module...</DT><DD>open an existing module (searches sys.path)
<DT>Class browser</DT><DD>show classes and methods in current file
<DT>Path browser</DT><DD>show sys.path directories, modules, classes
and methods
<HR>
<DT>Save</DT><DD>save current window to the associated file (unsaved
windows have a * before and after the window title)
<DT>Save As...</DT><DD>save current window to new file, which becomes
the associated file
<DT>Save Copy As...</DT><DD>save current window to different file
without changing the associated file
<HR>
<DT>Close</DT><DD>close current window (asks to save if unsaved)
<DT>Exit</DT><DD>close all windows and quit IDLE (asks to save if unsaved)
</DL>
<H3>Edit menu:</H3>
<DL>
<DT>Undo</DT><DD>Undo last change to current window (max 1000 changes)
<DT>Redo</DT><DD>Redo last undone change to current window
<HR>
<DT>Cut</DT><DD>Copy selection into system-wide clipboard; then delete selection
<DT>Copy</DT><DD>Copy selection into system-wide clipboard
<DT>Paste</DT><DD>Insert system-wide clipboard into window
<DT>Select All</DT><DD>Select the entire contents of the edit buffer
<HR>
<DT>Find...</DT><DD>Open a search dialog box with many options
<DT>Find again</DT><DD>Repeat last search
<DT>Find selection</DT><DD>Search for the string in the selection
<DT>Find in Files...</DT><DD>Open a search dialog box for searching files
<DT>Replace...</DT><DD>Open a search-and-replace dialog box
<DT>Go to line</DT><DD>Ask for a line number and show that line
<HR>
<DT>Indent region</DT><DD>Shift selected lines right 4 spaces
<DT>Dedent region</DT><DD>Shift selected lines left 4 spaces
<DT>Comment out region</DT><DD>Insert ## in front of selected lines
<DT>Uncomment region</DT><DD>Remove leading # or ## from selected lines
<DT>Tabify region</DT><DD>Turns <EMPH>leading</EMPH> stretches of spaces into tabs
<DT>Untabify region</DT><DD>Turn <EMPH>all</EMPH> tabs into the right number of spaces
<DT>Expand word</DT><DD>Expand the word you have typed to match another
word in the same buffer; repeat to get a different expansion
<DT>Format Paragraph</DT><DD>Reformat the current blank-line-separated paragraph
<HR>
<DT>Import module</DT><DD>Import or reload the current module
<DT>Run script</DT><DD>Execute the current file in the __main__ namespace
</DL>
<H3>Windows menu:</H3>
<DL>
<DT>Zoom Height</DT><DD>toggles the window between normal size (24x80)
and maximum height.
<HR>
</DL>
The rest of this menu lists the names of all open windows; select one
to bring it to the foreground (deiconifying it if necessary).
<H3>Debug menu (in the Python Shell window only):</H3>
<DL>
<DT>Go to file/line</DT><DD>look around the insert point for a filename
and linenumber, open the file, and show the line.
<DT>Open stack viewer</DT><DD>show the stack traceback of the last exception
<DT>Debugger toggle</DT><DD>Run commands in the shell under the debugger
<DT>JIT Stack viewer toggle</DT><DD>Open stack viewer on traceback
</DL>
<H2>Basic editing and navigation:</H2>
<UL>
<LI> Backspace deletes to the left; DEL deletes to the right
<LI> Arrow keys and Page Up/Down to move around
<LI> Home/End go to begin/end of line
<LI> Control-Home/End go to begin/end of file
<LI> Some Emacs bindings may also work, e.g. ^B/^P/^A/^E/^D/^L
</UL>
<H3>Automatic indentation:</H3>
After a block-opening statement, the next line is indented by 4 spaces
(in the Python Shell window by one tab). After certain keywords
(break, return etc.) the next line is dedented. In leading
indentation, Backspace deletes up to 4 spaces if they are there. Tab
inserts 1-4 spaces (in the Python Shell window one tab). See also the
indent/dedent region commands in the edit menu.
<H3>Python Shell window:</H3>
<UL>
<LI> ^C interrupts executing command
<LI> ^D sends end-of-file; closes window if typed at >>> prompt
</UL>
<H4>Command history:</H4>
<UL>
<LI> Alt-p retrieves previous command matching what you have typed
<LI> Alt-n retrieves next
<LI> Return while on any previous command retrieves that command
<LI> Alt-/ (Expand word) is also useful here
</UL>
<H4>Syntax colors:</H4>
The coloring is applied in a background "thread", so you may
occasionally see uncolorized text. To change the color scheme, edit
the [Colors] section in config.txt.
<DL>
<DT>Python syntax colors:
<DL>
<DT> Keywords:</DT> orange
<DT> Strings :</DT> green
<DT> Comments:</DT> red
<DT> Definitions:</DT> blue
</DL>
<DT>Shell colors:
<DL>
<DT> Console output:</DT> brown
<DT> stdout:</DT> blue
<DT> stderr:</DT> dark green
<DT> stdin:</DT> black
</DL>
</DL>
</H3>Command line usage:</H3>
<PRE>
idle.py [-c command] [-d] [-e] [-s] [-t title] [arg] ...
-c command run this command
-d enable debugger
-e edit mode; arguments are files to be edited
-s run $IDLESTARTUP or $PYTHONSTARTUP first
-t title set title of shell window
</PRE>
<P>
If there are arguments:
<OL>
<LI> If -e is used, arguments are files opened for editing and
sys.argv reflects the arguments passed to IDLE itself.
<LI>
Otherwise, if -c is used, all arguments are placed in
sys.argv[1:...], with sys.argv[0] set to '-c'.
<LI>
Otherwise, if neither -e nor -c is used, the first
argument is a script which is executed with the remaining
arguments in sys.argv[1:...] and sys.argv[0] set to the
script name. If the script name is '-', no script is
executed but an interactive Python session is started; the
arguments are still available in sys.argv.
</OL>
</BODY>
</HTML>
----------------------------------------------------------------------
You can respond by visiting:
http://sourceforge.net/tracker/?func=detail&atid=305470&aid=470607&group_id=5470