Differences

This shows you the differences between two versions of the page.

--- plugin:keyboard [2017-06-02 19:35] – New release LarsDW223
+++ plugin:keyboard [2023-12-08 10:11] (current) – + Jack Jackrum 148.64.24.63
@@ Line 6: / Line 6: @@
 email      : freaks@dokuwiki.org
 type       : syntax
-lastupdate : 2017-06-02
+lastupdate : 2023-02-23
-compatible : 2006-03-09, 2006-11-06, 2009-12-25 "Lemming", 2010-11-07 "Anteater", 2011-05-25 "Rincewind", "Angua", 2014-09-29 "Hrun", "Detritus", 2017-02-19a "Frusterick Manners"
+compatible : Detritus, Elenor Of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum
 depends    :
 conflicts  :
@@ Line 54: / Line 54: @@
 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: <code><kbd>ALT-+</kbd></code>
 If you would like to render the key combination ''ALT+-'' then you should write: <code><kbd>ALT+-</kbd></code>
+==== Escape mechanism ====
+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:
+<code>
+<kbd>'ALT+H'</kbd>
+</code>
+This example would display "ALT+H" as a single key instead of two keys: "ALT" + "H".
+==== Specify CSS class ====
+If you like to vary the look with each given key sequence you can also specify a CSS class like this:
+<code><key class="myclass">ALT+H</key></code>
 ==== Short cuts ====
 Some keys like the letter **C** are short cuts which will be expanded to a translated key name. For example **<key>ALT+C</key>** will show the same result as if you entered **<key>ALT+Ctrl</key>**. 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 **<key>ALT+'C'</key>**.
+===== Configuration =====
+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:
+<code>__keyboard</code>
+For a look similar to the MediaWiki keypress template enter:
+<code>__keyboard_keypress</code>
+You can also enter user defined CSS classes which e.g. could be defined in **conf/userstyle.css**, see [[tips: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.
 ===== Development =====
 Changes:
-{{rss>https://github.com/dokufreaks/plugin-keyboard/commits/master.atom}}
+{{rss>https://github.com/dokufreaks/plugin-keyboard/commits/master.atom date}}
 ===== Add LaTeX support ====
@@ Line 140: / Line 171: @@
 ===== Translations =====
-The plugin is available in the languages german, english, french, korean and chinese.
+The plugin is available in the languages German, English, French, Korean and Chinese.
 ===== Issues/Requests =====