Extension:FormWizard

From mediawiki.org
MediaWiki extensions manual
FormWizard
Release status: beta
Implementation Parser function , Ajax, API
Description Creating new pages on MediaWiki wikis
Author(s) Egbe Eugene and James Hare
Latest version 0.0.1 (TBA)
MediaWiki 1.29+
Database changes No
License GNU General Public License 2.0 or later
Download
README
Help Help:Extension:FormWizard
Quarterly downloads 3 (Ranked 135th)
Translate the FormWizard extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The FormWizard extension allows anyone to create forms on MediaWiki wikis, used to create new pages. It was first developed as a FormWizard gadget but is now available as a MediaWiki extension.

User guide[edit]

For an end user guide to FormWizard, see Help:Extension:FormWizard .

Installation[edit]

  • Download and move the extracted FormWizard folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/FormWizard
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'FormWizard' );
    
  • Run Composer to install PHP dependencies, by issuing composer update in the extension directory.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Basic setup[edit]

For FormWizard to be able to work properly, you need to configure the parser function on a wiki page like so:

{{#formwizard:action=Start|config=Config.json|mode=subpage|project=TestProject}}

with mode=" ", should generate a button which looks like this:

Start with mode="subpage", should generate a button and a text field like so:

In the parser function definition,

  • action is what should be displayed on the button which will be created
  • config is the name of the JSON configuration page. An example can be found Help:Extension:FormWizard#The Wizard
  • mode is the mode in which the extension in operating and is used to determine if the user will need to provide a subpage name before the making use of the extension.
  • project is the project where the extension is applied (this will be used to define page content in context of the project.