Шаблон:ExtensionInstall

This page is a translated version of the page Template:ExtensionInstall and the translation is 100% complete.
  • Завантажте і розмістіть файли в каталозі з назвою ExtensionInstall у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.
Документація шаблону

Використання

Installation instructions.

Template parameters[Edit template data]

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
Git submodulegit-submodule

Add --recurse-submodules to the git clone command

Booleanoptional
Vagrant role namevagrant

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

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

Приклади

Нижче наведено декілька прикладів використання цього шаблону:

Простий

{{ExtensionInstall}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Назва

{{ExtensionInstall|CategoryTree}}
  • Завантажте і розмістіть файли в каталозі з назвою CategoryTree у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Посилання для звантажування

{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
  • Download і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Ранні LocalSettings

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // Це необхідно включити перед завантаженням розширення
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    $wgUseAjax = true; // Це необхідно включити перед завантаженням розширення
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Оновлення бази даних

{{ExtensionInstall
|db-update=Yes
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Запустіть скрипт оновлення, який автоматично створить необхідні таблиці бази даних, які потрібні цьому розширенню.
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Composer

{{ExtensionInstall
|composer=Yes
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Тільки під час встановлення з git виконайте Composer для встановлення залежностей PHP, подаючи composer install --no-dev в каталозі розширень. (Див. завдання T173141 щодо можливих ускладнень.)
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Кроки користувача

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Підтримка реєстрації

{{ExtensionInstall
|registration=1
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Підтримка реєстрації з мінімальною версією

{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Користувачам, які використовують MediaWiki 1.39 або раніші:

Наведені вище інструкції описують новий спосіб встановлення цього розширення за допомогою wfLoadExtension(). Якщо вам треба встановити це розширення на попередніх версіях (MediaWiki 1.39 і раніші), замість wfLoadExtension( 'MyExtension' ); вам потрібно використати:

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

Це працює, лише якщо вказана версія 1.35 або новіша, інакше шаблон припускає, що старі версії нікого не цікавлять, і повертається до #Потрібна реєстрація.

Потрібна реєстрація

{{ExtensionInstall
|registration=required
}}
  • Завантажте і розмістіть файли в каталозі з назвою MyExtension у вашій extensions/ папці.
    Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Все

{{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 і розмістіть файли в каталозі з назвою Example у вашій extensions/ папці.
  • Тільки під час встановлення з git виконайте Composer для встановлення залежностей PHP, подаючи composer install --no-dev в каталозі розширень. (Див. завдання T173141 щодо можливих ускладнень.)
  • Додайте такий код унизу вашого файлу LocalSettings.php :
    wfLoadExtension( 'Example' );
    $wgUseAjax = true;
    
  • Запустіть скрипт оновлення, який автоматично створить необхідні таблиці бази даних, які потрібні цьому розширенню.
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Користувачам, які використовують MediaWiki 1.39 або раніші:

Наведені вище інструкції описують новий спосіб встановлення цього розширення за допомогою wfLoadExtension(). Якщо вам треба встановити це розширення на попередніх версіях (MediaWiki 1.39 і раніші), замість wfLoadExtension( 'Example' ); вам потрібно використати:

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


Встановлення з Vagrant:

  • Якщо використовується Vagrant , встановіть з vagrant roles enable example --provision