Plopilpy: 1 revision imported

2026-01-04T20:50:25Z

1 revision imported

← Older revision		Revision as of 20:50, 4 January 2026
(No difference)

mw>Nemoralis: use syntaxhighlight with copy button

2025-06-20T16:09:48Z

use syntaxhighlight with copy button

New page

<noinclude>
<languages/>
</noinclude>{{trim| {{{custom-steps0|}}} }}
* {{#if:{{{download-link|}}}
|<translate> <tvar name=1>{{{download-link|}}}</tvar> and place the file(s) in a directory called <tvar name=name><code>{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}</code></tvar> in your <tvar name=ext><code>extensions/</code></tvar> folder.</translate>
|{{#if:{{{1|}}}{{#invoke:Extension|isOnGerrit}}
|<translate> [[<tvar name=2>Special:ExtensionDistributor/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}</tvar>|Download]] and move the extracted <tvar name=name><code>{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}</code></tvar> folder to your <tvar name=ext><code>extensions/</code></tvar> directory.</translate><br/><translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>{{#tag:syntaxhighlight|cd extensions/
git clone{{#if:{{{git-submodule|}}}|<nowiki/> --recurse-submodules}} https:<nowiki/>//gerrit.wikimedia.org/r/mediawiki/extensions/{{urlencode:{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}}}|lang=bash|copy=1}}
|<translate> Download and place the file(s) in a directory called <tvar name=name><code>{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}</code></tvar> in your <tvar name=ext><code>extensions/</code></tvar> folder.</translate>
}}
}}{{#if: {{{composer|}}} |
* <translate> Only when installing from Git, run <tvar name=composer>[[Special:MyLanguage/Composer|Composer]]</tvar> to install PHP dependencies, by issuing <tvar name=code><code>composer install --no-dev</code></tvar> in the extension directory.</translate> <small><translate> (See <tvar name=phab>{{task|T173141}}</tvar> for potential complications.)</translate></small>{{#ifeq: {{NAMESPACENUMBER}} |102 |{{#ifeq: {{SUBPAGENAME}} |en | |[[Category:Extensions requiring Composer with git{{#translation:}}]] }} }}
}}
* <translate> Add the following code at the bottom of your <tvar name=1>{{ll|Manual:LocalSettings.php|LocalSettings.php}}</tvar> file:</translate> {{#tag:syntaxhighlight|
{{{localsettingsearly|}}}
{{#if: {{{source|}}} | {{{source|}}} | {{#if: {{{registration|}}} | {{#if: {{{customizereg|}}} | {{{customizereg|}}} |wfLoadExtension( '{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}' );}} | {{#if: {{{oldreg|}}} | {{{oldreg|}}} | require_once "$IP/{{{basedir|extensions}}}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}.php";}}}} }}
{{{localsettings|}}}
|lang="php"
|copy=1
}}{{#if: {{{db-update|}}} |
* <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>}} {{trim| {{{custom-steps|}}} }}
* {{Done|uselang={{pagelang}}}} – <translate> Navigate to <tvar name=special>[[Special:Version]]</tvar> on your wiki to verify that the extension is successfully installed.</translate>{{#if: {{{registration|}}}|{{#ifeq:{{{registration|}}}|required||<nowiki/>
{{#ifexpr:{{{no-registration-version|1.24}}}<({{MW legacy lts branch number}}-0.04)||
{{#ifeq:{{NAMESPACE}}|Extension|[[Category:Extensions still supporting pre-registration versions]]}}
<translate>

To users running MediaWiki <tvar name=1>{{{no-registration-version|1.24}}}</tvar> or earlier:
</translate>

<translate> The instructions above describe the new way of installing this extension using <tvar name=LoadExtension><code>wfLoadExtension()</code></tvar>.</translate>
<translate> If you need to install this extension on these earlier versions (MediaWiki <tvar name=1>{{{no-registration-version|1.24}}}</tvar> and earlier), instead of <tvar name=code>{{#tag:syntaxhighlight|wfLoadExtension( '{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}' );|lang=php|inline=true}}</tvar>, you need to use:</translate>

{{#tag:syntaxhighlight|
require_once "$IP/{{{basedir|extensions}}}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}/{{trim| {{#if:{{{1|}}}|{{{1}}}|{{ROOTPAGENAME}}}} }}.php";
|lang="php"
}}}}}}}}{{#if: {{{vagrant|}}} |<nowiki/>

'''<translate> Vagrant installation:</translate>'''
* <translate> If using <tvar name=vagrant>{{ll|MediaWiki-Vagrant|Vagrant}}</tvar>, install with <tvar name=code><code>vagrant roles enable {{{vagrant}}} --provision</code></tvar></translate>
}}{{#ifeq:{{NAMESPACE}}|Extension|{{#if:{{{registration|}}}||[[Category:Extensions not using extension registration{{#translation:}}]]}}}}<noinclude>
{{documentation|content=
{{lua|Module:Extension}}
<translate>
== Usage == 
</translate>

{{ExtensionInstall/doc}}

<translate>
== Examples == 


Below a few examples of how to use this template:

=== Simple === 
</translate>
<pre>
{{ExtensionInstall}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension}}
</blockquote>

<translate>
=== Name === 
</translate>
<pre>
{{ExtensionInstall|CategoryTree}}
</pre>
<blockquote>
{{ExtensionInstall|CategoryTree}}
</blockquote>

<translate>
=== Download link === 
</translate>
<pre>
{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
</blockquote>

=== LocalSettings ===

<pre>
{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|localsettings=
$wgUseAjax = true;
}}
</blockquote>

<translate>
==== <tvar name=1>LocalSettings</tvar> early ==== 
</translate>

<pre>
{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // <translate nowrap> This must be included before the extension is loaded</translate>
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|localsettingsearly=
$wgUseAjax = true; // <translate nowrap> This must be included before the extension is loaded</translate>
}}
</blockquote>

<translate>
=== DB Update === 
</translate>
<pre>
{{ExtensionInstall
|db-update=Yes
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|db-update=Yes
}}
</blockquote>

<translate>
=== Composer === 
</translate>
<pre>
{{ExtensionInstall
|composer=Yes
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|composer=Yes
}}
</blockquote>

<translate>
=== Custom steps === 
</translate>
<pre>
{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
</blockquote>

<translate>
=== Support registration === 
</translate>
<pre>
{{ExtensionInstall
|registration=1
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|registration=1
}}
</blockquote>

<translate>
=== Support registration with minimum version === 
</translate>
<pre>
{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|registration=1
|no-registration-version=1.39
}}
</blockquote>

<translate>

This only works if the version specified is <tvar name="1">{{#expr:{{MW legacy lts branch number}}-.04}}</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>
<pre>
{{ExtensionInstall
|registration=required
}}
</pre>
<blockquote>
{{ExtensionInstall|MyExtension
|registration=required
}}
</blockquote>

<translate>
=== Everything === 
</translate>
<pre>
{{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
}}
</pre>
<blockquote>
{{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
|no-registration-version=1.39
}}
</blockquote>
}}
[[Category:Installation guide templates{{#translation:}}]]
</noinclude>

Template:ExtensionInstall - Revision history

Plopilpy: 1 revision imported

mw>Nemoralis: use syntaxhighlight with copy button