GNOME Bugzilla – Bug 761431
Document overlay help action name
Last modified: 2016-02-18 14:15:08 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
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 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
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.
Review of attachment 321471 [details] [review]: thanks, looks good
Attachment 321471 [details] pushed as c38c336 - Document help overlay action name in GtkApplication