Шаблон:Cmbox/документація

Це меташаблон {{Cmbox}} (англ. [C]ategory [m]essage [box]).

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

Цей шаблон використовується на 19 000+ сторінках і його зміни будуть дуже помітними. Будь ласка, перевіряйте будь-які зміни на підсторінках /пісочниці та /тестів цього шаблону, або у вашому особистому просторі, та зважайте на обговорення змін на сторінці обговорення перед їхнім впровадженням.

Цей шаблон використовує Lua: Модуль:Message box (пісочниця)

Меташаблони контейнерів повідомлень
шаблон	контекст
{{Ambox}}	стаття
{{Cmbox}}	категорія
{{Imbox}}	зображення
{{Tmbox}}	обговорення
{{Fmbox}}	верхній/нижній колонтитул
{{Ombox}}	інші сторінки
{{Mbox}}	автовизначення
{{Asbox}}	стаб статті
{{Dmbox}}	неоднозначність

Він використовується для утворення контейнерів повідомлення на зразок {{Category diffuse}} для сторінок категорій. він пропонує декілька різних кольорів, використовує стандартні зображення, якщо не визначено параметра зображення та має деякі інші властивості.

Цей шаблон працює майже так само як і {{Ambox}} та використовує такі ж параметри.

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

Простий приклад використання:

{{cmbox | text = Деякий текст.}}

Деякий текст.

Складний приклад:

{{cmbox
| type      = style
| image     = [[Файл:Emblem-question-yellow.svg|40пкс]]
| style     = width: 400пкс;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = Текст тіла повідомлення.
}}

Текст тіла повідомлення.

Типи контейнерів повідомлень категорій

Наступні приклади використовують різні параметри type, але не використовують параметри зображень, таким чином, вони використовують зображення за замовчуванням для кожного типу.

type=speedy – Шаблони швидкого вилучення, такі як {{db-c1}}.

type=delete – Шаблони вилучення, такі як {{cfd}}.

type=content – Основні застереження та проблеми, такі як {{Categorization of people disputed}}.

type=style – Незначні попередження і проблеми, такі як {{Underpopulated category}}.

type=notice – Сповіщення і повідомлення будь-якого роду, як постійні так і тимчасові.

type=move – Повідомлення та пропозиції переміщення, злиття та розділення, такі як {{Category redirect}}.

type=protection – Шаблони захисту, такі як {{pp}} коли показується на сторінці категорії.

Інші зображення

Стандартні зображення, показані вище, в основному використовуються для зручності. У багатьох випадках зручніше використовувати конкретніші зображення. Ці приклади використовують параметр image для визначення зображення, відмінного від стандартного.

type = style image = [[Файл:Sub-arrows.svg|40пкс]] Це зображення використовується для {{Very large}} та {{Category diffuse}}.

type = move image = [[Файл:Redirect arrow.svg|52пкс]] Це зображення використовується для {{Category redirect}}.

Спеціальні

Деякі інші комбінації параметрів.

Без заданого типу та зображення (стандарт)

Без заданого типу та image=none – Не використовується зображення, а text використовує весь простір контейнеру повідомлення.

image = [[Файл:Gnome globe current event.svg|42пкс]] imageright = [[Файл:Nuvola apps bookcase.svg|40пкс]]

Ця категорія перераховує статті про поточні та нещодавні космічні польоти. Вона наповнюється шаблоном {{Current spaceflight}}.

Параметри

Перелік усіх параметрів:

{{cmbox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Файл:Some image.svg|40пкс]]
| imageright = [[Файл:Some image.svg|40пкс]]
| class = Довільний клас CSS для застосування у контейнері
| style = CSS значення
| textstyle = CSS значення
| text  = Тіло тексту повідомлення.
}}

type

Якщо параметр type не задано, шаблон приймає тип notice. Це означає, що він матиме блакитний фон.

image

No parameter = Якщо параметр image не задано, шаблон використовує стандартне зображення. Яке стандартне зображення буде використано, залежить від параметру type.

An image = Повинно бути зображенням із звичайним описом вікі. Ширина у 40пкс - 50пкс зазвичай підходить, але залежить від співвідношення сторін зображення (але контейнер повідомлення може приймати зображення будь-якого розміру).

Наприклад: image = [[Файл:Sub-arrows.svg|40пкс]]

none = Означає, що зображення не використовується.

imageright

No parameter = Якщо параметр imageright не задано, зображення з правого боку не буде.

An image = Повинно бути зображенням із звичайним описом вікі. Ширина у 40пкс - 50пкс зазвичай підходить, але залежить від співвідношення сторін зображення (але контейнер повідомлення може приймати зображення будь-якого розміру).

Наприклад: imageright = [[Файл:Nuvola apps bookcase.png|40пкс]]

Anything = Будь-який інший об'єкт, який ви бажаєте розмістити з правої сторони.

style

Необов'язкове значення CSS, що використовується для усієї таблиці контейнера повідомлення. Без лапок " ".

Наприклад: style = margin-bottom: 0.5em;

textstyle

Необов'язкове значення CSS, що використовується для комірки тексту.

Наприклад: textstyle = text-align: center;

text

Тіло тексту повідомлення.

Технічні подробиці

Якщо вам необхідно використовувати спеціальні символи у тексті параметрів, вам необхідно робити це таким чином:

{{cmbox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are. 
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. 
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}

Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}.

Цей шаблон використовує класи cmbox CSS у MediaWiki:Common.css для більшості свого оформлення, таким чином, він повністю підтримує скіни.

Внутрішньо цей меташаблон використовує для табличного коду розмітку HTML замість вікірозмітки. Це звичайний спосіб для створення меташаблонів, оскільки вікіпрозмітка має декілька недоліків. Наприклад, вона ускладнює використання парсерних функцій та спеціальних символів у параметрах.

Стандартні зображення цього меташаблону мають формат png замість svg. Основною причиною є те, що деякі старіші браузери мають проблеми із прозорим фоном, що утворює MediaWiki для svg зображень. Зображення png у цьому випадку мають гарну оптимізацію кольору прозорого фону, і таким чином вони добре виглядають у всіх браузерах. Зауважте, що svg іконки програють у рендері тільки у старих браузерах, таким чином, така ручна оптимізація потрібна тільки для іконок найширшого використання.

Задля більшої кількості технічних подробиць дивіться сторінку обговорення. Оскільки шаблон працює майже так само як й інші mboxes, їх сторінки обговорення також можуть містити корисну інформацію (дивіться розділ Див. також нижче).

Див. також

До сімейства меташаблонів Модуль:Message box входить сім шаблонів:

• {{Ambox}}, для контейнерів повідомлень на сторінках статей.
• {{Cmbox}}, для контейнерів повідомлень на сторінках категорій.
• {{Imbox}}, для контейнерів повідомлень на сторінках файлів (зображень).
• {{Tmbox}}, для контейнерів повідомлень на сторінках обговорень.
• {{Fmbox}}, для контейнерів повідомлень у верхньому/нижньому колонтитулі сторінки.
• {{Ombox}}, для контейнерів повідомлень на сторінках інших типів.
• {{Mbox}}, для контейнерів повідомлень, що використовуються у різних просторах назв та змінюють свій вигляд відповідно.

Тісно пов'язані меташаблони:

• {{Asbox}}, для контейнерів повідомлень на сторінках стабів статей.
• {{Dmbox}}, для контейнерів повідомлень на сторінках неоднозначностей або визначеного індексу.
• {{Ivmbox}}, простий контейнер, повної ширини, із заданим фоном кольору слонової кістки, призначений для оформлення важливих повідомлень або нагадувань.