Writing <Primary>, etc. is the incorrect way of doing things in a user manual or technical documentation because it asks the majority of readers to always make a mental substitution of what <META>, <SUPER> or <PRIMARY> means each time they see such reference.
Introduce the keyboard shortcut concept, then the typographical convention the manual will use, followed by how to enter the keyboard shortcut. Typographical convention suggestion: Ctrl and/or Shift, a space, then the plus sign (+), then a space, then a capitalized key, always in bold. e.g. *Ctrl + C* [ all bolded ] e.g. *Ctrl + F1* [ all bolded ] e.g. *Ctrl + Shift + T* [ all bolded ] When discussing a feature be consistent. such as mention the Lin/Win shortcut first, then the MacOS shortcut. e.g.: "To copy something into the buffer, press *Ctrl + C* (Linux/Windows) or *Cmd + C* (macOS)" Other than a possible reference in passing, there is no need to discuss the keyboardrc file outside of an appendix dedicated to that file But ultimately, S/he who writes the manual dictates what goes in the manual. It is a lot of work and is greatly appreciated. OS shortcut Reference: Windows: https://support.microsoft.com/en-ca/help/12445/windows-keyboard-shortcuts Gnome: https://wiki.gnome.org/Design/OS/KeyboardShortcuts KDE: https://docs.kde.org/trunk5/en/applications/fundamentals/kbd.html MacOS: https://support.apple.com/en-ca/HT201236` Cross Platform documentation example: Adobe: https://helpx.adobe.com/photoshop/using/select-mask.html ___________________________________________________________________________ darktable developer mailing list to unsubscribe send a mail to darktable-dev+unsubscr...@lists.darktable.org
