Mall:Installera tillägg
- Ladda ner och placera filen/filerna i en katalog som heter
ExtensionInstall
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall - Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Uses Lua: |
Användning
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 has one or more database tables that need to be created through [[update.php]], set this parameter to any value.
| Boolean | optional |
Composer | composer | If the extension uses [[Composer]] to manage dependencies, set this parameter to any value.
| 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 |
Exempel
Nedan finns ett gäng exempel på hur man använder mallen:
Enkelt
{{ExtensionInstall}}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Namn
{{ExtensionInstall|CategoryTree}}
- Ladda ner och placera filen/filerna i en katalog som heter
CategoryTree
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree- Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/CategoryTree/CategoryTree.php";- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Ladda ner länk
{{ExtensionInstall |download-link=[http://bits.wikimedia.org/example.zip Download] }}
- Download och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.- Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
LocalSettings
{{ExtensionInstall |localsettings= $wgUseAjax = true; }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
LocalSettings tidigt
{{ExtensionInstall |localsettingsearly= $wgUseAjax = true; // detta måste inkluderas innan tillägget laddas }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
$wgUseAjax = true; // detta måste inkluderas innan tillägget laddas require_once "$IP/extensions/MyExtension/MyExtension.php";- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Databasuppdatering
{{ExtensionInstall |db-update=Yes }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Kör uppdateringsskriptetsom automatiskt kommer skapa de nödvändiga databastabellerna som tillägget behöver.
- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Composer
{{ExtensionInstall |composer=Yes }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Kör bara Composer när du installerar från Git för att installera PHP-beroenden, genom att använda
composer install --no-dev
i tilläggets katalog. (Se ärende T173141 för tänkbara besvär.)- Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Egna steg
{{ExtensionInstall |custom-steps= * Lorem ipsum dolor sit amet * Foo bar baz quux [[sandbox]] }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Stödja registrering
{{ExtensionInstall |registration=1 }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
wfLoadExtension( 'MyExtension' );- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Registrering av stöd med minimiversion
{{ExtensionInstall |registration=1 |no-registration-version=1.39 }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
wfLoadExtension( 'MyExtension' );- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
För användare som kör MediaWiki 1.39 eller äldre:
Instruktionerna ovan beskriver det nya sättet att installera tillägget med
wfLoadExtension()
. Behöver du installera tillägget på en äldre version (MediaWiki 1.39 eller äldre), så behöver du, istället förwfLoadExtension( 'MyExtension' );
, använda:require_once "$IP/extensions/MyExtension/MyExtension.php";
Detta fungerar bara om den angivna versionen är 1.35 eller senare, annars antar mallen att ingen bryr sig om äldre versioner och faller tillbaka till #Kräva registrering.
Kräver registrering
{{ExtensionInstall |registration=required }}
- Ladda ner och placera filen/filerna i en katalog som heter
MyExtension
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Lägg till följande kod längst ner i din LocalSettings.php -fil:
wfLoadExtension( 'MyExtension' );- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Alla
{{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 och placera filen/filerna i en katalog som heter
Example
i dinextensions/
-mapp.- Kör bara Composer när du installerar från Git för att installera PHP-beroenden, genom att använda
composer install --no-dev
i tilläggets katalog. (Se ärende T173141 för tänkbara besvär.)- Lägg till följande kod längst ner i din LocalSettings.php -fil:
wfLoadExtension( 'Example' ); $wgUseAjax = true;- Kör uppdateringsskriptetsom automatiskt kommer skapa de nödvändiga databastabellerna som tillägget behöver.
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
För användare som kör MediaWiki 1.39 eller äldre:
Instruktionerna ovan beskriver det nya sättet att installera tillägget med
wfLoadExtension()
. Behöver du installera tillägget på en äldre version (MediaWiki 1.39 eller äldre), så behöver du, istället förwfLoadExtension( 'Example' );
, använda:require_once "$IP/extensions/Example/Example.php";
Vagrant-installering:
- Om du använder Vagrant ska du installera med
vagrant roles enable example --provision