alix-tz/escriptorium-documentation

Why does the Ctrl key is displayed as "^Ctrl" ?

Closed this issue · 2 comments

This is a minor issue, but do we know why Mkdocs displays the Ctrl key as ^Ctrl?

See:

image

https://escriptorium.readthedocs.io/en/latest/transcribe/

It's all manually set up in the mkdocs.yml file, under the "key-map" section.

^Ctrl is actually a standard/usual way to note "Control" (I see it's also mentioned on Wikipedia: https://en.wikipedia.org/wiki/Control_key#Notation)

markdown_extensions:
    [...]
    - pymdownx.keys:
        separator: "\uff0b"
        key_map: {
                'alt': '⎇ ALt',
                'left-alt': '⎇ Left ALt',
                'right-alt': '⎇ Right ALt',
                'command': '⌘ Command',
                'left-command': '⌘ Command',
                'right-command': '⌘ Command',
                'control': '⌃Ctrl',
                'left-control': '⌃Ctrl',
                'right-control': '⌃Ctrl',
                'shift': '⇧ Shift',
                'left-shift': '⇧ Left Shift',
                'right-shift': '⇧ Right Shift',
                'windows': '⊞ Win',
                'left-windows': '⊞ Win',
                'right-windows': '⊞ Win',
                'arrow-down': '↓ Down',
                'arrow-left': '← Left',
                'arrow-right': '→ Right',
                'arrow-up': '↑ Up',
                'backspace': '⌫ Backspace',
                'backtab': '⇤ Back Tab',
                'caps-lock': '⇪ Caps Lock',
                'clear': '⌧ Clr',
                'delete': '⌦ Del',
                'end': '⤓ End',
                'escape': '⎋ Esc',
                'home': '⤒ Home',
                'page-down': '⇟ Page Down',
                'page-up': '⇞ Page Up',
                'tab': 'Tab ⇥',
                'enter': 'Enter ⏎',
                'left-button': '→🖰 Left Click',
                'right-button': '🖰← Right Click'
            }

We could remove it, if it is confusing and simply keep "Ctrl".

I didn't know that! Thanks :)

No I think it's okay to keep the "^" as it is a naming convention.

I'm closing this issue!