Template:ExtensionInstall

This page is a translated version of the page Template:ExtensionInstall and the translation is 100% complete.
  • Stáhněte soubor/y a vložte je do adresáře pojmenovaného ExtensionInstall ve vaší složce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Template documentation

Použití

[Edit template data]

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Extension name1

Set the extension name manually.

Default
The current page name without namespace prefix.
Auto value
{{ROOTPAGENAME}}
Stringoptional
Vagrant role namevagrant

If given, shows how to install extension with the Vagrant's enable-role command

Auto value
Stringoptional
Download linkdownload-link

Overwrite the download link.

Default
Link to Special:ExtensionDistributor with the extension name.
URLoptional
LocalSettings earlylocalsettingsearly

Pass custom php code that the user should include in [[LocalSettings.php]] before the extension is loaded.

Example
$wgUseAjax = true; //must be included before the extension is loaded
Unknownoptional
LocalSettingslocalsettings

Pass custom php code that the user should include in [[LocalSettings.php]].

Example
$wgUseAjax = true;
Unknownoptional
Database updatedb-update

If the extension has one or more database tables that need to be created through [[update.php]], set this parameter to any value.

Default
false
Booleanoptional
Composercomposer

If the extension uses [[Composer]] to manage dependencies, set this parameter to any value.

Default
false
Booleanoptional
Custom steps 0custom-steps0

Additional steps before download, e.g. other required extensions (as an unordered "* list")

Contentoptional
Custom stepscustom-steps

Additional steps (as an unordered "* list")

Contentoptional
Supports registrationregistration

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.

Stringoptional
No registration versionno-registration-version

The MediaWiki version for which extension registration should not be used

Default
1.24
Unknownoptional

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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes 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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes 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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes 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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes 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; // this must be included before the extension is loaded
}}
  • Stáhněte soubor/y a vložte je do adresáře pojmenovaného MyExtension ve vaší složce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    $wgUseAjax = true; // this must be included before the extension is loaded
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes 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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    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.
  • Yes 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žce extensions/.
  • 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.)
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes 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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes 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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes 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.24 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.24 či starší), musíte místo wfLoadExtension( 'MyExtension' ); použít:

require_once "$IP/extensions/MyExtension/MyExtension.php";

Je-li možné rozšíření registrovat až od určité verze MediaWiki

{{ExtensionInstall
|registration=1
|no-registration-version=1.25
}}
  • Stáhněte soubor/y a vložte je do adresáře pojmenovaného MyExtension ve vaší složce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes 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.25 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.25 či starší), musíte místo wfLoadExtension( 'MyExtension' ); použít:

require_once "$IP/extensions/MyExtension/MyExtension.php";

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žce extensions/.
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes 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žce extensions/.
  • 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.)
  • Následující kód přidejte na konec vašeho souboru LocalSettings.php :
    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
  • Yes 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.24 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.24 či starší), musíte místo wfLoadExtension( '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