Extension:Page Forms/Download and installation

From MediaWiki.org
Jump to: navigation, search
Language:Project:Language policy English  • français
Page Forms - navigation (viewTemplate:Page Forms navigation)
Basics Main pageExtension:Page Forms (talk) · Download and installationExtension:Page Forms/Download and installation · Quick start guideExtension:Page Forms/Quick start guide · HostingExtension:Page Forms/Hosting · Special pagesExtension:Page Forms/Special pages
Using Page Forms PF and templatesExtension:Page Forms/Page Forms and templates · Defining formsExtension:Page Forms/Defining forms   (Input typesExtension:Page Forms/Input types) · The "⧼formedit⧽" tabExtension:Page Forms/The "edit with form" tab · Linking to formsExtension:Page Forms/Linking to forms · Creating query formsExtension:Page Forms/Creating query forms
Resources for help Common problemsExtension:Page Forms/Common problems · Known bugs and planned featuresExtension:Page Forms/Known bugs and planned features · Getting supportExtension:Page Forms/Getting support · Developers' documentationExtension:Page Forms/Developers' documentation · TestingExtension:Page Forms/Testing
About Page Forms Authors and creditsExtension:Page Forms/Authors and credits · Version historyExtension:Page Forms/Version history · Sites that use Page FormsExtension:Page Forms/Sites that use Page Forms · Related extensionsExtension:Page Forms/Related extensions

Download[edit]

You can download the Page Forms code, in .zip format, here.

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

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

To view the code online, including version history for each file, go here.

Not recommended[edit]

There are some additional ways to download Page Forms, which are not recommended:

  • Page Forms can be downloaded via the MediaWiki Extension Distributor, which lets you download any extension for any version of MediaWiki. This not recommended because the code being downloaded represents a random snapshot in time, that could contain bugs that were fixed later - or, if the "development/trunk" version is used, it could conversely contain code that is too new, and hasn't been fully tested yet.
  • Page Forms is available via some Linux distributions, like Debian. These should probably not be used, since their version of the software tends to be significantly out of date.

Installation[edit]

  • Note: For versions 1.26 and lower of MediaWiki, it is highly recommended to use the 2nd option, of calling "require_once", rather than calling wfLoadExtension().


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

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'PageForms' );, you need to use:

require_once "$IP/extensions/PageForms/PageForms.php";

Composer[edit]

Page Forms can also be downloaded and installed using Composer. However, this is not a well-supported feature at the moment.

To install with Composer, add the following to your composer.local.json file:

{
  "require": {
    "mediawiki/page-forms": "^4.1.2"
  }
}

More information about the package can be found on Packagist: https://packagist.org/packages/mediawiki/page-forms