Hi Gina

Nice plugin! A small suggestion: Instead of adding the style definition to design.css, create a file style.css in your plugin’s folder, that also works. And then you can create a .zip archive of the folder for the auto-install with the Plugin Manager by Christopher Smith. (btw: I know, I should update my older plugins on splitbrain which still recommend adding to design.css).

Oh cool, thank you for that tip, I didn’t know that was also possible. Will change that asap :)

Nide idea! How about having shortcuts for the modifier keys? For example, if you wrote <key>C-v</key> it would automatically expand to the equivalent of <key>Ctrl</key> + <key>v</key>.

Interesting suggestion. I’ll have to take a look into how to accomplish that, but I like the idea very much.

Great idea! I have suggestion here. Usually one is writing this as: Press [ctrl]+[alt][del] So my suggestion is, parse such text where [] and + are together, as keys. It would be simpler to write than <key></key> and as well would be perfectly readable in raw dokuwiki.

The problem with this would be that then no single keys would be possible anymore. I don’t think it would be a good idea to convert everything in [] into keys (”see [1]” for example would look weird), so the plugin would have to be limited to key-combinations (like Ctrl+Alt+Del), nothing like “Hit <key>Enter</key>“. I do agree with you though, I’d prefer a better markup than the key tags as well. Any non conflicting, good looking suggestions?

I suggest adding the the follwing CSS:

background-color: white;

since not everybody has a wiki with a white background.

Concerning Pavel Vitis proposal. I think you could add one more (meaning keeping the existing way of using <key> tag) pattern like: \[\w+?\](\s?+\s?\[[\w\d]+?\])+ (not sure if it’s really work as intended ).
Then it will catch [Ctrl]+[1] or [Ctrl] + [Alt] + [Del] but will not catch things like [1] or [Home]. For single keys one will still have to use <key> tag.

You could even limit prefixes to modifier keys only (e.g. not to catch [Abc]+[D]) but IMO it does not worth the efforts.

Cool plugin.

Please replace the function:

    function getAllowedTypes() {
        return array('formatting', 'substitution', 'disabled');
    }

with

    function getAllowedTypes() {
        return array('formatting', 'substition', 'disabled');
    }

Otherwise you get tons of error messages like:

PHP Warning:  in_array() [<a href='function.in-array'>function.in-array</a>]: Wrong datatype for second argument in D:\web\dokuwiki\inc\parser\parser.php on line 159

Thank you, didn’t encounter any problems so far with the former (although I can’t explain this), but changed it anyway, as the plugin-tutorial seems to say the same

Nice plugin. I offer a modified CSS though. I trimmed it down in places but also tried to make it look slicker. You’ll need to download the image from http://www.p-a-b-l-o.com/downloads/dokuwiki/plugin-keyboard/keybg.gif.

kbd {
  font-family: Arial,sans-serif;
  font-weight: bold;
  color: #444;
  text-align: center;
  padding: 1px 4px;
  margin: 0px 2px;
  border-style: solid;
  border-width: 1px;
  border-color: #ccc #666 #666 #ccc;
  background: url(keybg.gif) #fafafa no-repeat;
}

A couple of gotcha for noobs like me. The file links in the Without plugin manager section are older and don’t work (at least for me). The files in the With plugin manager section are current and work just fine.

I tried to install the quick button Extra, and had to modify the html_edit line from ‘<key>’ to ‘<key>’ (and the same with the /key) to get it to display the correct code in the text area.

These problems could be cause by my extreme noobishness.

Other than those 2 items, this plugin look really cool. Thanks!

Anyway to add an option for the “Windows” key?

* Add the following code to inc/html.php, approximately after line 914, in the function html_edit():

formatButton('keyboard.png','<?php echo >$lang['qb_keyb']?>','&lt;key&gt;','&lt;/key&gt;','<?php echo $lang['qb_keyb']?>','k');

Could somebody say exactly where to put this code? Possibly include a snippet of html.php?

P.S. offtopic - you haven’t disabled debugging support - see http://wiki.foosel.net/doku.php?do=check

Thanks for the heads-up concerning the debugging support. Must somehow have not taken a look at my check output for a loooong time ;)

Anyway, the place to add the format button seems not to be the html.php any longer, as the toolbar has been changed to some javascript thingy. ATM I can’t seem to find where to place the code now, but I will try to find out and update the wiki accordingly :)

After updating DokuWiki to `dokuwiki-2006-11-06.tgz’ I always get this error when saving pages with keyboard tags: * Warning: Cannot modify header information - headers already sent by (output started at /wiki/lib/plugins/keyboard/lang/en/lang.php:1) in /wiki/inc/actions.php on line 287 *

It was hard to find (at least for me), but the solution is easy: The language files provided with your .zip or tar.gz archives are in wrong format. These are in UTF-8, but DokuWiki (or some other software underlying) needs it in UTF-8 without a Byte Order Mark (BOM). (I used Notepad++ to convert.)

Best would be to take the content from keyboard#langenlang.php and keyboard#langdelang.php, save it correctly, and upload new archives.

Thanks for the heads-up, I will look into it ASAP. Sorry for the inconvenience.

Should be fixed now (at least it worked on my test installation here). I kinda wonder though how those BOMs slipped in... Anway, thanks for reporting this!

Thanks for the update, but I wonder, why I wrote detailed. You didn’t take the contents from this page. Now we still have the string “german version” in “lang/en/lang.php”.

Ooops... I didn’t see that one. Have corrected that now (but at least it wasn’t a critical bug ;)) and removed the source code from the page – people who want to take a look at it can download the plugin, and I can’t forget to keep it synched with the actual source anymore.

The download still has “german version”.

I’m starting to doubt my sanity... I could swear I fixed it in my local version, saved it, packed the tarball and upped it. But it looks like I didn’t. I think I need a vacation, damn this bloody diploma thesis... sorry again

I just downloaded that thing, unpacked it, and now it IS fixed for sure *cough*

Hi Gina! In the german translation the PageDown and PageUp arguments are switched.

Nice plugin, thanks for your work. One small suggestion though: When Camelcase-links are activated PageUp isn't replaced with the symbol instead the key is displayed with a link to the 'PageUp'-page. Perhaps replace 'PageUp' with 'Pageup'?

I think in the latest version the path to purge cached javascript is :

http://your.domain.com/path/to/dokuwiki/lib/exe/js.php?edit=1&write=1&purge=1

Your plugin works like a charm on my local xampp installation. However, on our intranet with IIS6.0, PHP 4.4.8 it does not. This means, that e.g. Ctrl+Alt+D is translated to Strg-Alt-D but the nice graphics formatting around it is completely missing. What can be the cause?

Hi Gina,

I have the same problem as above: The keys are translated fine from “C-A-del” to “Strg+Alt+Del” but the lines arround are missing.

My DokuWiki is runnning on WindowsXP-SP3/Appache-2.2.10/PHP-5.2.6

Are there any special restrictions on PHP-Installation (don't know what libGD is), I installed PHP without any extensions.

Regards Ralf

I try to delete the IE-Cache (doesn't work) and the page cache with ”?purge=true” (doesn't work). Then I renamed the “conf/local.php” to “conf/local.php.xxx”, reload the page then give him back the renamed original “conf/local.php”. ⇒ Now it works fine!

Thank you very much for help & plugin, Ralf

if you want i give you my svg keybord for integration it was make with inkscape and color can be changing by layer :D

http://pix.toile-libre.org/upload/original/1241988961.png all key was exported in 15 *15 pixel in png or other format :D

had keyboard installed and working. wanted to add apple keys and have had problems since. once i download either manual or via installer. am breaking the site, to nothing visible.

any suggestions?

did a fresh install and tried again and still not working?

hmm.