Open main menu

Extension:VEForAll


MediaWiki extensions manual
OOjs UI icon advanced.svg
VEForAll
Release status: beta
Description Defines JavaScript functionality to allow other extensions to incorporate VisualEditor into their form textareas
Author(s) Pierre Boutet, Clément Flipo, Ike Hecht, Yaron Koren and Cindy Cicalese
Latest version 0.1
MediaWiki 1.25+
Database changes No
License GNU General Public License 2.0 or later
Download
Translate the VEForAll extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The VEForAll ("VisualEditor For All") extension allows other extensions to incorporate the VisualEditor interface into textareas for user editing.

This extension does not directly impact the user interface; rather, it defines a JavaScript function (called "applyVisualEditor()") that can be called by other extensions on their textareas. At the moment, two extensions - CommentStreams and Page Forms - can make use of VEForAll.

As might be expected, the VisualEditor extension must be installed for this extension to work.

Authors and creditsEdit

VEForAll is heavily based on the (now-obsolete) VEForPageForm extension by Pierre Boutet and Clément Flipo. Some work to make the code more generic was done by Ike Hecht, Yaron Koren and Cindy Cicalese. VEForAll also includes code from the StructuredDiscussions extension.

InstallationEdit

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

Using VEForAll with other extensionsEdit

VEForAll can currently be used with the CommentStreams and Page Forms extensions:

  • For CommentStreams, you must use version 4.5 of the extension or higher. You simply need to have VEForAll (and VisualEditor) installed, and then textareas for entering comments will automatically get the VisualEditor interface.
  • For Page Forms, you must use version 4.4 of the extension or higher. Then, in the form definition, add |editor=visualeditor to the tag for any textarea input (including the "free text" input), and the VisualEditor interface should show up when viewing that form.

ConfigurationEdit

By default, the toolbar is display at the bottom of the textarea. To move to the top, add the |class=toolbarOnTop on your textarea.