Редактирование: Шаблон:Cmbox/doc

{{Docpage}}
{{High-use}}
{{Используйте песочницу}}
{{OnLua|Message box}}
{{Список шаблонов семейства Mbox|nocat=1}}

'''{{T|Cmbox}}''', название сокращенно от '''''c'''ategory '''m'''essage '''box''''' — меташаблон различных шаблонов-сообщений '''для категорий''', таких как шаблон {{Tl|Категория для распределения}}. Он предлагает несколько различных цветов, изображений и некоторых других функций.

Похож на шаблон {{Tl|Ambox}} и использует такие же параметры.

== Использование ==
<pre>
{{Cmbox
 | name         = 
 | subst        = <includeonly>{{Subst:проверка подстановки}}</includeonly>
 | type         = 
 | image        = 
 | text         = 
 | talk         = {{{talk|}}}
 | text-small   = 
 | date         = {{{date|}}}
 | cat          = 
 | all          = 
 | data-label-1 = Название атрибута "data-???" для JavaScript
 | data-value-1 = Значение атрибута "data-???" для JavaScript
 | data-label-2 = Название атрибута "data-???" для JavaScript
 | data-value-2 = Значение атрибута "data-???" для JavaScript
 | data-label-3 = Название атрибута "data-???" для JavaScript
 | data-value-3 = Значение атрибута "data-???" для JavaScript
}}<noinclude>{{Doc}}</noinclude>
</pre>
{{Начало скрытого блока|Заготовка со всем списком параметров}}
Не рекомендуется использовать данную заготовку, так как в обычном виде большинство параметров не используются.
<pre>{{Cmbox
| name            = 
| subst           = <includeonly>{{Subst:substcheck}}</includeonly>
| small           = {{{small|}}}
| type            = 
| image           = 
| imageright      = 
| smallimage      = 
| smallimageright = 
| class           = 
| style           = 
| textstyle       = 
| text            = 
| text-small      = 
| talk            = {{{talk|}}}
| date            = {{{date|}}}
| text            = 
| smalltext       = 
| plainlinks      = no
| removalnotice   = 
| cat             = 
| all             = 
| cat2            = 
| all2            = 
| cat3            = 
| all3            = 
}}<noinclude>{{Doc}}</noinclude></pre>
{{Конец скрытого блока}}

== Параметры ==

=== ''type'' ===
Типы меняют внешний вид шаблона:

{{Cmbox
| type = speedy
| text = type=<u>speedy</u> — в шаблонах быстрого удаления категории.
}}
{{Cmbox
| type = delete
| text = type=<u>delete</u> — в шаблонах удаления категории.
}}
{{Cmbox
| type = content
| text = type=<u>content</u> — важные предупреждения и предостережения.
}}
{{Cmbox
| type = style
| text = type=<u>style</u> — обычные предупреждения и предостережения.
}}
{{Cmbox
| type = notice
| text = type=<u>notice</u> — информационные сообщения, постоянные и временные.
}}
{{Cmbox
| type = move
| text = type=<u>move</u> — сообщения о перемещении, слиянии и разделении.
}}
{{Cmbox
| type = protection
| text = type=<u>protection</u> — сообщения о защите страницы.
}}

=== ''image'' ===
Этот параметр позволяет изменить картинку шаблона:

{{Cmbox
| type  = style
| image = [[Файл:Sub-arrows.svg|40px]]
| text  = type = style <br> image = <nowiki>[[Файл:Sub-arrows.svg|40px]]</nowiki> <br> Большой значок. 
}}
{{Cmbox
| type  = move
| image = [[Файл:Redirect arrow.svg|52px]]
| text  = type = move <br> image = <nowiki>[[Файл:Redirect arrow.svg|52px]]</nowiki> <br> Ещё больше. 
}}

=== Комбинации параметров ===
Более сложные варианты использования шаблона:

{{Cmbox
| text  = Не заданы параметры type и image (по умолчанию)
}}
{{Cmbox
| image = none
| text  =  Не заданы параметр type и '''image=none''' – Значок не показывается и текст занимает всю ширину окна сообщения.
}}
{{Cmbox
| 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>
}}
{{Cmbox
| image = [[Файл:Gnome globe current event.svg|42px]]
| imageright = [[Файл:Shuttle.svg|20px]]
| text  = '''This category lists articles about current and recent [[spaceflight]]s.'''
}}

=== ''image'' ===
Вы можете выбрать уникальное изображение для шаблона, использую параметр ''image''. Значение параметра {{Para|Image}} должно иметь тот же синтаксис, как и при вставке изображения в статью ([[Википедия:Иллюстрирование#Вставка файла в статью]]). В стандарте, ширина — 40-50px. Например:

* Для {{Tl|Категория для распределения}} указано изображение {{Para|Image|<nowiki>[[Изображение:Sub-arrows.svg|40px|link=|alt=]]</nowiki>}}:
{{Категория для распределения|date={{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY}}}}

Пожалуйста, учтите:
* Если изображение не указано, то оно будет зависеть от параметра ''type''. (Смотрите о параметре [[#type]] выше.)
* Если указано {{Para|Image|none}}, то никакое изображение выводится не будет, и текст займет всю площадь шаблона.
* Если изображение выполняет чисто декоративную функцию, '''а также''' находится в [[Википедия:Правила использования изображений#Лицензия|общественном достоянии]], удобство и [[:en:Wikipedia:Manual of Style/Accessibility|доступность]] использования шаблоны может быть улучшена с помощью подавления ссылки на файл с помощью добавления параметров {{Para|Link}} и {{Para|Alt}}, как показано выше.

=== ''text'', и ''text-small'' ===
Параметр ''text'' передает основной текст в шаблон. Постарайтесь сделать его как можно более кратким и понятным.

Параметр ''text-small'' показывает текст маленьким шрифт, не рекомендуем его использовать для файлов.

=== ''talk'' ===
Некоторые шаблоны-сообщения содержат ссылку на страницу обсуждения, и позволяют редактору уточнить заголовок необходимой секции для ссылки. Чтобы добиться такой функциональности, просто укажите при создании шаблона {{Para|Talk|<nowiki>{{{talk|}}}</nowiki>}}.

Примеры использования параметра редакторами:
* {{Para|Talk|ЗАГОЛОВОК СЕКЦИИ}} — ссылка отправит читателя в необходимую секцию на странице обсуждения статьи. Пример — {{Para|Talk|Foo}}.
* {{Para|Talk|ПОЛНОЕ НАЗВАНИЕ СТРАНИЦЫ ОБСУЖДЕНИЯ}} — шаблон выдаст ссылку на указанную страницу обсуждения (может содержать [[Википедия:Как править статьи#Ссылки, URL|ссылку на секцию]]), например {{Para|Talk|Обсуждение:Banana#Foo}}.

Примечания:
* При использовании этого параметра при создании шаблона, то ссылка на страницу обсуждения будет появляться и в самом шаблоне (для того, чтобы продемонстрировать функциональность), но на страницах она будет отображаться, только если параметр фактически указан.
* Чтобы быть уверенным, что ссылка на страницу обсуждения постоянно показывается, вы можете использовать следующую конструкцию: {{Para|Talk|<nowiki>{{{talk|#}}}</nowiki>}}.
* Строка не будет отображаться если ''страницы обсуждения статьи'', или ''указанной страницы обсуждения'' не существует, и неважно что вы укажете в параметре.

=== ''date'' ===
Установка параметра ''date'' сообщает мета-шаблону, что в шаблон-сообщение был установлен в этот день: устанавливается как редакторами, так и [[ВП:Боты|ботами]]. Отображается мелким шрифтов в конце дополнительного сообщения.

'''Обратите внимание''', возможны только следующие виды дат:
* 2022-05-14 (предпочтительно)
* 1 мая 2015
* 01 мая 2015
* [[mw:Help:Extension:ParserFunctions#.23time|Стандартные англоязычные даты]] для обработки <code><nowiki>{{#time: }}</nowiki></code>

Также указание этого параметра включает категоризацию по времени, если параметр ''[[#cat]]'' определен.

=== ''cat'' ===
Этот параметр определяет по-месячную категорию для статей. Если {{Para|Cat|КАТЕГОРИЯ}} тогда:
* статьи будут помещены в категорию '''Категория: КАТЕГОРИЯ с ДАТЫ''' если {{Para|Date|ДАТА}} указан.
* статьи будут помещены в категорию '''Категория: КАТЕГОРИЯ''' если дата не указана.

Например, для шаблона {{Tl|Маргинальные теории}} указана категория {{Para|cat|РуСказки:Статьи, подозреваемые в наличии оригинальных исследований}}, и поэтому статья с шаблоном {{Tcl|Маргинальные теории|2=date=12 января 2013}} будет помещена в категорию [[:Категория:РуСказки:Статьи, подозреваемые в наличии оригинальных исследований с января 2013 года]].

В параметре ''cat'' не должно быть ссылок, и префикса <code>Category:</code> или <code>Категория:</code>.

=== ''all'' ===
Параметр ''all'' определяет категорию, в которую должны быть включены все статьи не зависимо от даты.

В параметре ''all'' не должно быть ссылок, и префикса <code>Category:</code> или <code>Категория:</code>.

== Дополнительные параметры ==

=== ''imageright'' ===
С помощью этого параметра можно указать изображение в правой части сообщения. Синтаксис такой же, как и для параметра {{Para|Image}}, за исключением того, что по умолчанию изображение отсутствует.

=== ''smallimage'' and ''smallimageright'' ===
С помощью этих параметров можно указать изображения для блока малого формата. Они не будут иметь никакого эффекта, если не указано {{Para|Small|left}}.

=== ''class'' ===
Пользовательские классы [[Каскадные таблицы стилей|CSS]] для применения к сообщению. Если вы добавляете несколько классов, они должны быть разделены пробелом.

=== ''style'' and ''textstyle'' ===
Дополнительные значения CSS могут быть определены без кавычек <code>" "</code>, но с завершающими точками с запятой <code>;</code>.
* {{Para|Style}} — определяет стиль, используемый всей таблицей окна сообщений. Это можно использовать для таких вещей, как изменение ширины окна.
* {{Para|Textstyle}} — относится к текстовой ячейке.

=== ''issue'' and ''fix'' ===
Вместо указания {{Para|Text}} и {{Para|Text-small}} можно использовать параметр {{Para|Issue}}.

Индивидуальный текст для малого формата может быть определен с помощью {{Para|Fix}}.

=== ''plainlinks'' ===
Обычно в Википедии внешние ссылки отмечены значком стрелки рядом с ними, например: [http://www.example.com Example.com]. Однако в окнах сообщений значок стрелки по умолчанию скрыт, например: <span class="plainlinks">[http://www.example.com Example.com]</span>. Чтобы получить обычный стиль внешней ссылки со значком стрелки, используйте {{Para|Plainlinks|no}}.

=== ''cat2'', ''cat3'', ''all2'', and ''all3'' ===
* {{Para|Cat2}} и {{Para|Cat3}} предусматривают дополнительные помесячные категории; см. [[#cat]].
* {{Para|All2}} и {{Para|All3}} предусматривают дополнительные категории, в которые помещаются все статьи, как и в [[#all]].

== Технические детали ==
Если вам необходимо использовать специальные символы внутри параметра {{Para|Text}}, то вам необходимо заменять их ESC-последовательностями:

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

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

* Этот шаблон использует <code>cmbox</code> [[CSS]]-классы в [[MediaWiki:Common.css]] влияющие на его внешний вид, то есть он полностью перенастраиваемый.

* Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование [[ВП:ПАРС|функций парсера]] и специальных символов в параметрах.

* Теги <code><nowiki><div></nowiki></code>, окружающие текст в приведенном выше примере, обычно не нужны. Но если текст содержит разрыв строки или строк, то иногда мы получаем странный межстрочный интервал. Особенно это происходит при использовании вертикальных списков. Используйте теги <code><nowiki><div></nowiki></code>, чтобы исправить такое поведение.

== Семейство Mbox ==
{{Подробный список шаблонов семейства Mbox}}

<includeonly>
[[Категория:Шаблоны-сообщения семейства Mbox]]
</includeonly>