Модуль:Documentation/документація
Цей модуль Lua використовується в MediaWiki:Scribunto-doc-page-show та MediaWiki:Scribunto-doc-page-does-not-exist. Його зміни можуть призвести до миттєвих змін у користувацькому інтерфейсі Вікіпедії. Для уникнення великомасштабних збоїв, будь-які зміни спочатку потрібно перевірити на підсторінках /пісочниці та /тестів цього модуля, або у вашій пісочниці модуля. Потім перевірені зміни можуть бути впроваджені на цій сторінці єдиним редагуванням. Будь ласка, обговорюйте будь-які зміни на сторінці обговорення перед їхнім впровадженням. |
Цей модуль позначено як К:такий, що потребує захищеного статусу (64). Завершені модулі використовуються в дуже великій кількості статей, або часто використовуються як підстановки. Позаяк акти вандалізму або помилки можуть вплинути на багато сторінок і навіть незначне редагування призведе до істотного навантаження на сервери, вони підлягають захисту від редагувань. |
Цей модуль залежить від наступних модулів: |
Цей модуль використовує TemplateStyles: |
Цей модуль відображає зелене поле, що містить документацію для шаблонів, модулів Lua або інших сторінок. Його викликає шаблон {{документація}}.
Звичайне використання
[ред. код]Для більшості випадків, ви повинні використовувати шаблон {{документація}}; детальніше про інструкції про використання та параметри, будь ласка, дивіться сторінку цього шаблону.
Використання в інших модулях
[ред. код]Щоб використати цей модуль з іншого модуля Lua, спершу його завантажте через require
:
local documentation = require('Module:Documentation').main
Потім ви можете просто викликати його, використавши таблицю аргументів.
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}
Детальніше про інструкції про використання та список параметрів, будь ласка, зверніться до документації шаблону.
Портування до інших вікі
[ред. код]Модуль має конфігураційний файл в Модуль:Documentation/config, який призначений для забезпечення легкого перекладу і портування до інших вікі. Детальніше, будь ласка, дивіться коментарі в коді на сторінці config. Якщо ви маєте запитання або вам потрібна функція, яка на поточний час не реалізована, то будь ласка, залишіть повідомлення на Template talk:Documentation, щоб звернути увагу розробника.
Повідомленнями, які повинні бути зміненні, щоб відображати документацію шаблону/модуля вгорі сторінки модуля, є MediaWiki:Scribunto-doc-page-show та MediaWiki:Scribunto-doc-page-does-not-exist.
Це сторінка документації для Модуль:Documentation