Шаблон:Ambox

Документация

[просмотр | править | история | обновить]

{{ambox}} (от article message box) — базовый шаблон для различных шаблонов-сообщений в Тептар.

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

{{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
}}

Параметры

name

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

Параметр используется, в основном, для двух целей:

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

subst

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

small

Параметр small должен быть включен в шаблон, так как он позволит редакторам использовать "малый" вид шаблона в статье, который задается как |small=left.

В ином случае будет показан стандартный:

Другие варианты:

• Для шаблонов, которые никогда не должны быть малыми, указывайте |small=no или вообще не вставляйте |small= в шаблон.
• Для шаблонов, которые всегда должны быть малыми, указывайте |small=left.
• Для шаблонов, которые по умолчанию должны быть малыми, попробуйте |small={{{small|left}}}. Это позволит редакторам заменять малый вид, указывая |small=no при использовании в статье.

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

type

Параметр type влияет на цвет левой границы и на изображение, которое используется по умолчанию. Каждый из параметров указывает область применения шаблона. Десять возможных параметров и как они влияют на стиль — представлены ниже.

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

image

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

• Для {{Проверить нейтральность}} указано изображение |image=[[Файл:Unbalanced scales.svg|40px|link=|alt=]]:

• Для {{Стиль}} указано изображение |image=[[Файл:Broom_icon.svg|50x40px]]:

Пожалуйста, учтите:

• Если изображение не указано, то оно будет зависеть от параметра type. (Смотрите о параметре #type выше.)
• Если указано |image=none, то никакое изображение выводится не будет, и текст займет всю площадь шаблона.
• Если изображение выполняет чисто декоративную функцию, а также находится в общественном достоянии, удобство и доступность использования шаблоны может быть улучшена с помощью подавления ссылки на файл с помощью добавления параметров "|link=|alt=", как показано выше.

sect

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

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

A common way to facilitate this functionality is to pass |sect={{{1|}}}. This will allow editors to type section, for example, as the first unnamed parameter of the template to change the wording. For example, {{Advert|section}} produces: Шаблон:Advert Another approach is to pass |sect={{{section|{{{sect|}}}}}} to provide a named value. Another is to use {{Yesno}} to parse the value for a positive, and pass |sect=section if true.

These approaches can be combined, and this is recommended. The following ready-to-use code: Шаблон:Block indent enables the following:

• Any positive value that {{Yesno}} can detect will be used with the named parameter in the ambox-based template to get "section" instead of "article": |section=y, |sect=True, etc. It is recommended to allow both |sect= and |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": |section and its subsections, |1=list, |sect=section, |section=table, etc.

It is also advisable to restrict use of the |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 (In this case, any value of |small= or |left= will trigger the small, left display, as long as some value of |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 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 {{multiple issues}}) or small form (when using |small=left), the issue is the only text that will be displayed. For example, {{Переписать}} defines

• |issue=This article '''has an unclear citation style'''.
• |fix=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]].

When used stand-alone it produces the whole text:

But when used inside {{Multiple issues}} or with |small=left it displays only the issue: Шаблон:Multiple issues

talk

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

Примеры использования параметра редакторами:

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

Примечания:

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

date

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

Обратите внимание, возможны только следующие виды дат:

• 1 мая 2015
• 01 мая 2015
• Стандартные англоязычные даты для обработки {{#time: }}

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

info

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

removalnotice

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

Если вы указали |removalnotice=yes, то следующее сообщение появится после даты и текста, записанного в info:

• Learn how and when to remove this template message.

Не будет отображено, если шаблон включен в {{multiple issues}}.

cat

Этот параметр определяет по-месячную категорию для статей. Если |cat=КАТЕГОРИЯ тогда:

• статьи будут помещены в категорию Категория:КАТЕГОРИЯ с ДАТЫ если |date=ДАТА указан.
• статьи будут помещены в категорию Категория:КАТЕГОРИЯ если дата не указана.

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

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

all

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

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

Примеры

Сообщение

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

Обсуждение

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

Объединить или перенести

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

Избранная или хорошая статья

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

Проблемы со стилем

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

Проблемы

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

Серьёзные проблемы

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

Удаление

Используется дополнительный вариант стиля, используемый в шаблонах для статей к удалению.

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

Мини-шаблон

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

Другое изображение

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

TemplateData

Базовый шаблон для различных шаблонов-сообщений.

Параметры шаблона

Параметр		Описание	Тип	Статус
data-value-1	data-value-1	Значение атрибута "data-№" для JavaScript	Строковый (без форматирования)	обязательный
data-value-2	data-value-2	Значение атрибута "data-№" для JavaScript	Строковый (без форматирования)	обязательный
data-value-3	data-value-3	Значение атрибута "data-№" для JavaScript	Строковый (без форматирования)	обязательный
mini	mini	делает ширину шаблона равной 30% от ширины страницы	Логическое значение	необязательный
type	type	Название типа сообщения, варианты: delete serious content style good discussion notice merge По умолчанию notice	Строковый (без форматирования)	необязательный
style	style	Дополнительные параметры оформления css	Строковый (без форматирования)	необязательный
id	id	без описания	Строковый (без форматирования)	необязательный
data-label-1	data-label-1	Название атрибута "data-№" для JavaScript	Строковый (без форматирования)	необязательный
data-label-2	data-label-2	Название атрибута "data-№" для JavaScript	Строковый (без форматирования)	необязательный
data-label-3	data-label-3	Название атрибута "data-№" для JavaScript	Строковый (без форматирования)	необязательный
image	image	Название изображения в формате [[Файл:Example.png]]. По умолчанию используется стандартное для этого типа изображение	Строковый (без форматирования)	необязательный
text	text	Заголовок сообщения. Рекомендуется использовать полужирное начертание	Строковый (без форматирования)	необязательный
text-small	text-small	Текст меньшего шрифта под заголовком	Строковый (без форматирования)	необязательный
imageright	imageright	Дополнительное изображение в правой части шаблона [[Файл:Example.png]].	Строковый (без форматирования)	необязательный

Во избежание поломок страниц, использующих этот шаблон, экспериментируйте в песочнице (создать | зеркало) или своём личном пространстве.
Пожалуйста, добавляйте категории на подстраницу /doc. Подстраницы этого шаблона.