Template:ExtensionInstall: Difference between revisions
From J-Fusion Wiki
Jump to navigationJump to search
use syntaxhighlight with copy button |
m 1 revision imported |
||
(No difference)
| |||
Latest revision as of 20:50, 4 January 2026
<languages/>
- <translate> [[<tvar name=2>Special:ExtensionDistributor/ExtensionInstall</tvar>|Download]] and move the extracted <tvar name=name>
ExtensionInstall</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
File:Test Template Info-Icon - Version (2).svg Template documentation
| File:Lua-Logo.svg | This template uses Lua: |
<translate>
Usage
</translate>
<translate>
Examples
Below a few examples of how to use this template:
Simple
</translate>
{{ExtensionInstall}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/MyExtension/MyExtension.php";
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
Name
</translate>
{{ExtensionInstall|CategoryTree}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/CategoryTree</tvar>|Download]] and move the extracted <tvar name=name>
CategoryTree</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/CategoryTree/CategoryTree.php";
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
Download link
</translate>
{{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> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/MyExtension/MyExtension.php";
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
LocalSettings
{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true; </syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
<tvar name=1>LocalSettings</tvar> early
</translate>
{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // <translate nowrap><!--T:35--> This must be included before the extension is loaded</translate>
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
$wgUseAjax = true; // <translate nowrap> This must be included before the extension is loaded</translate> require_once "$IP/extensions/MyExtension/MyExtension.php";
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
DB Update
</translate>
{{ExtensionInstall
|db-update=Yes
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/MyExtension/MyExtension.php";
</syntaxhighlight>
- <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>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
Composer
</translate>
{{ExtensionInstall
|composer=Yes
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <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>Template:Task</tvar> for potential complications.)</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/MyExtension/MyExtension.php";
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
Custom steps
</translate>
{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
require_once "$IP/extensions/MyExtension/MyExtension.php";
</syntaxhighlight>
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
Support registration
</translate>
{{ExtensionInstall
|registration=1
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
wfLoadExtension( 'MyExtension' );
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
Expression error: Unrecognized punctuation character "[".
<translate>
Support registration with minimum version
</translate>
{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
wfLoadExtension( 'MyExtension' );
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
Expression error: Unrecognized punctuation character "[".
<translate> This only works if the version specified is <tvar name="1">Expression error: Unrecognized punctuation character "[".</tvar> or later, otherwise the template assumes nobody cares about ancient versions and falls back to [[<tvar name=2>#Require registration</tvar>|#Require registration]].
Require registration
</translate>
{{ExtensionInstall
|registration=required
}}
- <translate> [[<tvar name=2>Special:ExtensionDistributor/MyExtension</tvar>|Download]] and move the extracted <tvar name=name>
MyExtension</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
<translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate><syntaxhighlight lang="bash" copy="1">cd extensions/git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension</syntaxhighlight>
- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
wfLoadExtension( 'MyExtension' );
</syntaxhighlight>
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
<translate>
Everything
</translate>
{{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>Template:Task</tvar> for potential complications.)</translate>- <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar> file:</translate> <syntaxhighlight lang="php" copy="1">
wfLoadExtension( 'Example' ); $wgUseAjax = true; </syntaxhighlight>
- <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
- check <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
Expression error: Unrecognized punctuation character "[".
<translate> Vagrant installation:</translate>
- <translate> If using <tvar name=vagrant>Vagrant</tvar>, install with <tvar name=code>
vagrant roles enable example --provision</tvar></translate>
[[Category:Installation guide templates{{#translation:}}]]
.svg){kind=link}
