This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

Keyboard Shortcut Descriptor

Keyboard Shortcut Descriptors are used by the KeyboardWidget and within Tiddlers tagged to link actions with a keyboard combination

A Keyboard Shortcut Descriptor has the following format:

	ctrl+enter
	ctrl+shift+alt+A
	alt-shift-T
	alt-Space

It can have multiple Key combinations:

ctrl+enter alt+shift+A ctrl+alt+9 alt-Space ctrl-Backspace

There are two ways Keyboard Shortcut Descriptors can be used:

  • directly
    • passing the attribute key="ctrl-enter" to the KeyboardWidget
    • setting ctrl-enter as the value of the key field in a Tiddler tagged
  • with a reference to a configuration Tiddler
    • A configuration Tiddler for Keyboard Shortcuts follows some naming rules:
      • The title starts with $:/config/
      • Followed by either the string shortcuts or one of the following platform descriptors:
        • shortcuts-linux
        • shortcuts-not-linux
        • shortcuts-mac
        • shortcuts-not-mac
        • shortcuts-windows
        • shortcuts-not-windows
      • The title ends with another / followed by a suffix that can be chosen freely
        • This suffix is the identifier for the Keyboard Shortcut Descriptor (A)
    • The reference to the configuration Tiddler is made of (( + the identifier (A) + ))
      • Example: ((my-shortcut)) is the reference to these configuration Tiddlers:
    • Finally, the referenced configuration Tiddler stores the Keyboard Shortcut Descriptor in its text field