Vorlage:ExtensionInstall
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
ExtensionInstallim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall
- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
| Benutzt Lua: |
Verwendung
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
Beispiele
Unten einige Beispiele, wie diese Vorlage zu verwenden ist:
Einfach
{{ExtensionInstall}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/MyExtension/MyExtension.php";Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Name
{{ExtensionInstall|CategoryTree}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
CategoryTreeim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/CategoryTree/CategoryTree.php";Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Herunterladen
{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
- Die Download und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/MyExtension/MyExtension.php";Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
LocalSettings
{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
LocalSettings früher
{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // Dies muss enthalten sein, bevor die Erweiterung geladen wird
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
$wgUseAjax = true; // Dies muss enthalten sein, bevor die Erweiterung geladen wird require_once "$IP/extensions/MyExtension/MyExtension.php";Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Datenbank-Aktualisierung
{{ExtensionInstall
|db-update=Yes
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Composer
{{ExtensionInstall
|composer=Yes
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Wird von git aus installiert, ist Composer auszuführen, um PHP-Abhängigkeiten zu installieren, indem
composer install --no-devim Erweiterungsverzeichnis ausgeführt wird. (Siehe T173141 für mögliche Komplikationen.)- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/MyExtension/MyExtension.php";Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Anpassungsschritte
{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Registrierung unterstützt
{{ExtensionInstall
|registration=1
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
wfLoadExtension( 'MyExtension' );Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Unterstützung der Registrierung mit Mindestversion
{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
wfLoadExtension( 'MyExtension' );Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Für Benutzer, die MediaWiki in der Version 1.39 und früher betreiben:
Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von
wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.39 und früher) – an Stelle vonwfLoadExtension( 'MyExtension' );– installiert, benutze:require_once "$IP/extensions/MyExtension/MyExtension.php";
Das funktioniert nur, wenn die angegebene Version 1.39 oder höher ist. Andernfalls geht die Vorlage davon aus, dass sich niemand für alte Versionen interessiert und greift auf #Registrierung erforderlich zurück.
Registrierung erforderlich
{{ExtensionInstall
|registration=required
}}
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
MyExtensionim Ordnerextensions/ablegen.
Entwickler und Code-Beitragende sollten stattdessen die Erweiterung von Git installieren, mit:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
wfLoadExtension( 'MyExtension' );Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Alles
{{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
}}
- Die Download und die Datei(en) in ein Verzeichnis namens
Exampleim Ordnerextensions/ablegen.- Wird von git aus installiert, ist Composer auszuführen, um PHP-Abhängigkeiten zu installieren, indem
composer install --no-devim Erweiterungsverzeichnis ausgeführt wird. (Siehe T173141 für mögliche Komplikationen.)- Folgenden Code am Ende deiner LocalSettings.php-Datei einfügen:
wfLoadExtension( 'Example' ); $wgUseAjax = true;- Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
Erledigt – Navigiere zu Special:Version in deinem Wiki, um zu überprüfen, ob die Erweiterung erfolgreich installiert wurde.
Für Benutzer, die MediaWiki in der Version 1.39 und früher betreiben:
Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von
wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.39 und früher) – an Stelle vonwfLoadExtension( 'Example' );– installiert, benutze:require_once "$IP/extensions/Example/Example.php";
Vagrant-Installation:
- Wird Vagrant benutzt, ist mit
vagrant roles enable example --provisionzu installieren