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

<noinclude>{{docpage}}</noinclude><includeonly>{{СИШ}}{{esoteric}}</includeonly>
{{onLua|Message box}}
{{Mbox templates|nocat=1}}
'''{{t|ambox}}''' (от '''''a'''rticle '''m'''essage '''box''''') — базовый шаблон для различных шаблонов-сообщений в Викимультии.

== Использование ==
<pre>
{{ambox
 |mini       = <!-- При любом непустом значении параметра ширина шаблона - 30% от ширины страницы -->
 |type       = <!-- Название типа сообщения, см. ниже все варианты. Если параметр не задан, используется тип notice -->
 |style      = <!-- Дополнительные параметры оформления -->
 |image      = <!-- Название изображения в формате [[Файл:Example.png]]. Если параметр не задан, используется стандартное для этого типа изображение -->
 |text       = <!-- Заголовок сообщения. Рекомендуется использовать полужирное начертание -->
 |text-small = <!-- Текст меньшего шрифта под заголовком -->
 |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
}}
</pre>

== Параметры ==
=== ''name'' ===
'''Обязательный.''' Параметр ''name'' используется для указания названия шаблона, без указания пространства имен Шаблон. Например, для шаблона {{tl|Переписать}} параметр будет {{Para|name|Переписать}}. Параметр должен быть также обновлен, при переименовании шаблона.

Параметр используется, в основном, для двух целей:
* При некорректной [[Викимультия:Подстановка шаблонов|подстановке]], позволяет мета-шаблону получить и отобразить имя ошибочно подставленного шаблона, что может помочь редакторам исправить проблему.
* Позволяет более полезно отображать шаблон на собственной странице: показать дату, даже если она не указана, а также провести категоризацию самого шаблона.

=== ''subst'' ===
Параметр ''subst'' позволяет мета-шаблону определить верно ли подставлен шаблон, и если не верно, то выдать соответствующее предупреждение и также добавит категорию [[:Категория:Викимультия:Страницы с ошибочно подставленными шаблонами]]. Просто скопируйте код, как только он появится в шаблоне-сообщении.

=== ''small'' ===
Параметр ''small'' должен быть включен в шаблон, так как он позволит редакторам использовать "малый" вид шаблона в статье, который задается как {{para|small|left}}. 
{{Ambox|nocat=true|small=left|text=Это малый вид шаблона Ambox, расположенный слева.}}
В ином случае будет показан стандартный:
{{Ambox|nocat=true|text=Это стандартный вид шаблона Ambox.}}

Другие варианты:
* Для шаблонов, которые ''никогда'' не должны быть малыми, указывайте {{Para|small|no}} или вообще не вставляйте {{Para|small}} в шаблон.
* Для шаблонов, которые ''всегда'' должны быть малыми, указывайте {{Para|small|left}}.
* Для шаблонов, которые ''по умолчанию'' должны быть малыми, попробуйте {{para|small|<nowiki>{{{small|left}}}</nowiki>}}. Это позволит редакторам заменять малый вид, указывая {{para|small|no}} при использовании в статье.

Посмотрите раздел [[#sect]], ниже, для информации об ограничениях на отображение {{para|small}} в случаях, когда шаблон используется для раздела, а не для всей статьи (рекомендуется для предотвращения неверного отображения в преамбуле статьи).

=== ''type'' ===
Параметр ''type'' влияет на цвет левой границы и на изображение, которое используется по умолчанию. Каждый из параметров указывает область применения шаблона. Десять возможных параметров и как они влияют на стиль — представлены ниже.
{{Ambox
|nocat=true
| type  = speedy
| text  = type=<u>speedy</u> – Запросы на удаление, например {{tl|К удалению}}.
}}
{{Ambox
|nocat=true
| type  = delete
| text  = type=<u>delete</u> или <u>serious</u> – Запросы связанные с удалением, например {{tl|hangon}}.
}}
{{Ambox
|nocat=true
| type  = content
| text  = type=<u>content</u> – Проблемы с содержанием, например {{tl|Проверить нейтральность}} и {{tl|Глобализировать}}.
}}
{{Ambox
|nocat=true
| type  = style
| text  = type=<u>style</u> – Проблемы со стилем, например {{tl|cleanup}} и {{tl|underlinked}}.
}}
{{ambox
|nocat=true
| type  = notice
| text  = type=<u>notice</u> – Сообщения о статье, например {{tl|Текущие_события}} и {{tl|Obscene}}.
}}
{{ambox
|nocat=true
| type  = discussion
| text  = type=<u>discussion</u> – Страницы в процессе обсуждения и шаблоны не попадающие не в одну из категорий, например {{tl|Обсуждаемое правило}} и {{tl|Вики-выходные}}.
}}
{{ambox
|nocat=true
| type  = good
| text  = type=<u>good</u> – Оценки статей, например {{tl|Избранная статья}} и {{tl|К лишению статуса добротной}}.
}}
{{Ambox
|nocat=true
| type  = move
| text  = type=<u>move</u> или <u>merge</u> – Объединение, разделение и меж-вики предложения, например {{tl|К разделению}} и {{tl|Перенести на Викисклад}}.
}}
{{Ambox
|nocat=true
| type  = protection
| text  = type=<u>protection</u> – Сообщения о защите, примеров нет.
}}

Если параметр ''type'' не указан, то по умолчанию используется {{para|type|notice}}.

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

* Для {{Tl|Проверить нейтральность}} указано изображение {{Para|image|<nowiki>[[File:Unbalanced scales.svg|40px|link=|alt=]]</nowiki>}}:
{{POV|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

* Для {{tl|Стиль}} указано изображение {{para|image|<nowiki>[[File:Broom_icon.svg|50x40px]]</nowiki>}}:
{{Стиль|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

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

=== ''sect'' ===
Большинство шаблонов-сообщений, которые используются в статьях начинаются с '''Эта статья …''', и часто необходимо изменить фразу на '''Этот раздел …''' если шаблон используется в одной из секций статьи. Значение данного параметра заменит фразу «Эта статья». Возможные использования: {{para|sect|Этот список}}, {{para|sect|Эта таблица}}, {{para|sect|Этот «исторический» материал}} и т. д.

{{em|Для использования данной возможности, убедитесь, что первые два слова («Эта статья») удалены из текста шаблона, иначе они будут продублированны.}}

A common way to facilitate this functionality is to pass {{para|sect|<nowiki>{{{1|}}}</nowiki>}}. This will allow editors to type <kbd>section</kbd>, for example, as the first unnamed parameter of the template to change the wording. For example, {{tlx|Advert|section}} produces:
{{Advert|section|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
Another approach is to pass {{para|sect|<nowiki>{{{section|{{{sect|}}}}}}</nowiki>}} to provide a named value.  Another is to use {{tlx|Yesno}} to parse the value for a positive, and pass {{para|sect|section}} if true.

{{em|These approaches can be combined}}, and this is recommended. The following ready-to-use code:
{{block indent|1=<code><nowiki>| sect  = {{#ifeq:{{yesno|def=|1={{{sect|{{{section}}}}}} }}|yes|section|{{{sect|{{{section|{{{1|}}}}}}}}} }}</nowiki></code>}}
enables the following:
* Any positive value that {{tlx|Yesno}} can detect will be used with the named parameter in the ambox-based template to get "section" instead of "article": {{para|section|y}}, {{para|sect|True}}, etc.  It is recommended to allow both {{para|sect}} and {{para|section}} so that editors do not have to guess which one will work. The sample code above does this for you.
* Any other value passed, in any manner, will replace "article": {{para||section and its subsections}}, {{para|1|list}}, {{para|sect|section}}, {{para|section|table}}, etc.

It is also advisable to restrict use of the {{para|small}} parameter so that it is made contingent upon the template being applied to a section (or whatever) rather than the whole article, to prevent the small version of the template being used at the top of the article where it would be inconsistent with other article-wide cleanup/dispute banners:
{{block indent|1=<code><nowiki>| small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }}</nowiki></code>}}
(In this case, any value of {{para|small}} or {{para|left}} will trigger the small, left display, as long as some value of {{para|sect}} or one of its aliases in that template has also been provided.) This code can be copy-pasted and used with the above code block. See, e.g., [[Template:Trivia]] and its [[Template:Trivia/testcases]] to observe the combined functionality.

=== ''issue'' and ''fix'' ===
The ''issue'' parameter is used to describe the issue with the article. Try to keep it short and to-the-point (approximately 10-20 words) and be sure to include a link to a relevant [[Wikipedia:Policies and guidelines|policy or guideline]].

The ''fix'' parameter contains some text which describes what should be done to improve the article. It may be longer than the text in ''issue'', but should not usually be more than two sentences.

When the template is in its compact form (when placed inside {{tl|multiple issues}}) or small form (when using {{para|small|left}}), the ''issue'' is the only text that will be displayed. For example, {{Tl|Переписать}} defines
* <code>|issue=<nowiki>This article '''has an unclear citation style'''.</nowiki></code>
* <code>|fix=<nowiki>The references used may be made clearer with a different or consistent style of [[Wikipedia:Citing sources|citation]], [[Wikipedia:Footnotes|footnoting]], or [[Wikipedia:External links|external linking]].</nowiki></code>

When used stand-alone it produces the whole text:
{{Переписать|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

But when used inside {{Tl|Multiple issues}} or with {{Para|small|left}} it displays only the issue:
{{Multiple issues <!-- Even though there's only one "issue", please don't remove this {{Multiple issues}} template. It is a demonstration of the formatting. --> |{{Переписать|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}}}
{{Переписать|small=left|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

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

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

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

=== ''info'' ===
В этом параметре указывается дополнительная информация. Всё что вы сюда добавить отображается после даты и не отображается, если шаблон включен в  {{tl|multiple issues}}.

=== ''removalnotice'' ===
''Пока не используется в нашем разделе.''

Если вы указали {{para|removalnotice|yes}}, то следующее сообщение появится после даты и текста, записанного в ''info'':
* <small>[[Help:Maintenance template removal|Learn how and when to remove this template message]].</small>
Не будет отображено, если шаблон включен в {{tl|multiple issues}}.

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

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

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

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

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

== Примеры ==
=== Сообщение ===
<pre>
{{ambox
 |type       = notice
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = notice
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Обсуждение ===
<pre>
{{ambox
 |type       = discussion
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = discussion
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Объединить или перенести ===
<pre>
{{ambox
 |type       = merge
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = merge
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Избранная или хорошая статья ===
<pre>
{{ambox
 |type       = good
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = good
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Проблемы со стилем ===
<pre>
{{ambox
 |type       = style
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = style
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Проблемы ===
<pre>
{{ambox
 |type       = content
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = content
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Серьёзные проблемы ===
<pre>
{{ambox
 |type       = serious
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = serious
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Удаление ===
Используется дополнительный вариант стиля, используемый в шаблонах для статей к удалению.
<pre>
{{ambox
 |type       = delete
 |style      = background:#FEE
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = delete
 |style      = background:#FEE
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

=== Мини-шаблон ===
<pre>
{{ambox
 |mini       = 1
 |type       = notice
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |mini       = 1
 |type       = notice
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

<br clear="all" />

=== Другое изображение ===
<pre>
{{ambox
 |type       = style
 |image      = [[Файл:Wikitext.svg|40px|<nowiki>[[wiki]]</nowiki>]]
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}
</pre>

{{ambox
 |type       = style
 |image      = [[Файл:Wikitext.svg|40px|<nowiki>[[wiki]]</nowiki>]]
 |text       = '''Заголовок сообщения. Рекомендуется использовать полужирное начертание.'''
 |text-small = Текст меньшего шрифта под заголовком.
}}

== TemplateData ==
<templatedata>
{
	"description": "Базовый шаблон для различных шаблонов-сообщений.",
	"params": {
		"data-value-1": {
			"label": "data-value-1",
			"description": "Значение атрибута \"data-№\" для JavaScript",
			"type": "string",
			"required": true
		},
		"data-value-2": {
			"label": "data-value-2",
			"type": "string",
			"required": true,
			"inherits": "data-value-1"
		},
		"data-value-3": {
			"label": "data-value-3",
			"type": "string",
			"required": true,
			"inherits": "data-value-1"
		},
		"mini": {
			"label": "mini",
			"description": "делает ширину шаблона равной 30% от ширины страницы",
			"type": "boolean"
		},
		"type": {
			"label": "type",
			"description": "Название типа сообщения,  варианты: delete serious content style good discussion notice merge",
			"type": "string",
			"default": "notice"
		},
		"style": {
			"label": "style",
			"description": "Дополнительные параметры оформления css",
			"type": "string"
		},
		"id": {
			"label": "id",
			"type": "string"
		},
		"data-label-1": {
			"label": "data-label-1",
			"description": "Название атрибута \"data-№\" для JavaScript",
			"type": "string"
		},
		"data-label-2": {
			"label": "data-label-2",
			"type": "string",
			"inherits": "data-label-1"
		},
		"data-label-3": {
			"label": "data-label-3",
			"type": "string",
			"inherits": "data-label-1"
		},
		"image": {
			"label": "image",
			"description": "Название изображения в формате [[Файл:Example.png]].",
			"type": "string",
			"default": "используется стандартное для этого типа изображение"
		},
		"text": {
			"label": "text",
			"description": "Заголовок сообщения. Рекомендуется использовать полужирное начертание",
			"type": "string"
		},
		"text-small": {
			"label": "text-small",
			"description": "Текст меньшего шрифта под заголовком",
			"type": "string"
		},
		"imageright": {
			"label": "imageright",
			"type": "string",
			"description": "Дополнительное изображение в правой части шаблона [[Файл:Example.png]]."
		}
	}
}
</templatedata>

<!-- Категории -->
<includeonly>[[Категория:Шаблоны:Для шаблонов]]
</includeonly>