This is to document all the standard ways I'm documenting things on this page. Figure this is a combination of HTML coding reference and style guide.
- In my style sheet, I set up a style called
keyboardkey. A key would look like this:
And look like this:
- "UNIX" is always all upper case
- "Linux" is treated as a proper name. It is never "GNU Linux," "GNU/Linux," or other such nonsense, unless speaking to a specific distribution that goes by that name.
- The UNIX-derived Apple desktop/laptop operating system is "MacOS," as of this writing. It was formally known as "OS X."
- All dates and times will be presented spelled out ("March 30, 2021"), or in ISO 8601" format ("2021-03-30").
Representation of Keyboard Keys
||Keyboard Key Label
||FN, fn or Fn
|Cord used on laptops where one key may represent multiple functions. Distinct from “classic” function keys at top of the keyboard (F1, etc.).
||F1, F2, etc.
|Classic function keys (“Press F1 for help”, etc.)
||Escape or Esc
||Control or Ctrl
||Command or ⌘
||Option or ⌥
|On Macs–may be used as Alt.
|Does not exist on contemporary hardware
Notes for Representation of Keyboard Keys
Note: These conventions were started on December 26, 2020. Pages or sections created prior to this may not be consistent with such formatting and styles.
- A cord is hitting two or more keys at the same time. For instance, to get a capital "a," you would hit Shift and a at the same time.
- “Keyboard Key Label” may be in a variety of case permutations, and should be regarded as case insensitive (i.e. “Ctrl” may be Ctrl, ctrl, or CTRL).
- “Text Only Convention” would be for a flat ASCII renditoin of the document.
- Cords using a modifier, such as control or shift, and an alphabet key would designated with the convention for the key, a dash, and the lower case letter. Hitting Control and A would be listed as
C-a , C-
a or C-a.
- “Meta” does not exist on contemporary hardware, but is used in some documentation (particularly EMACS). It is represented different ways.
- It might be a cord with Alt.
- More commonly, it is achieved by hitting and releasing Escape, then the other key (not a cord).
- If the command involves other modifiers, Escape is hit nad released, then the rest of the sequence (
M-C-a would be hitting and releasing Escape, then a cord with Control and A).
- Other keys, such as Home or End, will be listed as they usually appear
- Two-word keys, such as Page Up, will be spelled out.
- Arrows will either use a symbol, such as ↑, or spelled out, Up Arrow
- In general, a style for KeyboardKeys is used to designate keys. However, the
code style may be used if this is printed in such a fashion that a style is not available.
Return to Reference Index
Created by I. Charles Barilleaux
Last Update: 2021-03-30