Template:ExtensionInstall/dtp
- Download om powili'o file(s) dii id direktori kingaran
ExtensionInstallid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall
- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
| Uses Lua: |
Usage
Installation instructions.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Extension name | 1 | Set the extension name manually.
| String | optional |
| Git submodule | git-submodule | Add --recurse-submodules to the git clone command | Boolean | optional |
| Vagrant role name | vagrant | If given, shows how to install extension with the Vagrant's enable-role command | String | optional |
| Download link | download-link | Overwrite the download link.
| URL | optional |
| LocalSettings early | localsettingsearly | Pass custom php code that the user should include in [[LocalSettings.php]] before the extension is loaded.
| Unknown | optional |
| LocalSettings | localsettings | Pass custom PHP code that the user should include in [[LocalSettings.php]].
| Unknown | optional |
| Database update | db-update | If the extension requires the update script to be run, set this parameter to any value. (For example, if it has one or more database tables that need to be created.)
| Boolean | optional |
| Composer | composer | If the extension uses Composer to manage dependencies, set this parameter to any value. Not that this does not indicate that the extension is able to be installed with Composer.
| Boolean | optional |
| Custom steps 0 | custom-steps0 | Additional steps before download, e.g. other required extensions (as an unordered "* list"). | Content | optional |
| Custom steps | custom-steps | Additional steps (as an unordered "* list"). | Content | optional |
| Supports registration | registration | Changes the template to use <code>wfLoadExtension()</code> if it supports registration. Set to any value if the extension supports registration, or to <code>required</code> if it <em>only</em> supports registration and doesn't support the old-style of loading. | String | optional |
| No registration version | no-registration-version | The MediaWiki version for which extension registration should not be used.
| Unknown | optional |
See also
Examples
Below a few examples of how to use this template:
Simple
{{ExtensionInstall}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/MyExtension/MyExtension.php";Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Name
{{ExtensionInstall|CategoryTree}}
- Download om powili'o file(s) dii id direktori kingaran
CategoryTreeid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/CategoryTree/CategoryTree.php";Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Download link
{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
- Download and place the file(s) in a directory called
MyExtensionin yourextensions/folder.- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/MyExtension/MyExtension.php";Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
LocalSettings
{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
LocalSettings early
{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // This must be included before the extension is loaded
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
$wgUseAjax = true; // This must be included before the extension is loaded require_once "$IP/extensions/MyExtension/MyExtension.php";Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
DB Update
{{ExtensionInstall
|db-update=Yes
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Run the update script which will automatically create the necessary database tables that this extension needs.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Composer
{{ExtensionInstall
|composer=Yes
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Only when installing from Git, run Composer to install PHP dependencies, by issuing
composer install --no-devin the extension directory. (See T173141 for potential complications.)- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/MyExtension/MyExtension.php";Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Custom steps
{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Support registration
{{ExtensionInstall
|registration=1
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'MyExtension' );Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Support registration with minimum version
{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'MyExtension' );Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.39 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.39 and earlier), instead ofwfLoadExtension( 'MyExtension' );, you need to use:require_once "$IP/extensions/MyExtension/MyExtension.php";
This only works if the version specified is 1.35 or later, otherwise the template assumes nobody cares about ancient versions and falls back to #Require registration.
Require registration
{{ExtensionInstall
|registration=required
}}
- Download om powili'o file(s) dii id direktori kingaran
MyExtensionid suang folderextensions/nu.
Momomoburu om mongunguhup kod minog do papadakat do lolombus from Git suai ko, momoguno:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'MyExtension' );Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
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
}}
- Download and place the file(s) in a directory called
Examplein yourextensions/folder.- Only when installing from Git, run Composer to install PHP dependencies, by issuing
composer install --no-devin the extension directory. (See T173141 for potential complications.)- Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'Example' ); $wgUseAjax = true;- Run the update script which will automatically create the necessary database tables that this extension needs.
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.39 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.39 and earlier), instead ofwfLoadExtension( 'Example' );, you need to use:require_once "$IP/extensions/Example/Example.php";
Vagrant installation:
- If using Vagrant, install with
vagrant roles enable example --provision