Модуль:Box-header/документація

Це підсторінка документації модуля Модуль:Box-header. Вона містить інформацію про використання, категорії та інший вміст, що не є частиною оригінальної сторінки модуля.

Цей модуль позначений як К:реліз, готовий до загального вжитку (130). Він досягнув стадії готовності й вважається, що вільний від помилок і може використовуватись всюди, де знадобиться. Його можна вживати на допоміжних сторінках та інших сторінках Вікіпедії як можливість для навчання новачків. Аби зменшити навантаження на сервери та некоректний показ сторінок, його можна вдосконалювати в рамцях чернеткового тестування[en], а не з застосуванням спроб і помилок.

Цей модуль залежить від наступних модулів: Модуль:Box-header/colours Модуль:Color contrast Модуль:Arguments (пісочниця)

Цей модуль створює заголовок розділу для вмісту контейнера. Він впроваджує {{box-header}}. Основним призначенням є використання в порталах, але також може використовуватися в інших місцях.

{{#invoke:Box-header|boxHeader}}

Для використання в шаблонах; викликає _boxHeader з параметрами, переданими до шаблону як аргументи.

{{#invoke:Box-header|_boxHeader|args}}

Для використання в модулях; створює заголовок контейнера (а також початок тіла контейнера). args є параметрами, що підтримуються шаблоном Шаблон:Box-header. (The output may need to be expanded, depending on the values in the args.)

{{#invoke:Box-header|autoColour}}

Для використання в шаблонах; викликає _autoColour з параметрами, переданими до шаблону як аргументи.

{{#invoke:Box-header|_autoColour|args}}

Для використання в модулях; визначає доречні кольори для заголовка контейнера, а тоді створює його, використовуючи _boxHeader. args є параметрами, що підтримуються шаблоном Шаблон:Box-header colour — такі ж самі як і для Шаблон:Box-header окрім тих, що зазначають кольори й назву. (The output may need to be expanded, depending on the values in the args.)