Opened 8 years ago
Last modified 6 years ago
#3143 new enhancement
Scroll to description in the help tab in module forms
Reported by: | wenzeslaus | Owned by: | |
---|---|---|---|
Priority: | normal | Milestone: | 7.6.2 |
Component: | wxGUI | Version: | svn-trunk |
Keywords: | wxPython, HTML, forms, help, manual | Cc: | |
CPU: | Unspecified | Platform: | Linux |
Description
When you start a module dialog/form, e.g. r.slope.aspect
, and switch to Manual tab (or press Help button) you end up at the beginning of the module manual page (same as if you do it online or through g.manual
). However, it seems more fitting for the GUI, that you go directly to the description because you already know the name, short description and perhaps even the keywords of the module. You don't need to know the synopsis/syntax and your are likely not interested in reading through all the parameters (option and flags) because you have them in the GUI.
I suggest to add '#description' to the URL, so that first thing user sees is the heading DESCRIPTION.
I'm attaching a patch (against trunk, r69358) but I'm not applidng it because this change would expose a confusing bug - when the window is resized (a likely event after switching to the manual) the scroll changes to the start of the page (thus loosing the focus on description section). The commit r69358 fixes case of loosing scrolling position when switching back and forth between Manual tab and other tabs. However, this resize-related bug seems to be coming from wxPython/wxWidgets because this happens in the wxPython demo as well. Once the wxPython part is solved, this enhancement can be implemented.
Attachments (2)
Change History (8)
by , 8 years ago
Attachment: | manual_scrolled_to_description.png added |
---|
by , 8 years ago
Attachment: | ghelp_scroll_to_description.diff added |
---|
Patch to scroll to description heading with some general code to support this
comment:3 by , 6 years ago
Milestone: | 7.4.1 → 7.4.2 |
---|
comment:4 by , 6 years ago
Milestone: | 7.4.2 → 7.6.0 |
---|
All enhancement tickets should be assigned to 7.6 milestone.
State of the GUI after switching to Manual tab (now and with the patch)