Skip to content

Define in style guide how to present complex key sequences

Issue Description

In gitlab!162478, @phillipwells noted something I've wondered about for a while with the https://gitlab.com/gitlab-org/editor-extensions/gitlab.vim/ project: how do we represent complex key commands that are run sequentially?

His question:

It raises another question, though: do we have guidance for writing out complex commands like these? Emacs has a whole bunch of C-x C-y type commands too. Here's how they do it: https://www.gnu.org/software/emacs/refcards/pdf/refcard.pdf

For example, Neovim has a single command (Omni completion) that is Control+x followed by Control+o.

Questions to resolve

In https://docs.gitlab.com/ee/development/documentation/styleguide/#keyboard-commands, consider some updates:

  • Spell out the full name of keys (Control) or abbreviate (Ctrl)?
  • Specify spaces / no spaces between key 1, the plus sign, and key 2?
  • How to refer to sequences? , then ? Follow the Emacs approach?

https://docs.gitlab.com/ee/user/shortcuts.html and https://docs.gitlab.com/ee/editor_extensions/neovim/ will likely need updates depending on findings.

Related issues