Шаблон:Ombox/doc
Этот шаблон используется на многих страницах, поэтому изменения в нём будут заметны многим. Пожалуйста, протестируйте любые изменения в песочнице или на вашей личной подстранице. Рассмотрите возможность обсуждения изменений на странице обсуждения или форуме перед их внесением. |
Прежде чем вносить какие-либо изменения в данный шаблон, просьба оттестировать их в /песочнице и проверить результат на странице с /контрольными примерами. Изменения могут быть внесены после этого в данный шаблон всего одной правкой. |
Этот шаблон реализован на основе Lua с использованием модуля Message box. |
Этот мета-шаблон (с англ. — «other pages message box») используется для формирования информационных сообщений в пространствах «Участник», «Википедия», «MediaWiki», «Шаблон», «Справка», и других, которые не покрываются шаблонами {{ambox}}, {{tmbox}}, или {{cmbox}}. Поэтому он не должен использоваться в статьях, страницах обсуждения, файлах и категориях.
Этот шаблон подобен шаблону {{ambox}} и использует большинство его параметров.
Использование
Единственный обязательный параметр — <syntaxhighlight lang="text" class="" id="" style="" inline="1">text</syntaxhighlight>. Простое использование:
{{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
- Параметр определяет тип предупреждения. Примеры:
<syntaxhighlight lang="text" class="" id="" style="" inline="1">type=speedy</syntaxhighlight> — предупреждение о выставлении на быстрое удаление. |
<syntaxhighlight lang="text" class="" id="" style="" inline="1">type=delete</syntaxhighlight> — предупреждение о выставлении на удаление. |
<syntaxhighlight lang="text" class="" id="" style="" inline="1">type=content</syntaxhighlight> — важное предупреждение или предостережение. |
<syntaxhighlight lang="text" class="" id="" style="" inline="1">type=style</syntaxhighlight> — обычное предупреждение или предостережение. |
<syntaxhighlight lang="text" class="" id="" style="" inline="1">type=notice</syntaxhighlight> — информационное сообщение. |
<syntaxhighlight lang="text" class="" id="" style="" inline="1">type=move</syntaxhighlight> — сообщение о перемещении, слиянии или разделении. |
<syntaxhighlight lang="text" class="" id="" style="" inline="1">type=protection</syntaxhighlight> — сообщение о защите страницы. |
- Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">type</syntaxhighlight> не задан, то используется значение по умолчанию (notice — голубой фон).
image
- Параметр предназначен для вставки предупреждения («иконки») в формате
[[Файл:Some image.svg|40px]]
. Размер изображения по умолчанию — 40px, но можно задать и произвольный размер. Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">image</syntaxhighlight> не задан, то используется значок по умолчанию в зависимости от того, что задано в параметре type. Пример:image = [[Файл:Sub-arrows.svg|40px]]
- Если параметру присвоено значение <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>, то значок не отображается.
imageright
- Параметр предназначен для вставки предупреждения («иконки») в формате
[[Файл:Some image.svg|40px]]
. Размер по умолчанию — 40px, но можно задать и произвольный размер. Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">imageright</syntaxhighlight> не задан, то значок справа не показывается. Например:imageright = [[Файл:Nuvola apps bookcase.png|40px]]
style
- Дополнительный параметр стиля CSS для всего шаблона. Пример:
style = margin-bottom: 0.5em;
textstyle
- Дополнительный параметр стиля CSS для содержимого параметра <syntaxhighlight lang="text" class="" id="" style="" inline="1">text</syntaxhighlight>. Пример:
textstyle = text-align: center;
text
- Текст сообщения.
Параметры миниатюризации
small = yes |
type = style small = yes |
small
- <syntaxhighlight lang="text" class="" id="" style="" inline="1">yes</syntaxhighlight> — создает маленькое окно сообщения, распологающееся к правому краю страницы. Этот параметр также уменьшает значок по умолчанию. Обратите внимание, что данные, переданные в параметрах <syntaxhighlight lang="text" class="" id="" style="" inline="1">smallimage</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">smallimageright</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">smalltext</syntaxhighlight>, используются только если <syntaxhighlight lang="text" class="" id="" style="" inline="1">small=yes</syntaxhighlight>. Чтобы производный шаблон понимал параметр small, используйте следующий код:
small = {{{small|}}}
small = yes image = [[Файл:Replacement filing cabinet.svg|50px]] smallimage = [[Файл:Replacement filing cabinet.svg|32px]] |
smallimage
- Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">smallimage</syntaxhighlight> не задан, то используется параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">image</syntaxhighlight>. Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">image</syntaxhighlight> также пустой, то используется маленький значок по умолчанию. Размер по умолчанию — 20px для сообщений в одну строку и до 25px в ширину для двух строк текста. Переопределяет значение параметра <syntaxhighlight lang="text" class="" id="" style="" inline="1">image</syntaxhighlight>, когда <syntaxhighlight lang="text" class="" id="" style="" inline="1">small=left</syntaxhighlight>. Если параметру присвоено значение <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>, то значок не отображается. Пример:
smallimage = [[Файл:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]
small = yes imageright = [[Файл:Nuvola apps bookcase.png|50px]] smallimageright = none |
smallimageright
- Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">smallimageright</syntaxhighlight> не задан, то используется параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">imageright</syntaxhighlight>. Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">imageright</syntaxhighlight> также пустой, то используется маленький значок по умолчанию. Переопределяет значение параметра <syntaxhighlight lang="text" class="" id="" style="" inline="1">imageright</syntaxhighlight>, когда <syntaxhighlight lang="text" class="" id="" style="" inline="1">small=yes</syntaxhighlight>. Если параметру присвоено значение <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>, то значок не отображается. Пример:
smallimageright = [[Файл:Nuvola apps bookcase.png|30px|alt=Three stacked books]]
smalltext
- Краткий вариант текста сообщения. Если параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">smalltext</syntaxhighlight> не задан, то используется параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">text</syntaxhighlight>.
Примеры использования
Примеры использования в сообщениях типа «notice».
Не заданы параметры type и image. |
Не заданы параметр type и image=none. |
image = [[Файл:Gnome globe current event.svg|42px]] imageright = [[Файл:Nuvola apps bookcase.svg|40px]] |
Эта страница является частью правил и руководств русской Википедии. Изложенному здесь должны следовать все участники. Прежде чем редактировать, убедитесь, что вносимые изменения соответствуют консенсусу. Если есть сомнения, обсудите на форуме или странице обсуждения. |
В двух словах: Этот шаблон используется для отображения информационного сообщения на страницах, не являющихся статьёй, страницей обсуждения, файлом или категорией. |
Технические детали
Если вам необходимо использовать специальные символы внутри параметра text, то вам необходимо заменять их ESC-последовательностями:
{{ombox | text = <div> Здесь знак равенства =, открывающая и закрывающая фигурные скобки { }. А здесь знак разделения параметров {{!}} и две закрывающие фигурные скобки <nowiki>}}</nowiki>. А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>. </div> }}
Этот шаблон использует CSS-классы ombox
в MediaWiki:Common.css, влияющие на его внешний вид, то есть он полностью перенастраиваемый.
Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование функций парсера и специальных символов в параметрах.