Шаблон:Ombox/doc: различия между версиями
Mansur700 (обсуждение | вклад) (Керла агӀо: «=== Лелор === Атта лелор: <pre> {{ombox | text = Гуттар йоза. }} </pre> {{ombox | text = Гуттар йоза. }} {{clear}}») |
Mansur700 (обсуждение | вклад) Нет описания правки |
||
Строка 1: | Строка 1: | ||
= | {{docpage}} | ||
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> | |||
{{Mbox templates|nocat=1}} | |||
Этот мета-шаблон ({{tr-en|'''o'''ther pages '''m'''essage '''box'''}}) используется для формирования информационных сообщений в пространствах «Участник», «Тептар», «MediaWiki», «Шаблон», «Справка», и других, которые не покрываются шаблонами {{t|ambox}}, {{t|tmbox}}, или {{t|cmbox}}. Поэтому он '''не должен''' использоваться в статьях, страницах обсуждения, файлах и категориях. | |||
Этот шаблон подобен шаблону {{t|ambox}} и использует большинство его параметров. | |||
=== Использование === | |||
Единственный обязательный параметр — {{code|text}}. Простое использование: | |||
<pre> | <pre> | ||
{{ombox | text = | {{ombox|text=Обычный текст.}} | ||
</pre> | </pre> | ||
{{ombox | text = | {{ombox|text=Обычный текст.}} | ||
{{clear}} | {{clear}} | ||
Расширенное использование: | |||
<pre> | |||
{{ombox | |||
| type = style | |||
| image = [[Файл:Emblem-question-yellow.svg|40px]] | |||
| style = width: 400px; | |||
| textstyle = color: red; font-weight: bold; font-style: italic; | |||
| text = Необычный текст. | |||
}} | |||
</pre> | |||
{{ombox | |||
| type = style | |||
| image = [[Файл:Emblem-question-yellow.svg|40px]] | |||
| style = width: 400px; | |||
| textstyle = color: red; font-weight: bold; font-style: italic; | |||
| text = Необычный текст. | |||
}} | |||
=== Параметры === | |||
Список всех параметров: | |||
<pre> | |||
{{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. | |||
}} | |||
</pre> | |||
'''type''' | |||
: Параметр определяет тип предупреждения. Примеры: | |||
{{ombox | |||
| type = speedy | |||
| text = {{code|type{{=}}speedy}} — предупреждение о выставлении на быстрое удаление. | |||
}} | |||
{{ombox | |||
| type = delete | |||
| text = {{code|type{{=}}delete}} — предупреждение о выставлении на удаление. | |||
}} | |||
{{ombox | |||
| type = content | |||
| text = {{code|type{{=}}content}} — важное предупреждение или предостережение. | |||
}} | |||
{{ombox | |||
| type = style | |||
| text = {{code|type{{=}}style}} — обычное предупреждение или предостережение. | |||
}} | |||
{{ombox | |||
| type = notice | |||
| text = {{code|type{{=}}notice}} — информационное сообщение. | |||
}} | |||
{{ombox | |||
| type = move | |||
| text = {{code|type{{=}}move}} — сообщение о перемещении, слиянии или разделении. | |||
}} | |||
{{ombox | |||
| type = protection | |||
| text = {{code|type{{=}}protection}} — сообщение о защите страницы. | |||
}} | |||
: Если параметр {{code|type}} не задан, то используется значение по умолчанию ('''notice''' — голубой фон). | |||
'''image''' | |||
: Параметр предназначен для вставки предупреждения («иконки») в формате <code><nowiki>[[Файл:Some image.svg|40px]]</nowiki></code>. Размер изображения по умолчанию — 40px, но можно задать и произвольный размер. Если параметр {{code|image}} не задан, то используется значок по умолчанию в зависимости от того, что задано в параметре '''type'''. Пример: | |||
:: <code><nowiki>image = [[Файл:Sub-arrows.svg|40px]]</nowiki></code> | |||
: Если параметру присвоено значение {{code|none}}, то значок не отображается. | |||
'''imageright''' | |||
: Параметр предназначен для вставки предупреждения («иконки») в формате <code><nowiki>[[Файл:Some image.svg|40px]]</nowiki></code>. Размер по умолчанию — 40px, но можно задать и произвольный размер. Если параметр {{code|imageright}} не задан, то значок справа не показывается. Например: | |||
:: <code><nowiki>imageright = [[Файл:Nuvola apps bookcase.png|40px]]</nowiki></code> | |||
'''style''' | |||
: Дополнительный параметр стиля CSS для всего шаблона. Пример: | |||
:: <code>style = margin-bottom: 0.5em;</code> | |||
'''textstyle''' | |||
: Дополнительный параметр стиля CSS для содержимого параметра {{code|text}}. Пример: | |||
:: <code>textstyle = text-align: center;</code> | |||
'''text''' | |||
: Текст сообщения. | |||
==== Параметры миниатюризации ==== | |||
{{ombox | |||
| small = yes | |||
| text = small = yes | |||
}} | |||
{{ombox | |||
| type = style | |||
| small = yes | |||
| text = type = style <br> small = yes | |||
}} | |||
'''small''' | |||
: {{code|yes}} — создает маленькое окно сообщения, распологающееся к правому краю страницы. Этот параметр также уменьшает значок по умолчанию. Обратите внимание, что данные, переданные в параметрах {{code|smallimage}}, {{code|smallimageright}} и {{code|smalltext}}, используются только если {{code|small{{=}}yes}}. Чтобы производный шаблон понимал параметр small, используйте следующий код: | |||
:: <code><nowiki>small = {{{small|}}}</nowiki></code> | |||
{{ombox | |||
| small = yes | |||
| image = [[Файл:Replacement filing cabinet.svg|50px]] | |||
| smallimage = [[Файл:Replacement filing cabinet.svg|32px]] | |||
| text = | |||
small = yes <br> image = <nowiki>[[Файл:Replacement filing cabinet.svg|50px]]</nowiki> <br> smallimage = <nowiki>[[Файл:Replacement filing cabinet.svg|32px]]</nowiki> | |||
}} | |||
'''smallimage''' | |||
: Если параметр {{code|smallimage}} не задан, то используется параметр {{code|image}}. Если параметр {{code|image}} также пустой, то используется маленький значок по умолчанию. Размер по умолчанию — 20px для сообщений в одну строку и до 25px в ширину для двух строк текста. Переопределяет значение параметра {{code|image}}, когда {{code|small{{=}}left}}. Если параметру присвоено значение {{code|none}}, то значок не отображается. Пример: | |||
:: <code><nowiki>smallimage = [[Файл:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]</nowiki></code> | |||
{{ombox | |||
| small = yes | |||
| imageright = [[Файл:Nuvola apps bookcase.png|50px]] | |||
| smallimageright = none | |||
| text = | |||
small = yes <br> imageright = <nowiki>[[Файл:Nuvola apps bookcase.png|50px]]</nowiki> <br> smallimageright = none | |||
}} | |||
'''smallimageright''' | |||
: Если параметр {{code|smallimageright}} не задан, то используется параметр {{code|imageright}}. Если параметр {{code|imageright}} также пустой, то используется маленький значок по умолчанию. Переопределяет значение параметра {{code|imageright}}, когда {{code|small{{=}}yes}}. Если параметру присвоено значение {{code|none}}, то значок не отображается. Пример: | |||
:: <code><nowiki>smallimageright = [[Файл:Nuvola apps bookcase.png|30px|alt=Three stacked books]]</nowiki></code> | |||
'''smalltext''' | |||
: Краткий вариант текста сообщения. Если параметр {{code|smalltext}} не задан, то используется параметр {{code|text}}. | |||
=== Примеры использования === | |||
Примеры использования в сообщениях типа «notice». | |||
{{ombox | |||
| text = Не заданы параметры type и image. | |||
}} | |||
{{ombox | |||
| image = none | |||
| text = Не заданы параметр type и '''image=none'''. | |||
}} | |||
{{ombox | |||
| image = [[Файл:Gnome globe current event.svg|42px]] | |||
| imageright = [[Файл:Nuvola apps bookcase.svg|40px]] | |||
| text = image = <nowiki>[[Файл:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[Файл:Nuvola apps bookcase.svg|40px]]</nowiki> | |||
}} | |||
{{ombox | |||
| type = notice | |||
| image = [[Файл:Yes_check.svg|30px]] | |||
| imageright = | |||
| text = '''Эта страница является частью [[:Категория:Тептар:Правила и руководства|правил и руководств]] русской Википедии.'''<br> | |||
Изложенному здесь должны следовать все участники. Прежде чем редактировать, убедитесь, что вносимые изменения соответствуют [[Тептар:Консенсус|консенсусу]]. Если есть сомнения, обсудите на [[Тептар:Форум/Правила|форуме]] или [[{{TALKPAGENAME}}|странице обсуждения]]. | |||
}} | |||
{{ombox | |||
| type = notice | |||
| image = [[Файл:Nutshell.png|30px]] | |||
| text = | |||
'''В двух словах:''' Этот шаблон используется для отображения информационного сообщения на страницах, '''не являющихся''' статьёй, страницей обсуждения, файлом или категорией. | |||
}} | |||
=== Технические детали === | |||
Если вам необходимо использовать специальные символы внутри параметра '''text''', то вам необходимо заменять их ESC-последовательностями: | |||
<pre> | |||
{{ombox | |||
| text = <div> | |||
Здесь знак равенства =, открывающая и закрывающая фигурные скобки { }. | |||
А здесь знак разделения параметров {{!}} и две закрывающие фигурные скобки <nowiki>}}</nowiki>. | |||
А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>. | |||
</div> | |||
}} | |||
</pre> | |||
{{ombox | |||
| text = <div> | |||
Здесь знак равенства =, открывающая и закрывающая фигурные скобки { }. | |||
А здесь знак разделения параметров {{!}} и две закрывающие фигурные скобки <nowiki>}}</nowiki>. | |||
А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>. | |||
</div> | |||
}} | |||
Этот шаблон использует [[CSS]]-классы <code>ombox</code> в [[MediaWiki:Common.css]], влияющие на его внешний вид, то есть он полностью перенастраиваемый. | |||
Шаблон вызывает {{t|ombox/core}}, содержащий весь исполняемый код для {{t|ombox}}, когда как сам {{t|ombox}} занимается предварительной обработкой параметров, тем самым упрощая {{t|ombox/core}}. | |||
Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование [[ТП:ПАРС|функций парсера]] и специальных символов в параметрах. | |||
<includeonly> | |||
<!-- CATEGORIES HERE, THANKS --> | |||
[[Категория:Шаблоны:Для шаблонов]] | |||
</includeonly> |
Версия от 07:28, 18 июня 2020
Этот мета-шаблон (с англ. — «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=speedy — предупреждение о выставлении на быстрое удаление. |
type=delete — предупреждение о выставлении на удаление. |
type=content — важное предупреждение или предостережение. |
type=style — обычное предупреждение или предостережение. |
type=notice — информационное сообщение. |
type=move — сообщение о перемещении, слиянии или разделении. |
type=protection — сообщение о защите страницы. |
- Если параметр
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 |
type = style small = yes |
small
yes
— создает маленькое окно сообщения, распологающееся к правому краю страницы. Этот параметр также уменьшает значок по умолчанию. Обратите внимание, что данные, переданные в параметрахsmallimage
,smallimageright
иsmalltext
, используются только еслиsmall=yes
. Чтобы производный шаблон понимал параметр small, используйте следующий код:small = {{{small|}}}
small = yes image = [[Файл:Replacement filing cabinet.svg|50px]] smallimage = [[Файл:Replacement filing cabinet.svg|32px]] |
smallimage
- Если параметр
smallimage
не задан, то используется параметрimage
. Если параметрimage
также пустой, то используется маленький значок по умолчанию. Размер по умолчанию — 20px для сообщений в одну строку и до 25px в ширину для двух строк текста. Переопределяет значение параметраimage
, когдаsmall=left
. Если параметру присвоено значениеnone
, то значок не отображается. Пример:smallimage = [[Файл:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]
small = yes imageright = [[Файл:Nuvola apps bookcase.png|50px]] smallimageright = none |
smallimageright
- Если параметр
smallimageright
не задан, то используется параметрimageright
. Если параметрimageright
также пустой, то используется маленький значок по умолчанию. Переопределяет значение параметраimageright
, когдаsmall=yes
. Если параметру присвоено значениеnone
, то значок не отображается. Пример:smallimageright = [[Файл:Nuvola apps bookcase.png|30px|alt=Three stacked books]]
smalltext
- Краткий вариант текста сообщения. Если параметр
smalltext
не задан, то используется параметрtext
.
Примеры использования
Примеры использования в сообщениях типа «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, влияющие на его внешний вид, то есть он полностью перенастраиваемый.
Шаблон вызывает {{ombox/core}}, содержащий весь исполняемый код для {{ombox}}, когда как сам {{ombox}} занимается предварительной обработкой параметров, тем самым упрощая {{ombox/core}}.
Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование функций парсера и специальных символов в параметрах.