Template:ExtensionInstall
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
ExtensionInstall
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall - Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Uses Lua: |
Použití
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 |
Příklady
Níže uvedené příklady demonstrují jak použít tuto šablonu:
Bez parametrů
{{ExtensionInstall}}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
S předaným názvem rozšíření
{{ExtensionInstall|CategoryTree}}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
CategoryTree
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/CategoryTree/CategoryTree.php";- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
S aktivním linkem na soubor ke stažení
{{ExtensionInstall |download-link=[http://bits.wikimedia.org/example.zip Download] }}
- Download soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
LocalSettings
{{ExtensionInstall |localsettings= $wgUseAjax = true; }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Před aktivací v LocalSettings
{{ExtensionInstall |localsettingsearly= $wgUseAjax = true; // musí být zahrnuto před načtením rozšíření }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
$wgUseAjax = true; // musí být zahrnuto před načtením rozšíření require_once "$IP/extensions/MyExtension/MyExtension.php";- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
S informací o nutné aktualizaci databáze
{{ExtensionInstall |db-update=Yes }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Spusťte aktualizační skript, který automaticky provede všechny nezbytné databázové změny, jaké rozšíření vyžaduje.
- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Vyžaduje-li aktualizaci přes Composer
{{ExtensionInstall |composer=Yes }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Při instalaci z Gitu spusťte Composer pro instalaci závislostí PHP zadáním
composer install --no-dev
v adresáři rozšíření. (Vyskytnou-li se nějaké komplikace, podívejte se na úkol T173141.)- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Vyžaduje-li instalace další nezbytné kroky
{{ExtensionInstall |custom-steps= * Lorem ipsum dolor sit amet * Foo bar baz quux [[sandbox]] }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Podporuje-li rozšíření zavedení přes registraci
{{ExtensionInstall |registration=1 }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
wfLoadExtension( 'MyExtension' );- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Podpora registrace s minimální verzí
{{ExtensionInstall |registration=1 |no-registration-version=1.39 }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
wfLoadExtension( 'MyExtension' );- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Pro ty, kteří používají MediaWiki 1.39 a starší:
Výše uvedené instrukce se týkají instalace přes
wfLoadExtension()
, což je novější způsob instalace rozšíření. Pokud potřebujete toto rozšíření nainstalovat na starší verzi (MediaWiki 1.39 či starší), musíte místowfLoadExtension( 'MyExtension' );
použít:require_once "$IP/extensions/MyExtension/MyExtension.php";
Toto funguje pouze v případě, že je zadaná verze 1.35 nebo novější, jinak šablona předpokládá, že prastaré verze nikoho nezajímají, a vrátí se k #Vyžadovat registraci.
Podporuje-li automatickou registraci
{{ExtensionInstall |registration=required }}
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
MyExtension
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
wfLoadExtension( 'MyExtension' );- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Komplexní použití této parametrizované šablony
{{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 soubor/y a vložte je do adresáře pojmenovaného
Example
ve vaší složceextensions/
.- Při instalaci z Gitu spusťte Composer pro instalaci závislostí PHP zadáním
composer install --no-dev
v adresáři rozšíření. (Vyskytnou-li se nějaké komplikace, podívejte se na úkol T173141.)- Na konec vašeho souboru LocalSettings.php přidejte následující kód:
wfLoadExtension( 'Example' ); $wgUseAjax = true;- Spusťte aktualizační skript, který automaticky provede všechny nezbytné databázové změny, jaké rozšíření vyžaduje.
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Pro ty, kteří používají MediaWiki 1.39 a starší:
Výše uvedené instrukce se týkají instalace přes
wfLoadExtension()
, což je novější způsob instalace rozšíření. Pokud potřebujete toto rozšíření nainstalovat na starší verzi (MediaWiki 1.39 či starší), musíte místowfLoadExtension( 'Example' );
použít:require_once "$IP/extensions/Example/Example.php";
Instalace Vagrant:
- Pokud používáte Vagrant , instalujte s těmito parametry
vagrant roles enable example --provision