Шаблон:Fmbox/doc

Материал из Буквицы
Перейти к навигации Перейти к поиску
Мета-шаблоны
блоков сообщений

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

Этот шаблон подобен шаблону {{ambox}} и использует большинство его параметров. Основное его отличие в том, что он использует другие цвета и его ширина равна 100 % ширины страницы на которой он помещён.

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

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

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


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

{{fmbox
| type      = editnotice
| image     = [[Файл:Emblem-question-yellow.svg|40px]]
| style     = border: 1px solid #f4c430;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}

Типы сообщений сверху и снизу

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

Другие значки

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

Дополнительно

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

Параметры

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

{{fmbox
| type  = system / editnotice / warning
| image = none / [[Файл:Some image.svg|40px]]
| imageright = [[Файл:Some image.svg|40px]]
| id = CSS id
| class = CSS class names
| style = CSS values
| textstyle = CSS values
| text  = The message body text.
}}

type

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

image

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

imageright

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

id

Необязательный CSS-идентификатор сообщения. В основном используется для пометы сообщения, чтобы упростить определение его присутствия из javascript. Например:
id = sp-contributions-footer

class

Необязательное имя класса CSS сообщения. В основном используется для пометы сообщений одинакового типа, чтобы упростить настройку их вида. Например:
class = sp-contributions-footer

style

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

textstyle

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

text

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

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

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

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


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

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