keyboard Plugin

Should work as-is, no longer actively maintained by original author.

Works well with the dw2pdf plugin and the odt plugin.

Use the tag < key > to mark some text as keyboad keys. E.g.:

This displays the keys <key>ALT</key> + <key>H</key>.

This will create the following output:

Alternatively the tag < kbd > can be used in accordance to the HTML element:

This displays the keys <kbd>ALT</kbd> + <kbd>H</kbd>.

The shorter form to write the key combination ALT+H is:

This displays the keys <kbd>ALT+H</kbd>.

Separator signs for the short form can be + or -. In both cases the rendered sign between the keys will be a +. So in general it does not make a difference if + or - is used. But it does make a difference if you want to include a + or - as a key and not as a separator. If you would like to render the key combination ALT++ then you should write:

<kbd>ALT-+</kbd>

If you would like to render the key combination ALT+- then you should write:

<kbd>ALT+-</kbd>

Since release 2018-08-09 it is possible to surround keys with '…'. All keys enclosed in '…' will be displayed as-is without interpreting + or - as separators. Here is an example:

<kbd>'ALT+H'</kbd>

This example would display “ALT+H” as a single key instead of two keys: “ALT” + “H”.

If you like to vary the look with each given key sequence you can also specify a CSS class like this:

<key class="myclass">ALT+H</key>

Some keys like the letter C are short cuts which will be expanded to a translated key name. For example ALT+Ctrl will show the same result as if you entered ALT+Ctrl. If you want to suppress this behaviour then include the letter between two '. E.g. if you really want to show the letter C instead of Ctrl then write ALT+C.

The following configuration options exist:

disable_translation — if this option is activated then all translations and short cuts are deactivated. The given keys will be displayed “as-is”.

css_class — the CSS class to use if no class is given in the syntax tag. There are two built-in classes:

For the standard look enter:

__keyboard

For a look similar to the MediaWiki keypress template enter:

__keyboard_keypress

You can also enter user defined CSS classes which e.g. could be defined in conf/userstyle.css, see customizing_templates.

Some DokuWiki templates like the Bootstrap3 template define an own style for kbd elements. In this case the css_class setting needs to be empty to use the style of the template.