Шаблон:Розширення
This template employs intricate features of template syntax.
You are encouraged to familiarize yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the general sandbox or your user space before changing anything here. |
Uses Lua: |
Цей шаблон використовує TemplateStyles: |
This template should be added to all extension pages on this wiki (but only the main page). It will add a useful infobox (see below) and will automatically add the extension to Category:All extensions , along with the appropriate status and implementation type categories. It autofills some fields of the infobox with extension data collected by wikitech:Tool:Extjsonuploader.
Використання
Копіювати і вставляти: {{Extension |templatemode = |name = |status = |type1 = |type2 = |hook1 = |hook2 = |newhook1 = |newhook2 = |username = |author = |description = |image = |imagesize = |version = |update = |version preview = |update preview = |compatibility policy = |mediawiki = |php = |needs-updatephp = |composer = |virtual domain = |table1 = |table2 = |license = |download = |repo = |readme = |changelog = |help = |example = |namespace = |parameters = |tags = |rights = |compatibility = |phabricator = |translate = |vagrant-role = }}Стосовно допомоги з значеннями параметрів, див. нижче |
|
Content parameters
This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.
Parameter | Description |
---|---|
name | name of the extension |
status |
current release status One of:
If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorised as unknown. In cases where the value is invalid, it will be placed in a special category so that the error can be caught and fixed. |
type1 type2 type3 type4 type5 type6 | implementation type
The implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed. Allowed values for the type1, type2, ... parameters are:
Any other value for 'type' is invalid, and will cause the extension to be placed in Category:Extensions with invalid or missing type/uk. Note: Many extensions have more than one type, if this applies to yours, replace|type= with |type1=|type2=|type3=... . You may define up to six types for an extension. |
hook1 hook2 hook3 hook4 ... |
name of each hook used by the extension
Entering values in this field is a good way to get exposure for your extension and help other developers. Each documented hook will automatically add the extension to a category listing extensions that use that hook. This category is autolinked to each hook page so that programmers can easily find examples of extensions that use a particular hook. For multiple hooks, assign the first hook to hook1, the second to hook2 and so on. |
newhook1 newhook2 newhook3 newhook4 ... newhook90 |
name of each hook provided by the extension You might also want to add the hooks to Extension hook registry. |
username | The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s. |
The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present). | |
description | short description |
image | Screenshot or logo of extension. It should be provided without namespace and without [[]]s. |
imagesize | Facultative, size of the image without adding px, e.g. 360 (default size is 300px) |
version | Last version |
update | Date of the last update |
version preview | Preview version |
update preview | Date of the last update to the preview version |
compatibility policy | Compatibility policy (accepted values: master, main, rel, ltsrel). (backlog ) |
mediawiki | Required version of MediaWiki. Most extensions should not need to use this — it defaults to the value of the 'requires' property of extension.json. See also Category:Extensions without MediaWiki version and Category:Extensions with manual MediaWiki version . |
php | Required version of PHP |
needs-updatephp |
Extensions that conform to MediaWiki extension standards come with a schema change script which you need to start manually (once) before starting and accessing the MediaWiki through your browser, and after you copied all the extension files to
$IP означає Installation Path (шлях встановлення) (чи "папка, директорія") вашого встановлення MediaWiki, ту саму папку, в якій лежать LocalSettings.php , index.php тощо. |
composer | The extension's Composer package name, in the standard format. It will be automatically included if set in an extension's "composer.json" file (i.e. this parameter is not required in that case). It will be linked to the extension's page on Packagist. |
virtual domain | домен віртуальної бази даних , який використовується розширенням. |
table1 table2 table3 table4 ... table30 | ім'я кожної неосновної таблиці, що використовується розширенням Посилання на підсторінку вашої сторінки розширення. Наприклад, «table1 = cu_changes» на Extension:CheckUser посилатиметься на Extension:CheckUser/cu_changes table . Не вказуйте основні таблиці, такі як page або revision ; лише список таблиць, доданих розширеннями. |
license | Ліцензія, що регулює використання цього розширення, як один із кодів, знайдених у https://spdx.org/licenses/, напр. GPL-2.0-or-later , GPL-2.0-only або GPL-3.0-or-later тощо. |
download | посилання на завантаження : Git, {{WikimediaDownload/uk }}. |
repo | Назва репозиторію Gerrit, у якому зберігається код розширення, якщо вона відрізняється від назви сторінки. Налаштування цього параметра автоматично встановлює |завантаження= та дозволяє шаблону автоматично завантажувати дані з відповідного файлу extension.json . |
readme | Зовнішнє посилання на файл readme, напр. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README |
changelog | Зовнішнє посилання на файл журналу змін, напр. Extension:GeoGebra/Changelog |
help | Посилання на довідку користувача для розширення. If not provided, will look for Help:Extension:ExtensionName . Якщо надається, слід надати повне посилання на вікітекст (оскільки ви можете зробити посилання, наприклад, на зовнішню сторінку). |
example | Приклад, веб-сайт або скріншот робочого розширення |
namespace | простір імен, у якому використовується це розширення |
parameters | Доступні параметри для LocalSettings.php |
Будь-які теги, які використовує ваше розширення (наприклад, <tag1>, <tag2>). | |
rights | Права, додані розширенням. Не плутати з ліцензією! Такі права, як makebot або desysop , а не GFDL або LGPL або GPL - це ліцензії! |
compatibility | Додаткова інформація про сумісність, наприклад таблиці сумісності. Рекомендується також додавати будь-яку інформацію про сумісність на стороні клієнта сюди, особливо якщо вона відрізняється від очікувань щодо повної підтримки браузера. |
bugzilla | Bugzilla Назва компонента розширення MediaWiki |
phabricator | Назва проєкту Phabricator. |
translate |
Необов’язковий параметр для посилання на точну сторінку, де (ідентифікатор групи повідомлень, з якою) розширення можна буде перекладати на translatewiki.net, якщо ввімкнено. Якщо посилання за замовчуванням неправильне, вручну встановіть для нього значення:
|
vagrant-role | Роль MediaWiki-Vagrant |
CheckUsageNameOverride | Замініть назву сторінки, яка використовується для посилання перевірки використання. |
Контрольні параметри
Параметр | Опис |
---|---|
templatemode |
Керує автоматичною категоризацією сторінки хосту. Зазвичай залишають порожнім. Альтернативні значення:
|
Використання картку
Існуючі сторінки розширення
Якщо ви хочете додати картка до існуючої сторінки, скопіюйте та вставте код у верху цієї сторінки.
Створити нову сторінку розширення
Якщо ви хочете створити нову сторінку розширення, введіть назву нижче та натисніть кнопку. Буде створено нову сторінку з шаблоном інфобоксу.
A developer sharing their code in the MediaWiki code repository should expect:
- Feedback / Criticism / Code reviews
- Review and comments by other developers on things like framework use, security, efficiency and usability.
- Developer tweaking
- Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.
- Improved access for wiki sysadmins
- If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then create a developer account to continue maintaining it.
- Future versions by other developers
- New branches of your code being created automatically as new versions of MediaWiki are released. You should backport to these branches if you want to support older versions.
- Incorporation of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.
- Credit
- Credit for your work being preserved in future versions — including any merged extensions.
- Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.
Any developer who is uncomfortable with any of these actions occurring should not host in the code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it.
Покращення цього шаблону
Якщо ви хочете покращити цей шаблон, дякую! Це складний шаблон, тому ось допомога:
Кнопка Створити розширення
Щоб покращити роботу кнопки створення розширення:
- Template:Extension/Sample : Шаблонне розширення, яке попередньо завантажується на щойно створені сторінки.
- Template:Extension/CreateExtensionInputBox : Поле введення, яке можна вставляти куди завгодно, щоб користувачі могли легко створювати розширення. Щоб отримати документацію щодо тегу
<inputbox>
, перегляньте Extension:InputBox .
Параметри інформаційного поля
В загальному:
- Щоб зробити цей шаблон простим у використанні, кожна мітка в інформаційному полі пов’язана з документацією щодо параметрів шаблону, які він відображає. Якщо ви додаєте параметр, обов’язково додайте його до документації параметрів вмісту та пов’яжіть його мітку з цією документацією.
Щоб змінити/виправити/додати параметри типу реалізації:
- Перевірте сторінку обговорення - там було багато дискусій щодо цієї сфери.
- Допустимі типи та те, на що вони посилаються, визначено в Module:Extension
Щоб змінити поведінку параметрів хука:
- Template:Extension/HookInUse: Додає посилання та категорії для хука, що використовується. Кілька використовуваних хуків реалізуються шляхом виклику цього шаблону за допомогою Template:Foreach.
- Template:Extension/HookInUseNoCats: Використовується замість Template:Extension/HookInUse, коли цей шаблон використовується в
templatemode=nocats
. Шаблони, які використовуються з Template:Foreach, можуть приймати лише один параметр, тому нам потрібно завершити виклик Template:Extension/HookInUse іншим шаблоном, який встановлює режим.
Тест
Подивіться, чи наступні сторінки все ще в порядку після редагування цього шаблону.
TemplateData
TemplateData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the TemplateData documentation for this template used by VisualEditor and other tools. Extension An infobox for a MediaWiki extension.
|
Maintenance: vulnerabilities, archived