Template:ExtensionInstall

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:ExtensionInstall and the translation is 92% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎čeština • ‎български • ‎македонски • ‎русский • ‎українська • ‎العربية • ‎فارسی • ‎हिन्दी • ‎বাংলা • ‎中文 • ‎日本語 • ‎한국어
  • Скачайте и распакуйте файл(ы) в папку с названием ExtensionInstall в вашей папке extensions/.
  • Добавьте следующий строки в конец файла LocalSettings.php:
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Документация шаблона

Использование

Add instructions about installing an extension.

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}}, i.e. the page name without namespace nor subpages
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 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/.
  • Добавьте следующий строки в конец файла LocalSettings.php:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Наименование

{{ExtensionInstall|CategoryTree}}
  • Скачайте и распакуйте файл(ы) в папку с названием CategoryTree в вашей папке extensions/.
  • Добавьте следующий строки в конец файла 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/.
  • Добавьте следующий строки в конец файла LocalSettings.php:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

LocalSettings early

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // this must be included before the extension is loaded
}}
  • Скачайте и распакуйте файл(ы) в папку с названием MyExtension в вашей папке extensions/.
  • Добавьте следующий строки в конец файла LocalSettings.php:
    $wgUseAjax = true; // this must be included before the extension is loaded
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Обновление БД

{{ExtensionInstall
|db-update=Yes
}}
  • Скачайте и распакуйте файл(ы) в папку с названием MyExtension в вашей папке extensions/.
  • Добавьте следующий строки в конец файла LocalSettings.php:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Выполните скрипт обновления, который автоматически создаст необходимые таблицы, используемые расширением.
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Composer

{{ExtensionInstall
|composer=Yes
}}
  • Скачайте и распакуйте файл(ы) в папку с названием MyExtension в вашей папке extensions/.
  • Запустите 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/.
  • Добавьте следующий строки в конец файла 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/.
  • Добавьте следующий строки в конец файла LocalSettings.php:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Для использующих MediaWiki 1.24 или более ранние:

В приведенных выше инструкциях описывается новый способ установки этого расширения с использованием wfLoadExtension()

Если вам нужно установить это расширение на более ранние версии (MediaWiki 1.24 и более ранние), вместо wfLoadExtension( 'MyExtension' );, вам необходимо использовать:

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

Установка на рекомендуемую зарегистрированную версию MediaWiki

{{ExtensionInstall
|registration=1
|no-registration-version=1.25
}}
  • Скачайте и распакуйте файл(ы) в папку с названием MyExtension в вашей папке extensions/.
  • Добавьте следующий строки в конец файла LocalSettings.php:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Для использующих MediaWiki 1.25 или более ранние:

В приведенных выше инструкциях описывается новый способ установки этого расширения с использованием wfLoadExtension()

Если вам нужно установить это расширение на более ранние версии (MediaWiki 1.25 и более ранние), вместо wfLoadExtension( 'MyExtension' );, вам необходимо использовать:

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

Требование регистрации

{{ExtensionInstall
|registration=required
}}
  • Скачайте и распакуйте файл(ы) в папку с названием MyExtension в вашей папке extensions/.
  • Добавьте следующий строки в конец файла 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
}}
  • Если вы используете Vagrant , установите с помощью vagrant roles enable example --provision
Ручная установка
  • Download и распакуйте файл(ы) в папку с названием Example в вашей папке extensions/.
  • Запустите 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.24 или более ранние:

В приведенных выше инструкциях описывается новый способ установки этого расширения с использованием wfLoadExtension()

Если вам нужно установить это расширение на более ранние версии (MediaWiki 1.24 и более ранние), вместо wfLoadExtension( 'Example' );, вам необходимо использовать:

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