Перейти к содержанию

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

Материал из Викитеки — свободной библиотеки


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

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

[править]

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

{{cmbox | text = Some text.}}


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

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

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

[править]

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

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

[править]

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

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

[править]

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

Параметры

[править]

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

{{cmbox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image: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 = [[Image:Sub-arrows.svg|40px]]
none = обозначает, что не нужно отображать значок.

imageright

нет параметра = если параметр imageright не задан, то значок справа не показывается.
файл изображения = ссылка на файл использующая вики разметку. Размер подгоняется под 40px - 50px в ширину в зависимости от соотношения сторон в оригинале. (Но можно задать и произвольный размер.) Например:
imageright = [[Image: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 вместо языка викиразметки. Так делается во всех мета-шаблонах, т.к. у вики-разметки есть ряд недостатков. Например, она затрудняет использование функций парсера и специальных символов в параметрах.

Файлы значков по умолчанию для этого мета-шаблона имеют формат png, а не svg. Основная причина в том, что у некоторых старых браузеров есть проблемы с отображением прозрачного фона, который подставляет MediaWiki движок для svg изображений. Все png изображение оптимизированы вручную и имеют прозрачный фон чтобы одинаково хорошо отображаться во всех браузерах. Обратите внимание, что svg значки выглядят плохо только в старых браузерах, поэтому такая ​​ручная оптимизация сделана только для наиболее часто использующихся иконок.