Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

IDLE: Improve and document help doc viewer #77577

Open
terryjreedy opened this issue May 1, 2018 · 4 comments
Open

IDLE: Improve and document help doc viewer #77577

terryjreedy opened this issue May 1, 2018 · 4 comments
Assignees
@terryjreedy
Labels
3.7 (EOL) end of life 3.8 only security fixes topic-IDLE type-feature A feature request or enhancement

Comments

@terryjreedy
Copy link
Member

BPO 33396
Nosy @terryjreedy, @csabella
Dependencies
  • bpo-33397: IDLE help viewer: let users control font size
  • bpo-34548: IDLE: Make TextView use the configured theme colors
  • bpo-35093: IDLE: document the help document viewer
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/terryjreedy'
closed_at = None
created_at = <Date 2018-05-01.04:07:44.476>
labels = ['3.8', 'expert-IDLE', 'type-feature', '3.7']
title = 'IDLE: Improve and document help doc viewer'
updated_at = <Date 2018-10-28.20:33:56.137>
user = 'https://github.com/terryjreedy'

    bugs.python.org fields:

    activity = <Date 2018-10-28.20:33:56.137>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2018-05-01.04:07:44.476>
creator = 'terry.reedy'
dependencies = ['33397', '34548', '35093']
files = []
hgrepos = []
issue_num = 33396
keywords = []
message_count = 4.0
messages = ['315982', '317586', '326126', '328742']
nosy_count = 2.0
nosy_names = ['terry.reedy', 'cheryl.sabella']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33396'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']
    @terryjreedy
    Copy link
    Member Author

    The IDLE help doc viewer displays help.html in a tk Text subclass. This index issue follows bpo-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:

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

    2. 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.

    @terryjreedy terryjreedy added 3.7 (EOL) end of life 3.8 only security fixes labels May 1, 2018
    @terryjreedy terryjreedy self-assigned this May 1, 2018
    @terryjreedy terryjreedy added topic-IDLE type-feature A feature request or enhancement labels May 1, 2018
    @terryjreedy
    Copy link
    Member Author

    Point 1 is bpo-33397.

    @terryjreedy
    Copy link
    Member Author

    1. Use configured colors. bpo-34548 does this for text viewer, so would be automatic if subclass from that.

    2. 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?

    @terryjreedy
    Copy link
    Member Author

    bpo-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.)

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @terryjreedy terryjreedy

    Labels
    3.7 (EOL) end of life 3.8 only security fixes topic-IDLE type-feature A feature request or enhancement
    Projects
    IDLE Issues
    Status: No status
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @terryjreedy