Модуль:Message box/документація

Це сторінка документації для Модуль:Message box

Це підсторінка документації шаблону {{Message box}}.
Вона містить інформацію про використання, категорії та інші дані, які не є частиною шаблону.

Цей модуль позначено як К:такий, що потребує захищеного статусу (2). Завершені модулі використовуються в дуже великій кількості статей, або часто використовуються як підстановки. Позаяк акти вандалізму або помилки можуть вплинути на багато сторінок і навіть незначне редагування призведе до істотного навантаження на сервери, вони підлягають захисту від редагувань.

Цей модуль залежить від наступних модулів:

Цей модуль використовує TemplateStyles:

Це метамодуль, що впроваджує шаблони контейнерів повідомлень {{mbox}}, {{ambox}}, {{cmbox}}, {{fmbox}}, {{imbox}}, {{ombox}} та {{tmbox}}. Він призначений до використання з модулів Lua та не повинен використовуватися напряму на вікісторінках. Якщо ви хочете використати функціонал цього модуля з вікісторінки, то, будь ласка, натомість використайте окремий шаблон контейнерів повідомлень.

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

Щоб використати цей модуль з іншого модуля Lua, то спершу вам його потрібно завантажити.

local messageBox = require('Module:Message box')

Щоб створити контейнер повідомлень, то використайте функцію main. Вона приймає два параметри: перший — це тип вікна (як рядок), а другий — таблиця, що містить параметри контейнера повідомлень.

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- More parameters...
})

Доступно сім типів вікон:

Тип вікна	Шаблон	Мета
`mbox`	{{mbox}}	Для контейнерів повідомлень, що використовуються в кількох просторах назв
`ambox`	{{ambox}}	Для контейнерів повідомлень статей
`cmbox`	{{cmbox}}	Для контейнерів повідомлень категорій
`fmbox`	{{fmbox}}	Для контейнерів повідомлень інтерфейсу
`imbox`	{{imbox}}	Для контейнерів повідомлень простору Файл
`tmbox`	{{tmbox}}	Для контейнерів повідомлень сторінок обговорень
`ombox`	{{ombox}}	Для контейнерів повідомлень в інших просторах назв

Детальніше про доступні параметри, див. сторінку шаблону кожного типу контейнера.

Використання через #invoke

На додачу до функції main, цей модуль має окремі функції для кожного типу контейнера. Їх можна викликати, використавши код {{#invoke:Message box|mbox|...}}, {{#invoke:Message box|ambox|...}} тощо. Вони працюватимуть при виклику з інших модулів, але при цьому використовується код, що оброблює аргументи отримані з #invoke, тому їхній виклик є менш ефективним ніж виклик main.

Технічні деталі

Модуль використовує однаковий базовий код для кожного шаблону, що перераховані вище; різниця між ними налаштовується через використання даних з Модуль:Message box/configuration. Ось різні конфігураційні опції та що вони означають:

types — таблиця, що містить дані, які використовуються параметром type контейнерів повідомлень. Ключі таблиці є значеннями, що можуть бути передані параметру type, а значення таблиці є таблицями, що містять клас і зображення, що використовується цим типом контейнера.
default — тип, який бути використано, якщо не було передано жодного значення до параметра type або якщо вказано недійсне значення
showInvalidTypeError — задає чи показувати помилку, коли передане значення до параметра type є недійсним.
allowBlankParams — зазвичай, пусті значення видаляються з параметрів, що передані модулю. Однак, пробіл (Шаблон:Lang) зберігається для параметрів, що включені до таблиці allowBlankParams.
allowId — чи можливо встановити атрибут «id» до тегу таблиці html.
allowSmall — чи можливо створити малу версію контейнера повідомлення через «small=yes».
smallParam — користувацька назва для параметра small. Наприклад, якщо встановлено «left», то ви можете створити малий контейнер повідомлення, використавши «small=left».
smallClass — клас для малих вікна повідомлень.
substCheck — чи виконувати перевірку на subst, чи ні.
classes — масив класів для використання з вікном повідомлень.
usePlainlinksParam — чи дозволяти вимкнення класу plainlinks, використавши «plainlinks=no».
imageEmptyCell — чи використовувати пусту комірку <td>...</td>, якщо не встановлено зображення. Це використовується, щоб зберегти пропуск для контейнерів повідомлень з шириною менше ніж 100% екрану.
imageEmptyCellStyle — чи повинно застосовуватися стильове оформлення для пустих комірок зображення.
imageCheckBlank — чи «image=blank» призводить того, що жодне зображення не відображається.
imageSmallSize — зазвичай, зображенням, що використовуються в малих контейнерах повідомлень, встановлюється розмір 30x30px. Цей параметр дозволяє встановлювати нестандартний розмір.
imageCellDiv — чи огортати зображення в div задля використання максимального розміру зображення.
useCollapsibleTextFields — чи використовувати текстові поля, що можуть приховуватися, наприклад, «issue», «fix», «talk» тощо. Зараз використовується лише в ambox.
imageRightNone — чи «imageright=none» призводить того, що жодне зображення не відображається з правого боку контейнера повідомлення.
sectionDefault — стандартна назва для параметра «section». Залежить від useCollapsibleTextFields.
allowMainspaceCategories — дозволяти категоризацію в основному просторі.
templateCategory — назва категорії, що розміщується на сторінці шаблону.
templateCategoryRequireName — чи параметр name є обов'язковим для відображення категорії шаблону.
templateErrorCategory — назва помилки категорії, що використовується на сторінці шаблону.
templateErrorParamsToCheck — масив назв параметрів для перевірки. Якщо вони відсутні, то templateErrorCategory застосовується до сторінки шаблону.