Template:ExtensionInstall

This page is a translated version of the page Template:ExtensionInstall and the translation is 100% complete.
  • Pobierz i umieść plik(i) w katalogu o nazwie ExtensionInstall w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.
Dokumentacja szablonu

Użycie

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

Przykłady

Poniżej znajduje się kilka przykładów jak używać tego szablonu:

Bez parametrów

{{ExtensionInstall}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Z nazwą rozszerzenia

{{ExtensionInstall|CategoryTree}}
  • Pobierz i umieść plik(i) w katalogu o nazwie CategoryTree w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Z niestandardowym linkiem do pobierania rozszerzenia

{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
  • Download i umieść plik(i) w katalogu o nazwie MyExtension w swoim katalogu extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

LocalSettings z kodem do wykonania przed załadowaniem rozszerzenia

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // this must be included before the extension is loaded
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    $wgUseAjax = true; // this must be included before the extension is loaded
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Gdy rozszerzenie wymaga aktualizacji bazy danych

{{ExtensionInstall
|db-update=Yes
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Uruchom skrypt aktualizujący, który automatycznie stworzy potrzebne tabele dla tego rozszerzenia.
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Z wykorzystaniem Composera

{{ExtensionInstall
|composer=Yes
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Tylko w przypadku instalacji z repozytorium git należy uruchomić Composer, aby zainstalować zależności PHP, poprzez wywołanie composer install --no-dev w katalogu rozszerzenia. (Zobacz zadanie T173141 w celu uzyskania informacji o możliwych komplikacjach.)
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Gdy rozszerzenie wymaga niestandardowych kroków podczas instalacji

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Gdy rozszerzenie wspiera instalację poprzez rejestrację

{{ExtensionInstall
|registration=1
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Do użytkowników używających wersji MediaWiki 1.24 lub wcześniejszej:

Powyższe instrukcje opisują nowy sposób instalowania tego rozszerzenia z wykorzystaniem wfLoadExtension(). Jeżeli chcesz zainstalować to rozszerzenie we wcześniejszych wersjach (MediaWiki 1.24 i wcześniejsze), zamiast wfLoadExtension( 'MyExtension' ); użyj:

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

Aby ustawić maksymalną wersję MediaWiki, która nie wymaga rejestracji rozszerzeń

{{ExtensionInstall
|registration=1
|no-registration-version=1.25
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Do użytkowników używających wersji MediaWiki 1.25 lub wcześniejszej:

Powyższe instrukcje opisują nowy sposób instalowania tego rozszerzenia z wykorzystaniem wfLoadExtension(). Jeżeli chcesz zainstalować to rozszerzenie we wcześniejszych wersjach (MediaWiki 1.25 i wcześniejsze), zamiast wfLoadExtension( 'MyExtension' ); użyj:

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

Gdy rozszerzenie wymaga instalacji poprzez rejestrację

{{ExtensionInstall
|registration=required
}}
  • Pobierz i umieść plik(i) w katalogu o nazwie MyExtension w folderze extensions/.
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Ze wszystkimi parametrami

{{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 i umieść plik(i) w katalogu o nazwie Example w swoim katalogu extensions/.
  • Tylko w przypadku instalacji z repozytorium git należy uruchomić Composer, aby zainstalować zależności PHP, poprzez wywołanie composer install --no-dev w katalogu rozszerzenia. (Zobacz zadanie T173141 w celu uzyskania informacji o możliwych komplikacjach.)
  • Dodaj poniższy kod na dole twojego pliku LocalSettings.php :
    wfLoadExtension( 'Example' );
    $wgUseAjax = true;
    
  • Uruchom skrypt aktualizujący, który automatycznie stworzy potrzebne tabele dla tego rozszerzenia.
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Do użytkowników używających wersji MediaWiki 1.24 lub wcześniejszej:

Powyższe instrukcje opisują nowy sposób instalowania tego rozszerzenia z wykorzystaniem wfLoadExtension(). Jeżeli chcesz zainstalować to rozszerzenie we wcześniejszych wersjach (MediaWiki 1.24 i wcześniejsze), zamiast wfLoadExtension( 'Example' ); użyj:

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


Instalacja Vagranta:

  • Jeżeli korzystasz z Vagrant a, zainstaluj poprzez vagrant roles enable example --provision