After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 761431 - Document overlay help action name
Document overlay help action name
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
3.19.x
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2016-02-01 21:31 UTC by Phillip Wood
Modified: 2016-02-18 14:15 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Document help overlay action name in GtkApplication (1.38 KB, patch)
2016-02-17 10:15 UTC, Phillip Wood
committed Details | Review

Description Phillip Wood 2016-02-01 21:31:39 UTC
As it's recommended[1] to add an app menu entry for displaying the shortcuts help it would be helpful to document the name (win.show-help-overlay) of the action created by GtkApplication to display the overlay help window. The name is on the wiki but it ought to be in the gtk docs as well

[1] https://wiki.gnome.org/Initiatives/GnomeGoals/ShortcutWindows
Comment 1 Matthias Clasen 2016-02-02 11:36:52 UTC
It is mentioned here:

https://developer.gnome.org/gtk3/unstable/GtkApplicationWindow.html#gtk-application-window-set-help-overlay

Where else would you want to see it ?
Comment 2 Phillip Wood 2016-02-02 13:02:12 UTC
(In reply to Matthias Clasen from comment #1)
> It is mentioned here:
> 
> https://developer.gnome.org/gtk3/unstable/GtkApplicationWindow.html#gtk-
> application-window-set-help-overlay
> 
> Where else would you want to see it ?

In the GtkApplication docs describing gtk/help-overlay.ui and the shortcut keys it sets up to display the help overlay. I should have time to do a patch for this and the menus-common.ui docs next week
Comment 3 Phillip Wood 2016-02-17 10:15:26 UTC
Created attachment 321471 [details] [review]
Document help overlay action name in GtkApplication

This means all the information needed to automatically load a
shortcuts window and create a menu item to show it is in one place.
Comment 4 Matthias Clasen 2016-02-18 03:35:58 UTC
Review of attachment 321471 [details] [review]:

thanks, looks good
Comment 5 Phillip Wood 2016-02-18 14:15:03 UTC
Attachment 321471 [details] pushed as c38c336 - Document help overlay action name in GtkApplication