Opened 22 months ago

Closed 21 months ago

Last modified 3 months ago

#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 simon04)

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 Changed 22 months ago by simon04

Description: modified (diff)

comment:2 Changed 22 months ago by simon04

In 14655/josm:

see #17178 - Search presets: add help buttons, add button icons

comment:3 Changed 22 months ago by simon04

In 14656/josm:

see #17178 - Search notes: add help button

comment:4 Changed 22 months ago by simon04

In 14657/josm:

see #17178 - Save session: add help button

comment:5 Changed 22 months ago by simon04

In 14658/josm:

see #17178 - Upload selection: fix help topic, make help button visible

comment:6 Changed 22 months ago by simon04

Cc: Don-vip Kulumbus stoecker added

The context-sensitive help is a bit awkward in use for dialogs. For instance:

  1. In the "View" menu, I can hover "Advanced info" and press [F1]. The corresponding help page opens.
  2. 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 Changed 21 months ago by naoliv

Cc: Klumbumbus added; Kulumbus removed

comment:8 Changed 21 months ago by simon04

In 14742/josm:

see #17178 - Jump to position: add help button

comment:9 Changed 21 months ago by simon04

In 14743/josm:

see #17178 - Rectified Image: add help button

comment:10 Changed 21 months ago by simon04

In 14744/josm:

see #17178 - Search menu items: add help button

comment:11 Changed 21 months ago by simon04

In 14745/josm:

see #17178 - About: add help button

comment:12 Changed 21 months ago by simon04

Resolution: fixed
Status: assignedclosed


  • PurgeAction (how to add help to ConditionalOptionPaneUtil)
  • HistoryInfoAction.HistoryObjectIDDialog (no adequate help topic)

comment:13 Changed 3 months ago by Klumbumbus

(follow up in #19669)

Modify Ticket

Change Properties
Set your email in Preferences
as closed The owner will remain simon04.
as The resolution will be set.
The resolution will be deleted.

Add Comment

E-mail address and name can be saved in the Preferences.

Note: See TracTickets for help on using tickets.