#17178 closed enhancement (fixed)
Add missing help buttons
Reported by: | simon04 | Owned by: | simon04 |
---|---|---|---|
Priority: | normal | Milestone: | 19.01 |
Component: | Core | Version: | |
Keywords: | help | Cc: | Don-vip, Klumbumbus, stoecker |
Description (last modified by )
Inspired by #15051, I found quite a few dialogs lacking an appropriate help button.
I checked a few dialogs in LibreOffice and GIMP; all of them seem to uniformly contain a Help button. This concept could be applied to JOSM as well: all non-trivial dialogs could get a Help button (e.g., using org.openstreetmap.josm.gui.ExtendedDialog#configureContextsensitiveHelp
).
Attachments (0)
Change History (13)
comment:1 by , 5 years ago
Description: | modified (diff) |
---|
comment:2 by , 5 years ago
comment:6 by , 5 years ago
Cc: | added |
---|
The context-sensitive help is a bit awkward in use for dialogs. For instance:
- In the "View" menu, I can hover "Advanced info" and press
[F1]
. The corresponding help page opens. - In the "Advanced info" dialog, no help button is present, and pressing
[F1]
does not open the help page.
The first behaviour originates from setHelpId(ht("/Action/InfoAboutElements"))
in org.openstreetmap.josm.actions.InfoAction
. The second behaviour is due to configureContextsensitiveHelp("/Action/InfoAboutElements")
missing in org.openstreetmap.josm.gui.dialogs.InspectPrimitiveDialog
I find 1. super awkward as I've never seen this in any application (but not distracting); how many users are aware of this? However, 2. is what I would consider the standard user expectation concerning help in applications. Thus, we should org.openstreetmap.josm.gui.ExtendedDialog#configureContextsensitiveHelp
where missing. How can we avoid the duplication of help topics for 1. and 2. (e.g., r14658 addressed a discrepancy of help topics between UploadDialog
and UploadAction
)?
comment:7 by , 5 years ago
comment:12 by , 5 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
Skipped:
- PurgeAction (how to add help to ConditionalOptionPaneUtil)
- HistoryInfoAction.HistoryObjectIDDialog (no adequate help topic)
In 14655/josm: