DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:vkeyboard

VKeyboard Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes

plugin Adds a virtual keyboard support for 89 languages and symbol fonts.

Last updated on
2015-12-21
Provides
Action

Similar to virtualkeyboard

Tagged with keyboard, language

Download and Installation

Download and install the plugin using the Plugin Manager using the URL given above or using the Extension Manager. Refer to Plugins on how to install plugins manually.

Syntax and Usage

Download vkeyboard.tgz and install it in the plugins/vkeyboard directory. The keyboard does not load until activated. You can activate the keyboard in one of two ways.

Query String Method

You can add the following query string to your url when fetching a page from the server:

vkb=<language>

For instance:

http://myserver.com/dokuiwki/doku.php?id=start&vkb=french

Pop-up Method

After the plugin is installed, you will find a new toolbar item, a smaller version of the icon illustrated below. Clicking on the toolbar item opens a pop-up window from which you can select your language and activate the keyboard. There are significant advantages to using the pop-up method over the query string method. First,the language you select is guaranteed always to be an accurate identifier and will always give you the initial language you want. Secondly, the pop-up gives you the option of unloading the keyboard.

The Activation Sequence

After activating the keyboard, you will be able to open the keyboard the next time you being an editing session. That is, after activating, you must close and re-open the editor. At the bottom left corner of the editing window there will be a small keyboard icon:

Click on this icon and the the virtual keyboard will pop up with the language you have selected. If your language isn't accurately detected you can change it from within the virtual keyboard pop-up, as described below. You only have to activate the keyboard once during a browser session. It will set a cookie that will last until you close your browser. The keyboard icon will show up each time you edit a page. You can close the virtual keyboard pop-up and re-open it at your convenience.

This virtual keyboard plugin is based on the Javascript implementation from greywyvern. As of this writing, it accesses 89 keyboard layouts, including symbols and dingbats, and a large selection of world languages. You can change languages by clicking on the language identifier at the top left, or the down arrow next to it. It opens a drop down menu from which you can make your selection:

The buttons at the top of the virtual keyboard have the following functions:

  • Pound sign #: opens a numerical key-pad, useful for non-Roman alphabets
  • The down and up arrows increase and decrease the size of the virtual keyboard pop-up; this includes the font-size used on the keyboard.
  • Clear: deletes all content in the editing window – use at your own risk!
  • X closes the keyboard pop-up. Re-open by clicking on the keyboard icon.

Language Support

You can add support for your language by adding your own language file to vkeyboard/lang/<lang_code>/lang.php. Use vkeyboard/lang/en/lang.php as your model. This will translate both for the toolbar title and for the text and buttons of the pop-up window. Anything not translated defaults to English.

Alternate Version

The above version of the virtual keyboard plugin downloads all 89 keyboard layouts. There is a version which enables the user to select and download only the keyboard layouts needed. This version uses the same toolbar icon as the above version. But here the pop-up allows for the choice of only those languages needed. On activating from the pop-up, you can select more than one language. Only the downloaded languages will show in the keyboard's selection menu. If you need additional languages you go back to the toolbar and select them from the pop-up. The process is not cumulative, i.e. only the most recently selected languages will be downloaded. It saves on average about 60K of download.

Download from: gitHub

Discussion

Firefox

If the editing window has text which extends past its bottom boundary, each time you enter a character from the virtual keyboard, the window jumps back to the top and you have to scroll back down to your text. Probably the best solution, for small runs of text, is to enter your text near the top of the window and then copy and paste it back where you want it. This is not an issue in IE, Chrome, or Safari. It is an error in the way in which Firefox has implemented the keyboard focus method.

Partial Fix

I have added a fix for this problem which is in the last distribution. However, if you come to the bottom of the editing window and the end of the bottom-most line, you must hit the return key to move down to the the next line. The virtual keyboard will not automatically move down and display the hidden line. If you continue typing without first hitting the return key, the characters will actually have been entered into the editing window but they are hidden below the bottom of the editing window until the return key is pressed.

Change Log

plugin/vkeyboard.txt · Last modified: 2017-01-07 22:47 by turnermm