From 18032632ab27eed51d705c2be7b64bac708279bf Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Sun, 28 Oct 2018 16:21:18 -0400 Subject: Issue 35093: Document the IDLE document viewer in the IDLE doc. (#10195) Add a paragraph in "Help and preferences", "Help sources" subsection. --- Doc/library/idle.rst | 30 ++++++++++++++-------- Lib/idlelib/help.html | 30 ++++++++++++++-------- .../IDLE/2018-10-28-15-53-51.bpo-35093.cH-tli.rst | 2 ++ 3 files changed, 42 insertions(+), 20 deletions(-) create mode 100644 Misc/NEWS.d/next/IDLE/2018-10-28-15-53-51.bpo-35093.cH-tli.rst diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst index aaf4e9e..22a82e1 100644 --- a/Doc/library/idle.rst +++ b/Doc/library/idle.rst @@ -295,7 +295,7 @@ About IDLE Display version, copyright, license, credits, and more. IDLE Help - Display a help file for IDLE detailing the menu options, basic editing and + Display this IDLE document, detailing the menu options, basic editing and navigation, and other tips. Python Docs @@ -306,7 +306,8 @@ Turtle Demo Run the turtledemo module with example Python code and turtle drawings. Additional help sources may be added here with the Configure IDLE dialog under -the General tab. +the General tab. See the "Help sources" subsection below for more +on Help menu choices. .. index:: single: Cut @@ -693,15 +694,25 @@ with the default subprocess if at all possible. Help and preferences -------------------- -Additional help sources -^^^^^^^^^^^^^^^^^^^^^^^ +Help sources +^^^^^^^^^^^^ -IDLE includes a help menu entry called "Python Docs" that will open the -extensive sources of help, including tutorials, available at docs.python.org. -Selected URLs can be added or removed from the help menu at any time using the -Configure IDLE dialog. See the IDLE help option in the help menu of IDLE for -more information. +Help menu entry "IDLE Help" displays a formatted html version of the +IDLE chapter of the Library Reference. The result, in a read-only +tkinter text window, is close to what one sees in a web browser. +Navigate through the text with a mousewheel, +the scrollbar, or up and down arrow keys held down. +Or click the TOC (Table of Contents) button and select a section +header in the opened box. + +Help menu entry "Python Docs" opens the extensive sources of help, +including tutorials, available at docs.python.org/x.y, where 'x.y' +is the currently running Python version. If your system +has an off-line copy of the docs (this may be an installation option), +that will be opened instead. +Selected URLs can be added or removed from the help menu at any time using the +General tab of the Configure IDLE dialog . Setting preferences ^^^^^^^^^^^^^^^^^^^ @@ -711,7 +722,6 @@ changed via Configure IDLE on the Option menu. Keys can be user defined; IDLE ships with four built-in key sets. In addition, a user can create a custom key set in the Configure IDLE dialog under the keys tab. - Extensions ^^^^^^^^^^ diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html index 684d75d..b8fecce 100644 --- a/Lib/idlelib/help.html +++ b/Lib/idlelib/help.html @@ -332,7 +332,7 @@ it to the foreground (deiconifying it if necessary).

About IDLE
Display version, copyright, license, credits, and more.
IDLE Help
-
Display a help file for IDLE detailing the menu options, basic editing and +
Display this IDLE document, detailing the menu options, basic editing and navigation, and other tips.
Python Docs
Access local Python documentation, if installed, or start a web browser @@ -341,7 +341,8 @@ and open docs.python.org showing the latest Python documentation.
Run the turtledemo module with example Python code and turtle drawings.

Additional help sources may be added here with the Configure IDLE dialog under -the General tab.

+the General tab. See the “Help sources” subsection below for more +on Help menu choices.

Context Menus

@@ -666,13 +667,22 @@ with the default subprocess if at all possible.

Help and preferences

-
-

Additional help sources

-

IDLE includes a help menu entry called “Python Docs” that will open the -extensive sources of help, including tutorials, available at docs.python.org. -Selected URLs can be added or removed from the help menu at any time using the -Configure IDLE dialog. See the IDLE help option in the help menu of IDLE for -more information.

+
+

Help sources

+

Help menu entry “IDLE Help” displays a formatted html version of the +IDLE chapter of the Library Reference. The result, in a read-only +tkinter text window, is close to what one sees in a web browser. +Navigate through the text with a mousewheel, +the scrollbar, or up and down arrow keys held down. +Or click the TOC (Table of Contents) button and select a section +header in the opened box.

+

Help menu entry “Python Docs” opens the extensive sources of help, +including tutorials, available at docs.python.org/x.y, where ‘x.y’ +is the currently running Python version. If your system +has an off-line copy of the docs (this may be an installation option), +that will be opened instead.

+

Selected URLs can be added or removed from the help menu at any time using the +General tab of the Configure IDLE dialog .

Setting preferences

@@ -731,7 +741,7 @@ also used for testing.

  • Help and preferences diff --git a/Misc/NEWS.d/next/IDLE/2018-10-28-15-53-51.bpo-35093.cH-tli.rst b/Misc/NEWS.d/next/IDLE/2018-10-28-15-53-51.bpo-35093.cH-tli.rst new file mode 100644 index 0000000..a330b99 --- /dev/null +++ b/Misc/NEWS.d/next/IDLE/2018-10-28-15-53-51.bpo-35093.cH-tli.rst @@ -0,0 +1,2 @@ +Document the IDLE document viewer in the IDLE doc. Add a paragraph in "Help +and preferences", "Help sources" subsection. -- cgit v0.12