Шаблон:tmbox/doc

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

Этот мета-шаблон (talk page message box) используется для формирования информационных сообщений на страницах обсуждения. Этот шаблон вызывается другими шаблонами и определяет общую структуру и внешний вид сообщений, используемых на страницах обсуждения проекта. Его можно использовать непосредственно на странице обсуждения, чтобы показать однократное сообщение в том же формате, как другие шаблонные сообщения, но это скорее исключение (если сообщение является достаточно важным, чтобы отображаться в таком виде, лучше подумать о создании отдельного шаблона, чтобы он был легко доступен для других редакторов).

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

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

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

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

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

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

Типы сообщений на страницах обсуждения[правіць]

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


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

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

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

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

{{tmbox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Файл:Картинка.svg|40px]]
| imageright = [[Файл:Картинка.svg|40px]]
| style = Дополнительные параметры оформления.
| textstyle = Дополнительные параметры оформления сообщения.
| text  = Заголовок сообщения.
| text-small = Текст меньшего шрифта под заголовком.
| small = {{{small|}}} / yes
| smallimage = none / [[Файл:Картинка.svg|30px]]
| smallimageright = none / [[Файл:Картинка.svg|30px]]
| smalltext  = A shorter message body text.
}}

type

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

image

нет параметра = если параметр image не задан, то используется значок по умолчанию в зависимости от того что задано в параметре type.
файл изображения = ссылка на файл использующая вики разметку. Размер подгоняется под 40px — 50px в ширину в зависимости от соотношения сторон в оригинале. (Но можно задать и произвольный размер.) Например:
image = [[Файл:Sub-arrows.svg|40px]]
none = обозначает, что не нужно отображать значок.

imageright

нет параметра = если параметр imageright не задан, то значок справа не показывается.
файл изображения = ссылка на файл использующая вики разметку. Размер подгоняется под 40px — 50px в ширину в зависимости от соотношения сторон в оригинале. (Но можно задать и произвольный размер.) Например:
imageright = [[Файл:Nuvola apps bookcase.png|40px]]
одругое = все что вы хотите отобразить справа.

style

Дополнительный параметр стиля CSS для всей таблицы. Например:
style = margin-bottom: 0.5em;

textstyle

Дополнительный параметр стиля CSS для текстовой ячейки. Например:
textstyle = text-align: center;

text

Текст сообщения, можно использовать как заголовок сообщения при заданном параметре text-small

text-small

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

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

small

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

smallimage

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

smallimageright

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

smalltext

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

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

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

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

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

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

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