Skip to content
mediawiki extension to include Visual Editor in Forms created by PageForm extension
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
includes
modules
LICENSE.md
README.md
composer.json
extension.json

README.md

VEForPageForm

VE for page for is a mediawiki extension to integrate VisualEditor into PageForm forms

Installation

See documentation of Page Forms and Visual Editor to install them, with Parsoid.

For PageForms, it requires an altered version available here : https://github.com/Wikifab/PageForms We plan to integrate all of this in the original PageForms extension, but this is not done yet.

Extract an put VEForPageForm in the 'extensions' directory.

Include it in LocalSettings.php :

 wfLoadExtension( 'VisualEditor' );

It has be tested on mediawiki 1.28 (and VisualEditor REL1_28)

Configuration

To proper work, you need to load PageForm and VisualEditor extensions in your Localsetting.php. And you need to define your connection with parsoid. See VisualEditor documentation for more details. but you may not want VisualEditor to be activated on usual edit pages. To do so you can configure it in Localsettings.php following this example :

 wfLoadExtension( 'PageForms' );
 wfLoadExtension( 'VisualEditor' );
 wfLoadExtension( 'VEForPageForm' );
 
 // Disable VE by default for everybody
 $wgDefaultUserOptions['visualeditor-enable'] = 0;
 
 // Don't allow users to enable it
 $wgHiddenPrefs[] = 'visualeditor-enable';
 
 $wgVirtualRestConfig['modules']['parsoid'] = array(
 		// URL to the Parsoid instance
 		// Use port 8142 if you use the Debian package
 		'url' => 'http://localhost:8000',
 		// Parsoid "domain" (optional)
 		'domain' => 'localtest.me',
 );

To enable VE on a PageForm field, you need to add the class 'form-textarea' on the texteara input, in your page form template

for instance : {{{field|Description|input type=textarea|class=form-textarea}}}

Credits

This extension was written by Pierre Boutet.

You can’t perform that action at this time.