Шаблон:cmbox/doc

Гэта дакументацыя для шаблона cmbox.

Этот мета-шаблон используется для формирования информационных сообщений на страницах пространства категорий. Шаблон позволяет задать различные цвета окна сообщения, вид значка и прочее.

Использование

Простое использование:

{{cmbox | text = Обычный текст. }}

Обычный текст.

Сложное использование:

{{cmbox
| type      = style
| image     = [[Файл:Emblem-question-yellow.svg|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

The message body text.

Типы информационных сообщений в категориях

Следующие примеры используют различные значения параметра type, но не меняют параметры отображения значка (иконки), поэтому везде отображается картинка по умолчанию.

type=speedy — в шаблонах быстрого удаления категории.

type=delete — в шаблонах удаления категории.

type=content — важные предупреждения и предостережения.

type=style — обычные предупреждения и предостережения.

type=notice — информационные сообщения, постоянные и временные.

type=move — сообщения о перемещении, слиянии и разделении.

type=protection — сообщения о защите страницы.

Другие значки

Значок по умолчанию добавлен для удобства. В большинстве случаев целесообразнее более конкретно указывать вид значка. Ниже показаны несколько примеров, поясняющих как использовать параметр image для отображения других значков.

type = style image = [[Файл:Sub-arrows.svg|40px]] Большой значок.

type = move image = [[Файл:Redirect arrow.svg|52px]] Ещё больше.

Дополнительно

Примеры использования других параметров и их комбинаций.

Не заданы параметры type и image (по умолчанию)

Не заданы параметр type и image=none – Значок не показывается и текст занимает всю ширину окна сообщения.

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

This category lists articles about current and recent spaceflights.

Параметры

Список всех параметров:

{{cmbox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Файл:Some image.svg|40px]]
| imageright = [[Файл:Some image.svg|40px]]
| class = A custom CSS class to apply to the box
| style = CSS values
| textstyle = CSS values
| text  = The message body text. 
}}

type

нет параметра = если параметр type не задан, то используется значение по умолчанию notice (голубой фон).

image

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

файл изображения = ссылка на файл использующая вики разметку. Размер подгоняется под 40px — 50px в ширину в зависимости от соотношения сторон в оригинале. (Но можно задать и произвольный размер.) Например:

image = [[Файл:Sub-arrows.svg|40px]]

none = обозначает, что не нужно отображать значок.

imageright

нет параметра = если параметр imageright не задан, то значок справа не показывается.

файл изображения = ссылка на файл использующая вики разметку. Размер подгоняется под 40px — 50px в ширину в зависимости от соотношения сторон в оригинале. (Но можно задать и произвольный размер.) Например:

imageright = [[Файл:Nuvola apps bookcase.png|40px]]

одругое = все что вы хотите отобразить справа.

style

Дополнительный параметр стиля CSS для всей таблицы. Например:

style = margin-bottom: 0.5em;

textstyle

Дополнительный параметр стиля CSS для текстовой ячейки. Например:

textstyle = text-align: center;

text

Текст сообщения.

Технические детали

Если вам необходимо использовать специальные символы внутри параметра text, то вам необходимо заменять их ESC-последовательностями :

{{cmbox
| text  = <div>
Здесь знак равенства = открывающая и закрывающая фигурные скобки { }.  
А здесь знак разделения параметров {{!}} и две закрывающие фигурные скобки <nowiki>}}</nowiki>. 
А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>.
</div>
}}

Здесь знак равенства = открывающая и закрывающая фигурные скобки { }. А здесь знак разделения параметров | и две фигурные скобки }}. А здесь знак разделения параметров перед двумя закрывающими фигурными скобками |}}.

Этот шаблон использует cmbox CSS-классы в MediaWiki:Common.css влияющие на его внешний вид, то есть он полностью перенастраиваемый.

Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование функций парсера и специальных символов в параметрах.