Халип:Ombox/doc

Халип:Боковая навигационная таблица Этот мета-шаблон (с Халип:Tr/lang — «other pages message box») используется для формирования информационных сообщений в пространствах «Участник», «Википедия», «MediaWiki», «Шаблон», «Справка», и других, которые не покрываются шаблонами {{ambox}}, {{tmbox}}, или {{cmbox}}. Поэтому он не должен использоваться в статьях, страницах обсуждения, файлах и категориях.

Этот шаблон подобен шаблону {{ambox}} и использует большинство его параметров.

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

Единственный обязательный параметр — text. Простое использование:

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

Расширенное использование:

{{ombox
| type      = style
| image     = [[Файл:Emblem-question-yellow.svg|40px]]
| style     = width: 400px; 
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = Необычный текст.
}}

Параметры

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

{{ombox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Файл:Some image.svg|40px]]
| imageright = [[Файл:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| text  = The message body text. 
| small = {{{small|}}} / yes
| smallimage = none / [[Файл:Some image.svg|30px]]
| smallimageright = none / [[Файл:Some image.svg|30px]]
| smalltext  = A shorter message body text.
}}

type

Параметр определяет тип предупреждения. Примеры:

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

image

Параметр предназначен для вставки предупреждения («иконки») в формате [[Файл:Some image.svg|40px]]. Размер изображения по умолчанию — 40px, но можно задать и произвольный размер. Если параметр image не задан, то используется значок по умолчанию в зависимости от того, что задано в параметре type. Пример:

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

Если параметру присвоено значение none, то значок не отображается.

imageright

Параметр предназначен для вставки предупреждения («иконки») в формате [[Файл:Some image.svg|40px]]. Размер по умолчанию — 40px, но можно задать и произвольный размер. Если параметр imageright не задан, то значок справа не показывается. Например:

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

style

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

style = margin-bottom: 0.5em;

textstyle

Дополнительный параметр стиля CSS для содержимого параметра text. Пример:

textstyle = text-align: center;

text

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

Параметры миниатюризации

small

yes — создает маленькое окно сообщения, распологающееся к правому краю страницы. Этот параметр также уменьшает значок по умолчанию. Обратите внимание, что данные, переданные в параметрах smallimage, smallimageright и smalltext, используются только если small=yes. Чтобы производный шаблон понимал параметр small, используйте следующий код:

small = {{{small|}}}

smallimage

Если параметр smallimage не задан, то используется параметр image. Если параметр image также пустой, то используется маленький значок по умолчанию. Размер по умолчанию — 20px для сообщений в одну строку и до 25px в ширину для двух строк текста. Переопределяет значение параметра image, когда small=left. Если параметру присвоено значение none, то значок не отображается. Пример:

smallimage = [[Файл:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]

smallimageright

Если параметр smallimageright не задан, то используется параметр imageright. Если параметр imageright также пустой, то используется маленький значок по умолчанию. Переопределяет значение параметра imageright, когда small=yes. Если параметру присвоено значение none, то значок не отображается. Пример:

smallimageright = [[Файл:Nuvola apps bookcase.png|30px|alt=Three stacked books]]

smalltext

Краткий вариант текста сообщения. Если параметр smalltext не задан, то используется параметр text.

Примеры использования

Примеры использования в сообщениях типа «notice».

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

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

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

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

Шаблон вызывает {{ombox/core}}, содержащий весь исполняемый код для {{ombox}}, когда как сам {{ombox}} занимается предварительной обработкой параметров, тем самым упрощая {{ombox/core}}.

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