Extension:VirtualKeyboard

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
VirtualKeyboard
Release status: beta
Implementation User interface
Description A multi-lingual virtual keyboard to input text with a pointing device
Author(s) Ike Hecht (Tosfostalk)
Latest version 0.2.0 (April 2015)
MediaWiki 1.24+, probably earlier versions too
PHP 5.3
Database changes No
License GNU General Public License 2.0 or later
Download
$wgVirtualKeyboardMode, $wgVirtualKeyboardSkin
Translate the VirtualKeyboard extension if it is available at translatewiki.net
Check usage and version matrix.

The VirtualKeyboard extension adds a multi-lingual virtual keyboard to MediaWiki, allowing users to input text with a pointing device in many different languages. It utilizes VirtualKeyboard by Ilya Lebedev.

Installation[edit]

  • Download and place the file(s) in a directory called VirtualKeyboard in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/VirtualKeyboard/VirtualKeyboard.php";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

$wgVirtualKeyboardMode
Which mode the Virtual Keyboard should use. Possible values: VirtualKeyboard::POPUP (default), VirtualKeyboard::EASY, VirtualKeyboard::IFRAME.
$wgVirtualKeyboardSkin
Possible values: 'air_large', 'air_mid', 'air_small', 'flat_gray' (default), 'goldie', 'small', 'soberTouch', 'textual', 'winxp', or set to null for "no skin".

Usage[edit]

Usage depends on which mode is chosen in LocalSettings.php:

POPUP (default)
Click "Toggle virtual keyboard" in the toolbar. That will pop-up a new window with a keyboard. Click the toggle again to hide the keyboard.
IFRAME
Click "Toggle virtual keyboard" in the toolbar. A keyboard will display at the bottom of the page's content area. Click the toggle again to hide the keyboard.
EASY
A small keyboard icon will display next to each input field when it receives focus. Click this icon to see the keyboard. Click the icon again to hide the keyboard.

Known issues[edit]

  • Incompatible with VisualEditor if mode is set to VirtualKeyboard::EASY.
  • Some modes may be incompatible with some MediaWiki skins or in some browsers.

See also[edit]