Шаблон:Ambox/doc

З пляцоўкі Вікіслоўнік
Jump to navigation Jump to search
Дакументацыя Гэта дакументацыя для шаблона Ambox.
Мета-шаблоны
окон сообщений
{{ambox}} (о)
{{cmbox}} (о)
{{ombox}} (о)
{{tmbox}} (о)
{{fmbox}} (о)

Этот мета-шаблон используется для формирования информационных сообщений в пространстве статей (article message box), таких как {{wikify}}. Шаблон позволяет задать различные цвета окна сообщения, вид значка и прочее.

Использование[правіць]

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

{{ambox | text = Текст сообщения.}}


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

{{ambox
| subst      = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
| type       = style
| small      = left
| image      = [[File:Emblem-question-yellow.svg|40px|alt=Вопросительный знак]]
| smallimage = [[File:Emblem-question-yellow.svg|20px|alt=Вопросительный знак]]
| textstyle  = color: red; font-weight: bold; font-style: italic;
| text       = текст для сообщений
| smalltext  = текст для миниатюрных сообщений
| date       = {{{date|}}}
| category   = имя категории 
}}

Типы информационных сообщений в основном пространстве[правіць]

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

Другие значки[правіць]

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

Дополнительно[правіць]

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

Параметры[правіць]

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

{{Ambox
| name        = Название шаблона без имени пространства Шаблон:
| subst       = <includeonly>{{ifsubst|SUBST}}</includeonly>
| type        = speedy / delete / content / style / notice / move / protection
| image       = none / [[File:...|40px|...]]
| imageright  = [[File:...|40px|...]]
| class       = CSS класс 
| style       = CSS стиль 
| textstyle   = CSS стиль текста
| text        = текст сообщения
| small       = {{{small|}}} / left
| smallimage  = none / [[File:...|20px|...]]
| smallimageright = none / [[File:...|20px|...]]
| smalltext   = текст миниатюрного сообщения
| category    = категория
}}

subst Этот параметр нужно использовать только для определения шаблонов которые не должны использоваться подстановкой. Страницы с неверной подстановкой помещаются в категорию Страницы с некорректной подстановкой шаблонов

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

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

Параметры категоризации[правіць]

  • category - название категории

Параметры миниатюризации[правіць]

Миниатюрные сообщения предназначены для заголовков секций. Обычно они должны содержать одну или две с строки.

small

left = Создает маленькое окно сообшение выравненное слева. Этот параметр также уменьшает значок по умолчанию. Обратите внимание, что данные переданные в параметрах smallimage, smallimageright и smalltext используются только если "small=left". Чтобы производный шаблон понимал параметр small используйте следующий код:
small = {{{small|}}}
другое, включа пустой и отсутсвующий параметр = Окно сообщение обычного размера. Игнорируются параметры smallimage, smallimageright and smalltext.

smallimage

нет параметра = если параметр smallimage не задан, то опять используется параметр image. Если параметр image также пустой, то используется маленький значок по умолчанию.
файл изображения = ссылка на файл использующая вики разметку. Обычно около 20px для сообщений в одну строку и до 25px в ширину для двух строк текста. Например:
smallimage = [[File:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]
none = обозначает, что не нужно отображать значок. Переопределяет заданное в параметре image, когда "small=left".

smallimageright

нет параметра = если параметр smallimageright не задан, то о пять используется параметр imageright. Если параметр imageright также пустой, то используется значок справа не показывается.
файл изображения = ссылка на файл использующая вики разметку. Около 20px - 25px в ширину справа. Например:
smallimageright = [[File:Nuvola apps bookcase.png|20px|alt=Three stacked books]]
одругое = все что вы хотите отобразить справа.
none = обозначает, что не нужно отображать значок справа. Переопределяет заданное в параметре imageright, когда "small=left".

smalltext

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

Технические детали[правіць]

Если вам необходимо использовать специальные символы внутри параметра text, то вам необходимо оборачивать их тэгом <nowiki></nowiki> :

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


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

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

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