Extension:VEForAll/de-formal

This page is a translated version of the page Extension:VEForAll and the translation is 7% complete.
Languages:
MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
VEForAll
Release status: stable
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.4.1 (November 2022)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.32+
Database changes No
Composer mediawiki/v-e-for-all
License GNU General Public License 2.0 or later
Download
Quarterly downloads 8 (Ranked 160th)
Translate the VEForAll extension if it is available at translatewiki.net
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, CommentStreams , Page Forms and FlexForm can make use of VEForAll.

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

You can download the VEForAll code, in .zip format, here.

You can also download the code directly via Git from the MediaWiki source code repository. From a command line, you can call the following:

git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/VEForAll

You can also view the code online here.

Installation

To install this extension, create a 'VEForAll' directory (either by extracting a compressed file or downloading via Git), and place this directory within the main MediaWiki 'extensions' directory. Then, in the file 'LocalSettings.php', add the following line:

wfLoadExtension( 'VEForAll' );

Using VEForAll with other extensions

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

  • For CommentStreams (version 4.5 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 (version 4.7 or higher), 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.
  • For FlexForm, use editor="ve" when defining a textarea. E.g. <_input type="textarea" editor="ve"></_input>. You can have as many VE editors on a page as needed and you can even add a menu/button to the VE Editor that will open another VE Editor.

Configuration

By default, the toolbar is display at the bottom of the textarea. In Page Forms, you can instead display it at the top by adding |class=toolbarOnTop to the textarea's tag in the form definition.

You can use the "VEForAllToolbarConfigNormal" and "VEForAllToolbarConfigWide" hooks to customize the display of the VisualEditor toolbar. One or the other hook is called, depending on whether "toolbarOnTop" is set: "Normal" is called if it is not set, and "Wide" if it is.

For example, to add buttons for "Insert > Math formula", "Insert > Images and media", and "Cite" in the normal (toolbar on the bottom) case, add the following to LocalSettings.php, below the inclusion of VEForAll:

$wgHooks['VEForAllToolbarConfigNormal'][] = function( &$defaultConfigNormal ) {
        $defaultConfigNormal[4]['include'][] = 'math';
        $defaultConfigNormal[4]['include'][] = 'media';
        $defaultConfigNormal[] = [ 'name' => 'reference' ];
};


Known issues

In some skins, the dropdowns may look rather compressed. You can apply a small CSS tweak to fix this:

table.multipleTemplateInstanceTable {  	border-collapse: inherit; }

Authors and credits

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. Others who contributed to the code include Anysite and Mark Hershberger. VEForAll also includes code from the StructuredDiscussions extension.

Version history

  • 0.1 - - Initial version
  • 0.2 - - Made toolbar configurable; removed dependency on the Math extension; fixed submitting values for "focused" textareas; set VE direction (RTL/LTR) correctly; added "veForAll.targetCreated" hook; many other fixes
  • 0.3 - - Improved support for MW 1.35+; removed support for MW < 1.29; added handling for Page Forms "max height" parameter; added escaping of pipes in table wikitext within Page Forms template fields; bug fixes
  • 0.4 - - Improved support for MW 1.34+; removed support for MW < 1.32; fixes for pipe escaping
  • 0.4.1 - - Fixed support for MW 1.39+; other fixes