Шаблон:Ambox/doc
Файл:Information icon4.svg |
Эта страница требует существенной переработки. |
Время | Внимание! Это один из самых используемых шаблонов. |
Файл:OOjs UI icon notice-warning.svg | Прежде чем вносить какие-либо изменения в данный шаблон, просьба оттестировать их в /песочнице и проверить результат на странице с /контрольными примерами. Изменения могут быть внесены после этого в данный шаблон всего одной правкой. |
Файл:Lua-logo-nolabel.svg |
{{Ambox}}, название сокращенно от article message box — меташаблон различных шаблонов-сообщений для статей, таких как шаблон {{Мало внутренних ссылок}}. Он предлагает несколько различных цветов, изображений и некоторых других функций.
Использование[править код]
{{Ambox
| name =
| subst = <includeonly>{{subst:проверка подстановки}}</includeonly>
| type =
| image =
| sect = {{{1|}}}
| issue =
| issue_sect =
| talk = {{{talk|}}}
| fix =
| 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>
Не рекомендуется использовать данную заготовку, так как в обычном виде большинство параметров не используются.
{{Ambox
| name =
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| small = {{{small|}}}
| type =
| image =
| imageright =
| smallimage =
| smallimageright =
| class =
| style =
| textstyle =
| sect = {{{1|}}}
| issue =
| issue_sect =
| talk = {{{talk|}}}
| fix =
| date = {{{date|}}}
| text =
| smalltext =
| plainlinks = no
| removalnotice =
| cat =
| all =
| cat2 =
| all2 =
| cat3 =
| all3 =
}}<noinclude>{{Doc}}</noinclude>
Параметры[править код]
name[править код]
Обязательный. Параметр name используется для указания названия шаблона, без указания пространства имен Шаблон. Например, для шаблона {{Переписать}} параметр будет |name = Переписать
. Параметр должен быть также обновлен, при переименовании шаблона.
Параметр используется, в основном, для двух целей:
- При некорректной подстановке, позволяет мета-шаблону получить и отобразить имя ошибочно подставленного шаблона, что может помочь редакторам исправить проблему.
- Позволяет более полезно отображать шаблон на собственной странице: показать дату, даже если она не указана, а также провести категоризацию самого шаблона.
subst[править код]
Параметр subst позволяет мета-шаблону определить верно ли подставлен шаблон, и если не верно, то выдать соответствующее предупреждение и также добавит категорию Категория:РуСказки:Страницы с ошибочно подставленными шаблонами. Просто скопируйте код, как он представлен выше.
type[править код]
Параметр type влияет на цвет левой границы и на изображение, которое используется по умолчанию. Каждый из параметров указывает область применения шаблона. Десять возможных параметров и как они влияют на стиль — представлены ниже.
type=speedy – Запросы на удаление, например {{К удалению}}. |
type=delete или serious – Запросы связанные с удалением, например {{Hangon}}. |
type=content – Проблемы с содержанием, например {{Проверить нейтральность}} и {{Глобализировать}}. |
type=style – Проблемы со стилем, например {{Cleanup}} и {{Underlinked}}. |
type=notice – Сообщения о статье, например {{Текущие_события}} и {{Obscene}}. |
type=discussion – Статьи в процессе обсуждения не попадающие не в одну из категорий. |
type=good – Оценки статей, например {{Избранная статья}} и {{К лишению статуса добротной}}. |
type=move или merge – Объединение, разделение и меж-вики предложения, например {{К разделению}} и {{Перенести на Викисклад}}. |
type=protection – Сообщения о защите, примеров нет. |
Если параметр 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[править код]
Большинство шаблонов-сообщений, которые используются в статьях начинаются с Эта статья …, и часто необходимо изменить фразу на Этот раздел … если шаблон используется в одной из секций статьи. Заполнение данного параметра включит отображение текста из параметра |issue_sect =
и заменит текст из параметра |issue =
.
Для использования данной возможности, убедитесь, что указан параметр |issue_sect =
. Иначе шаблон будет пустым.
issue, issue_sect и fix[править код]
Параметр issue необходим для описания проблемы в статье. Постарайтесь сделать его как можно более кратким и понятным (примерно 10-20 слов) и не забудьте включить ссылку на соответствующее правило или руководство.
Параметр fix должен содержать рекомендации по улучшению статьи. В нём может быть больше слов, чем в параметре issue, но желательно не более двух предложений
Если шаблон в компактной (помещён в {{multiple issues}}) или малой (параметр small) форме, параметр fix отображаться не будет. Например, {{Мало внутренних ссылок}}:
|issue=Этой статье нужно '''больше [[Википедия:Внутренние ссылки|ссылок на другие статьи]]''' для [[Википедия:Связность статей|интеграции в энциклопедию]].
|fix=Пожалуйста, добавьте ссылки, [[ВП:МОЖНОССЫЛ|соответствующие контексту]].
При автономном использовании он отображает весь текст: Шаблон:Мало внутренних ссылок
talk[править код]
Некоторые шаблоны-сообщения содержат ссылку на страницу обсуждения, и позволяют редактору уточнить заголовок необходимой секции для ссылки. Чтобы добиться такой функциональности, просто укажите при создании шаблона |talk = {{{talk|}}}
.
Примеры использования параметра редакторами:
|talk = ЗАГОЛОВОК СЕКЦИИ
— ссылка отправит читателя в необходимую секцию на странице обсуждения статьи. Пример —|talk = Foo
.|talk = ПОЛНОЕ НАЗВАНИЕ СТРАНИЦЫ ОБСУЖДЕНИЯ
— шаблон выдаст ссылку на указанную страницу обсуждения (может содержать ссылку на секцию), например|talk = Обсуждение:Banana#Foo
.
Примечания:
- При использовании этого параметра при создании шаблона, то ссылка на страницу обсуждения будет появляться и в самом шаблоне (для того, чтобы продемонстрировать функциональность), но в статьях она будет отображаться, только если параметр фактически указан.
- Чтобы быть уверенным, что ссылка на страницу обсуждения постоянно показывается, вы можете использовать следующую конструкцию:
|talk = {{{talk|#}}}
. - Строка не будет отображаться если страницы обсуждения статьи, или указанной страницы обсуждения не существует, и неважно что вы укажете в параметре.
date[править код]
Установка параметра date сообщает мета-шаблону, что в шаблон-сообщение был установлен в этот день: устанавливается как редакторами, так и ботами. Отображается мелким шрифтов в конце дополнительного сообщения.
Обратите внимание, возможны только следующие виды дат:
- 2022-05-14 (предпочтительно)
- 1 мая 2015
- 01 мая 2015
- Стандартные англоязычные даты для обработки
{{#time: }}
Также указание этого параметра включает категоризацию по времени, если параметр #cat определен.
info[править код]
В этом параметре указывается дополнительная информация. Всё что вы сюда добавить отображается после даты и не отображается, если шаблон включен в {{multiple issues}}.
removalnotice[править код]
Пока не используется в нашем разделе.
Если вы указали |removalnotice = yes
, то следующее сообщение появится после даты и текста, записанного в info:
Не будет отображено, если шаблон включен в {{Multiple issues}}.
cat[править код]
Этот параметр определяет по-месячную категорию для статей. Если |cat = КАТЕГОРИЯ
тогда:
- статьи будут помещены в категорию Категория: КАТЕГОРИЯ с ДАТЫ если
|date = ДАТА
указан. - статьи будут помещены в категорию Категория: КАТЕГОРИЯ если дата не указана.
Например, для шаблона {{Маргинальные теории}} указана категория |cat = РуСказки:Статьи, подозреваемые в наличии оригинальных исследований
, и поэтому статья с шаблоном {{Маргинальные теории|date=12 января 2013}}
будет помещена в категорию Категория:РуСказки:Статьи, подозреваемые в наличии оригинальных исследований с января 2013 года.
В параметре cat не должно быть ссылок, и префикса Category:
или Категория:
.
all[править код]
Параметр all определяет категорию, в которую должны быть включены все статьи не зависимо от даты.
В параметре all не должно быть ссылок, и префикса Category:
или Категория:
.
Дополнительные параметры[править код]
imageright[править код]
С помощью этого параметра можно указать изображение в правой части сообщения. Синтаксис такой же, как и для параметра |image =
, за исключением того, что по умолчанию изображение отсутствует.
smallimage and smallimageright[править код]
С помощью этих параметров можно указать изображения для блока малого формата. Они не будут иметь никакого эффекта, если не указано |small = left
.
class[править код]
Пользовательские классы CSS для применения к сообщению. Если вы добавляете несколько классов, они должны быть разделены пробелом.
style and textstyle[править код]
Дополнительные значения CSS могут быть определены без кавычек " "
, но с завершающими точками с запятой ;
.
|style =
— определяет стиль, используемый всей таблицей окна сообщений. Это можно использовать для таких вещей, как изменение ширины окна.|textstyle =
— относится к текстовой ячейке.
text and smalltext[править код]
Вместо указания |issue =
и |fix =
можно использовать параметр |text =
.
Индивидуальный текст для малого формата может быть определен с помощью |text-small =
.
plainlinks[править код]
Обычно в Википедии внешние ссылки отмечены значком стрелки рядом с ними, например: Example.com. Однако в окнах сообщений значок стрелки по умолчанию скрыт, например: Example.com. Чтобы получить обычный стиль внешней ссылки со значком стрелки, используйте |plainlinks = no
.
cat2, cat3, all2, and all3[править код]
|cat2 =
и|cat3 =
предусматривают дополнительные помесячные категории; см. #cat.|all2 =
и|all3 =
предусматривают дополнительные категории, в которые помещаются все статьи, как и в #all.
Отображение в мобильной версии[править код]
Разработчики MediaWiki постоянно проводят исследования читабельности шаблонов-сообщений для статей в мобильной версии Википедии. На текущий момент, на мобильную версию не влияет наш дизайн и макет, там происходит свое формирование функционала нашего шаблона. Для получения дополнительной информации см. mw:Reading/Web/Projects/Mobile Page Issues.
Технические детали[править код]
Если вам необходимо использовать специальные символы внутри параметра |text =
, то вам необходимо заменять их ESC-последовательностями:
{{Ambox
| text = <div>
Здесь знак равенства = открывающая и закрывающая фигурные скобки { }.
А здесь знак разделения параметров {{!}} и две закрывающие фигурные скобки <nowiki>}}</nowiki>.
А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>.
</div>
}}
Здесь знак равенства = открывающая и закрывающая фигурные скобки { }. А здесь знак разделения параметров | и две фигурные скобки }}. А здесь знак разделения параметров перед двумя закрывающими фигурными скобками |}}. |
- Этот шаблон использует
Ambox
CSS-классы в MediaWiki:Common.css влияющие на его внешний вид, то есть он полностью перенастраиваемый.
- Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование функций парсера и специальных символов в параметрах.
- Теги
<div>
, окружающие текст в приведенном выше примере, обычно не нужны. Но если текст содержит разрыв строки или строк, то иногда мы получаем странный межстрочный интервал. Особенно это происходит при использовании вертикальных списков. Используйте теги<div>
, чтобы исправить такое поведение.
Семейство Mbox[править код]
В семействе Module:Message box есть семь меташаблонов:
- {{Ambox}} для сообщений на страницах статей.
- {{Cmbox}} для сообщений на страницах категорий.
- {{Imbox}} для сообщений на страницах файлов (изображений).
- {{Tmbox}} для сообщений на страницах обсуждения.
- {{Fmbox}} для сообщений верхнего и нижнего интерфейса сайта.
- {{Ombox}} для сообщений на других типах страниц.
- {{Mbox}}, для сообщений, которые используются в разных пространствах имён и соответствующим образом изменяют их дизайн.
Тесно связанные меташаблоны:
- {{Stub-meta}} для сообщений в заготовках статей.
- {{Неоднозначность}}, для сообщений на страницах устранения неоднозначности.
TemplateData[править код]
Базовый шаблон для различных шаблонов-сообщений.
Параметр | Описание | Тип | Статус | |
---|---|---|---|---|
name | name | Название шаблона | Строковый (без форматирования) | обязательный |
type | type | Название типа сообщения, варианты: delete serious content style good discussion notice merge
| Строковый (без форматирования) | необязательный |
issue | issue | Заголовок сообщения. | Строковый (без форматирования) | обязательный |
fix | fix | Текст меньшего шрифта под заголовком | Строковый (без форматирования) | необязательный |
image | image | Название изображения в формате [[Файл:Example.png]].
| Строковый (без форматирования) | необязательный |
imageright | imageright | Дополнительное изображение в правой части шаблона [[Файл:Example.png]]. | Строковый (без форматирования) | необязательный |
style | style | Дополнительные параметры оформления css | Строковый (без форматирования) | необязательный |
data-value-1 | data-value-1 | Значение атрибута "data-№" для JavaScript | Строковый (без форматирования) | обязательный |
data-value-2 | data-value-2 | Значение атрибута "data-№" для JavaScript | Строковый (без форматирования) | обязательный |
data-value-3 | data-value-3 | Значение атрибута "data-№" для JavaScript | Строковый (без форматирования) | обязательный |
data-label-1 | data-label-1 | Название атрибута "data-№" для JavaScript | Строковый (без форматирования) | необязательный |
data-label-2 | data-label-2 | Название атрибута "data-№" для JavaScript | Строковый (без форматирования) | необязательный |
data-label-3 | data-label-3 | Название атрибута "data-№" для JavaScript | Строковый (без форматирования) | необязательный |