classification
Title: IDLE: Improve and document help doc viewer
Type: enhancement Stage:
Components: IDLE Versions: Python 3.8, Python 3.7, Python 3.6
process
Status: open Resolution:
Dependencies: 33397 34548 35093 Superseder:
Assigned To: terry.reedy Nosy List: cheryl.sabella, terry.reedy
Priority: normal Keywords:

Created on 2018-05-01 04:07 by terry.reedy, last changed 2018-10-28 20:33 by terry.reedy.

Messages (4)
msg315982 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-05-01 04:07
The IDLE help doc viewer displays help.html in a tk Text subclass. This index issue follows #25198, which fixed three immediate issues, and left the following for later.  When tackled, the items below should be separate issues and PRs listed as dependencies.  

1. msg251181 Base font size on user config and control-mousewheel.
2. "       " Make within-document html links in work in the viewer.
3. "       " Make Find (^F) work within the viewer.
4. msg251571 Navigate with keys as in editor.
5. msg251556 Open TOC with Key (Esc?, F1?); enhance navigation.

New items:

6. Add Help Doc Viewer doc to Help section.
   I prefer not adding a menu and see an entry as an alternative.

7. 1, 3, and 4 should try to avoid duplicating editor code.  Perhaps we should enhance the plain text viewer and use it as a superclass for both base editor and html viewer.
msg317586 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-05-24 16:14
Point 1 is #33397.
msg326126 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-09-23 02:54
8. Use configured colors.  #34548 does this for text viewer, so would be automatic if subclass from that.

9. Upgrade text viewer to include 1, 3, and 4.  It also should use proportional font that help viewer uses.

10 Can Scripts/rst2html be used to directly generate idlelib/help.html from Doc/library/idle.rst?
msg328742 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-10-28 20:33
#35093 implements item 6, (initially) doc the help viewer.  When we improve the help viewer, we should revise the doc at the same time.
(I unlinked comment with wrong issue number.)
History
Date User Action Args
2018-10-28 20:33:56terry.reedysetdependencies: + IDLE: document the help document viewer, - Checking for abstractmethod implementation fails to consider MRO for builtins
2018-10-28 20:33:29terry.reedysetmessages: + msg328742
2018-10-28 20:32:48terry.reedysetmessages: - msg328739
2018-10-28 20:27:51terry.reedysetdependencies: + Checking for abstractmethod implementation fails to consider MRO for builtins
messages: + msg328739
2018-09-23 04:08:29terry.reedysetdependencies: + IDLE: Make TextView use the configured theme colors
2018-09-23 02:54:41terry.reedysetmessages: + msg326126
2018-05-24 16:14:40terry.reedysetmessages: + msg317586
2018-05-01 05:56:33terry.reedylinkissue25198 superseder
2018-05-01 05:47:53terry.reedysetdependencies: + IDLE help viewer: let users control font size
2018-05-01 04:07:44terry.reedycreate