- Download and place the file(s) in a directory called
ExtensionInstall
in yourextensions/
folder. - Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
- Special:Version on your wiki to verify that the extension is successfully installed. <translate> Done</translate> – Navigate to
This template uses Lua: |
Usage
Examples
Below a few examples of how to use this template:
Simple
{{ExtensionInstall}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
require_once "$IP/extensions/MyExtension/MyExtension.php";- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
Name
{{ExtensionInstall|CategoryTree}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/CategoryTree</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
CategoryTree
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
require_once "$IP/extensions/CategoryTree/CategoryTree.php";- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
Download link
{{ExtensionInstall |download-link=[http://bits.wikimedia.org/example.zip Download] }}
- <translate> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
require_once "$IP/extensions/MyExtension/MyExtension.php";- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
LocalSettings
{{ExtensionInstall |localsettings= $wgUseAjax = true; }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
LocalSettings early
{{ExtensionInstall |localsettingsearly= $wgUseAjax = true; // this must be included before the extension is loaded }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
$wgUseAjax = true; // this must be included before the extension is loaded require_once "$IP/extensions/MyExtension/MyExtension.php";- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
DB Update
{{ExtensionInstall |db-update=Yes }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
require_once "$IP/extensions/MyExtension/MyExtension.php";- <translate> Run the [[<tvar name=update>Special:MyLanguage/Manual:Update.php</tvar>|update script]] which will automatically create the necessary database tables that this extension needs.</translate>
- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
Composer
{{ExtensionInstall |composer=Yes }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Only when installing from Git, run <tvar name=composer>Composer</tvar> to install PHP dependencies, by issuing <tvar name=code>
composer install --no-dev
</tvar> in the extension directory.</translate> <translate> (See <tvar name=phab>T173141</tvar> for potential complications.)</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
require_once "$IP/extensions/MyExtension/MyExtension.php";- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
Custom steps
{{ExtensionInstall |custom-steps= * Lorem ipsum dolor sit amet * Foo bar baz quux [[sandbox]] }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
Support registration
{{ExtensionInstall |registration=1 }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
wfLoadExtension( 'MyExtension' );- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special><translate> To users running MediaWiki <tvar name=1>1.24</tvar> or earlier: </translate>
<translate> The instructions above describe the new way of installing this extension using <tvar name=LoadExtension>
wfLoadExtension()
</tvar>.</translate> <translate> If you need to install this extension on these earlier versions (MediaWiki <tvar name=1>1.24</tvar> and earlier), instead of <tvar name=code>wfLoadExtension( 'MyExtension' );
</tvar>, you need to use:</translate>require_once "$IP/extensions/MyExtension/MyExtension.php";
Set recommended registration MediaWiki version
{{ExtensionInstall |registration=1 |no-registration-version=1.25 }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
wfLoadExtension( 'MyExtension' );- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special><translate> To users running MediaWiki <tvar name=1>1.25</tvar> or earlier: </translate>
<translate> The instructions above describe the new way of installing this extension using <tvar name=LoadExtension>
wfLoadExtension()
</tvar>.</translate> <translate> If you need to install this extension on these earlier versions (MediaWiki <tvar name=1>1.25</tvar> and earlier), instead of <tvar name=code>wfLoadExtension( 'MyExtension' );
</tvar>, you need to use:</translate>require_once "$IP/extensions/MyExtension/MyExtension.php";
Require registration
{{ExtensionInstall |registration=required }}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>
MyExtension
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
wfLoadExtension( 'MyExtension' );- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special>
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> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>
Example
</tvar> in your <tvar name=ext>extensions/
</tvar> folder.</translate>- <translate> Only when installing from Git, run <tvar name=composer>Composer</tvar> to install PHP dependencies, by issuing <tvar name=code>
composer install --no-dev
</tvar> in the extension directory.</translate> <translate> (See <tvar name=phab>T173141</tvar> for potential complications.)</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
wfLoadExtension( 'Example' ); $wgUseAjax = true;- <translate> Run the [[<tvar name=update>Special:MyLanguage/Manual:Update.php</tvar>|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
- Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate> Done</translate> – <translate> Navigate to <tvar name=special><translate> To users running MediaWiki <tvar name=1>1.24</tvar> or earlier: </translate>
<translate> The instructions above describe the new way of installing this extension using <tvar name=LoadExtension>
wfLoadExtension()
</tvar>.</translate> <translate> If you need to install this extension on these earlier versions (MediaWiki <tvar name=1>1.24</tvar> and earlier), instead of <tvar name=code>wfLoadExtension( 'Example' );
</tvar>, you need to use:</translate>require_once "$IP/extensions/Example/Example.php";
<translate> Vagrant installation:</translate>
- <translate> If using <tvar name=vagrant>Vagrant </tvar>, install with <tvar name=code>
vagrant roles enable example --provision
</tvar></translate>