diff -r 0f827775f7b7 Doc/Makefile --- a/Doc/Makefile Wed Feb 13 21:17:13 2013 -0500 +++ b/Doc/Makefile Wed Feb 20 13:38:29 2013 -0600 @@ -31,6 +31,7 @@ @echo " linkcheck to check all external links for integrity" @echo " coverage to check documentation coverage for library and C API" @echo " doctest to run doctests in the documentation" + @echo " idledoc to regenerate the IDLE help file" @echo " pydoc-topics to regenerate the pydoc topics file" @echo " dist to create a \"dist\" directory with archived docs for download" @echo " suspicious to check for suspicious markup in output text" @@ -115,6 +116,13 @@ @echo "Building finished; now copy build/pydoc-topics/topics.py" \ "to ../Lib/pydoc_data/topics.py" +idledoc: BUILDER = text +idledoc: SOURCES = library/idle.rst +idledoc: build + @echo "Build finished; now copying build/text/library/idle.txt to" \ + "../Lib/idlelib/help.txt." + @cp build/text/library/idle.txt ../Lib/idlelib/help.txt + htmlview: html $(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')" diff -r 0f827775f7b7 Doc/library/idle.rst --- a/Doc/library/idle.rst Wed Feb 13 21:17:13 2013 -0500 +++ b/Doc/library/idle.rst Wed Feb 20 13:38:29 2013 -0600 @@ -51,15 +51,17 @@ Recent Files Open a list of recent files +.. index:: + single: Class browser + single: Path browser + Class browser Show classes and methods in current file Path browser Show sys.path directories, modules, classes and methods -.. index:: - single: Class browser - single: Path browser +--- Save Save current window to the associated file (unsaved windows have a @@ -71,9 +73,13 @@ Save Copy As... Save current window to different file without changing the associated file +--- + Print Window Print the current window +--- + Close Close current window (asks to save if unsaved) @@ -90,6 +96,8 @@ Redo Redo last undone change to current window +--- + Cut Copy selection into system-wide clipboard; then delete the selection @@ -102,6 +110,8 @@ Select All Select the entire contents of the edit buffer +--- + Find... Open a search dialog box with many options @@ -169,6 +179,8 @@ Reformat the current blank-line-separated paragraph. All lines in the paragraph will be formatted to less than 80 columns. +--- + Strip trailing whitespace Removes any space characters after the end of the last non-space character @@ -183,6 +195,8 @@ Python Shell Open or wake up the Python Shell window +--- + Check module Check the syntax of the module currently open in the Editor window. If the module has not been saved IDLE will prompt the user to save the code. @@ -231,6 +245,8 @@ themes may be altered. Startup Preferences may be set, and additional help sources can be specified. +--- + Code Context (toggle)(Editor Window only) Open a pane at the top of the edit window which shows the block context of the section of code which is scrolling off the top of the window. @@ -243,6 +259,8 @@ height. The initial size is in the Configure IDLE dialog under the general tab. +--- + The rest of this menu lists the names of all open windows; select one to bring it to the foreground (deiconifying it if necessary). @@ -252,6 +270,8 @@ About IDLE Version, copyright, license, credits +--- + IDLE Help Display a help file for IDLE detailing the menu options, basic editing and navigation, and other tips. @@ -260,6 +280,8 @@ Access local Python documentation, if installed. Or will start a web browser and open docs.python.org showing the latest Python documentation. +--- + Additional help sources may be added here with the Configure IDLE dialog under the General tab. @@ -306,6 +328,8 @@ Paste Insert system-wide clipboard into window +--- + Go to file/line Same as in Debug menu. @@ -315,39 +339,40 @@ * :kbd:`Backspace` deletes to the left; :kbd:`Del` deletes to the right -* :kbd:`C-Backspace` delete word left; :kbd:`C-Del` delete word to the right +* :kbd:`Control-Backspace` delete word left; :kbd:`Control-Del` delete word to + the right * Arrow keys and :kbd:`Page Up`/:kbd:`Page Down` to move around -* :kbd:`C-LeftArrow` and :kbd:`C-RightArrow` moves by words +* :kbd:`Control-LeftArrow` and :kbd:`Control-RightArrow` moves by words * :kbd:`Home`/:kbd:`End` go to begin/end of line -* :kbd:`C-Home`/:kbd:`C-End` go to begin/end of file +* :kbd:`Control-Home`/:kbd:`Control-End` go to begin/end of file * Some useful Emacs bindings are inherited from Tcl/Tk: - * :kbd:`C-a` beginning of line + * :kbd:`Control-a` beginning of line - * :kbd:`C-e` end of line + * :kbd:`Control-e` end of line - * :kbd:`C-k` kill line (but doesn't put it in clipboard) + * :kbd:`Control-k` kill line (but doesn't put it in clipboard) - * :kbd:`C-l` center window around the insertion point + * :kbd:`Control-l` center window around the insertion point - * :kbd:`C-b` go backwards one character without deleting (usually you can + * :kbd:`Control-b` go backwards one character without deleting (usually you + can also use the cursor key for this) + + * :kbd:`Control-f` go forward one character without deleting (usually you can also use the cursor key for this) - * :kbd:`C-f` go forward one character without deleting (usually you can - also use the cursor key for this) + * :kbd:`Control-p` go up one line (usually you can also use the cursor key + for this) - * :kbd:`C-p` go up one line (usually you can also use the cursor key for - this) + * :kbd:`Control-d` delete next character - * :kbd:`C-d` delete next character - -Standard keybindings (like :kbd:`C-c` to copy and :kbd:`C-v` to paste) -may work. Keybindings are selected in the Configure IDLE dialog. +Standard keybindings (like :kbd:`Control-c` to copy and :kbd:`Control-v` to +paste) may work. Keybindings are selected in the Configure IDLE dialog. Automatic indentation @@ -378,7 +403,7 @@ :kbd:`Tab` will supply that completion without opening the ACW. 'Show Completions' will force open a completions window, by default the -:kbd:`C-space` will open a completions window. In an empty +:kbd:`Control-space` will open a completions window. In an empty string, this will contain the files in the current directory. On a blank line, it will contain the built-in and user-defined functions and classes in the current name spaces, plus any modules imported. If some @@ -411,19 +436,19 @@ Python Shell window ^^^^^^^^^^^^^^^^^^^ -* :kbd:`C-c` interrupts executing command +* :kbd:`Control-c` interrupts executing command -* :kbd:`C-d` sends end-of-file; closes window if typed at a ``>>>`` prompt - (this is :kbd:`C-z` on Windows). +* :kbd:`Control-d` sends end-of-file; closes window if typed at a ``>>>`` prompt + (this is :kbd:`Control-z` on Windows). * :kbd:`Alt-/` (Expand word) is also useful to reduce typing Command history * :kbd:`Alt-p` retrieves previous command matching what you have typed. On - OS X use :kbd:`C-p`. + OS X use :kbd:`Control-p`. - * :kbd:`Alt-n` retrieves next. On OS X use :kbd:`C-n`. + * :kbd:`Alt-n` retrieves next. On OS X use :kbd:`Control-n`. * :kbd:`Return` while on any previous command retrieves that command @@ -508,6 +533,23 @@ the arguments are still available in ``sys.argv``. +Running without a subprocess +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If IDLE is started with the -n command line switch it will run in a +single process and will not create the subprocess which runs the RPC +Python execution server. This can be useful if Python cannot create +the subprocess or the RPC socket interface on your platform. However, +in this mode user code is not isolated from IDLE itself. Also, the +environment is not restarted when Run/Run Module (F5) is selected. If +your code has been modified, you must reload() the affected modules and +re-import any specific items (e.g. from foo import baz) if the changes +are to take effect. For these reasons, it is preferable to run IDLE +with the default subprocess if at all possible. + +.. deprecated-removed:: 3.4 3.5 + + Additional help sources ----------------------- diff -r 0f827775f7b7 Doc/make.bat --- a/Doc/make.bat Wed Feb 13 21:17:13 2013 -0500 +++ b/Doc/make.bat Wed Feb 20 13:38:29 2013 -0600 @@ -14,6 +14,7 @@ if "%1" EQU "suspicious" goto build if "%1" EQU "linkcheck" goto build if "%1" EQU "changes" goto build +if "%1" EQU "idledoc" goto idledoc if "%1" EQU "checkout" goto checkout if "%1" EQU "update" goto update @@ -30,6 +31,7 @@ echo %this% suspicious echo %this% linkcheck echo %this% changes +echo %this% idledoc echo. goto end @@ -47,6 +49,12 @@ svn update tools/pygments goto end +:idledoc +call make.bat text library\idle.rst +echo Now copying build/text/library/idle.txt to ../Lib/idlelib/help.txt +copy build\text\library\idle.txt ..\Lib\idlelib\help.txt +goto end + :build if not exist build mkdir build if not exist build\%1 mkdir build\%1