Template:ExtensionInstall/en

<languages/>

• Download and place the file(s) in a directory called ExtensionInstall in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php:

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

•  <translate> Done</translate> – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Template documentation

Usage

Examples

Below a few examples of how to use this template:

Simple

{{ExtensionInstall}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

Name

{{ExtensionInstall|CategoryTree}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>CategoryTree</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

Download link

{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

  require_once "$IP/extensions/MyExtension/MyExtension.php";
  $wgUseAjax = true;
  

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

LocalSettings early

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // this must be included before the extension is loaded
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

  $wgUseAjax = true; // this must be included before the extension is loaded
  require_once "$IP/extensions/MyExtension/MyExtension.php";
  

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

DB Update

{{ExtensionInstall
|db-update=Yes
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

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

• <translate> Run the [[<tvar|update>Special:MyLanguage/Manual:Update.php</>|update script]] which will automatically create the necessary database tables that this extension needs.</translate>
•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

Composer

{{ExtensionInstall
|composer=Yes
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>
• <translate> Only when installing from git run <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

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

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

Custom steps

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

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

• Lorem ipsum dolor sit amet
• Foo bar baz quux sandbox
•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

Support registration

{{ExtensionInstall
|registration=1
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

  wfLoadExtension( 'MyExtension' );
  

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

<translate> To users running MediaWiki <tvar

Set recommended registration MediaWiki version

{{ExtensionInstall
|registration=1
|no-registration-version=1.25
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

  wfLoadExtension( 'MyExtension' );
  

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

<translate> To users running MediaWiki <tvar

Require registration

{{ExtensionInstall
|registration=required
}}

vagrant>Vagrant </>, install with <tvar

• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>MyExtension</> in your <tvar|ext>extensions/</> folder.</translate>composer>Composer</> to install PHP dependencies, by issuing <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

  wfLoadExtension( 'MyExtension' );
  

•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

Everything

{{ExtensionInstall|Example
|download-link=[http://bits.wikimedia.org/example.zip Download]
|vagrant=example
|localsettings=
$wgUseAjax = true;

|db-update=Yes
|composer=Yes
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
|registration=yes
}}

• <translate> If using <tvar
• <translate> 1>download-link</> and place the file(s) in a directory called <tvar|name>Example</> in your <tvar|ext>extensions/</> folder.</translate>
• <translate> Only when installing from git run <tvar
• <translate> Add the following code at the bottom of your <tvar|LocalSettings>LocalSettings.php</>:</translate>

  wfLoadExtension( 'Example' );
  $wgUseAjax = true;
  

• <translate> Run the [[<tvar|update>Special:MyLanguage/Manual:Update.php</>|update script]] which will automatically create the necessary database tables that this extension needs.</translate>
• Lorem ipsum dolor sit amet
• Foo bar baz quux sandbox
•  <translate> Done</translate> – <translate> Navigate to <tvar|special>Special:Version</> on your wiki to verify that the extension is successfully installed.</translate>

<translate> To users running MediaWiki <tvar

Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.

[[Category:Installation guide templates{{#translation:}}]]