Шаблон:Ambox/doc: различия между версиями

Материал из wikixw
Перейти к навигации Перейти к поиску
Метка: замена
Строка 1: Строка 1:
{{docpage}}
{{СИШ}}
{{Используйте песочницу}}
{{onLua|Message box|ambox}}
{{Mbox templates|nocat=1}}
'''{{t|Ambox}}''', название сокращенно от '''''a'''rticle '''m'''essage '''box''''' — меташаблон различных шаблонов-сообщений '''для статей''', таких как шаблон {{tl|Мало внутренних ссылок}}. Он предлагает несколько различных цветов, изображений и некоторых других функций.


== Использование ==
[[Категория:Шаблоны-сообщения семейства Mbox]]
<pre>
{{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>
</pre>
{{Начало скрытого блока|Заготовка со всем списком параметров}}
Не рекомендуется использовать данную заготовку, так как в обычном виде большинство параметров не используются.
<pre>{{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></pre>
{{Конец скрытого блока}}
 
== Параметры ==
 
=== ''name'' ===
'''Обязательный.''' Параметр ''name'' используется для указания названия шаблона, без указания пространства имен Шаблон. Например, для шаблона {{tl|Переписать}} параметр будет {{Para|name|Переписать}}. Параметр должен быть также обновлен, при переименовании шаблона.
 
Параметр используется, в основном, для двух целей:
* При некорректной [[Википедия:Подстановка шаблонов|подстановке]], позволяет мета-шаблону получить и отобразить имя ошибочно подставленного шаблона, что может помочь редакторам исправить проблему.
* Позволяет более полезно отображать шаблон на собственной странице: показать дату, даже если она не указана, а также провести категоризацию самого шаблона.
 
=== ''subst'' ===
Параметр ''subst'' позволяет мета-шаблону определить верно ли подставлен шаблон, и если не верно, то выдать соответствующее предупреждение и также добавит категорию [[:Категория:Википедия:Страницы с ошибочно подставленными шаблонами]]. Просто скопируйте код, как он представлен выше.
 
=== ''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> – Статьи в процессе обсуждения не попадающие не в одну из категорий.
}}
{{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>[[Файл:Unbalanced scales.svg|40px|link=|alt=]]</nowiki>}}:
{{POV|date={{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY}}}}
 
* Для {{tl|Стиль}} указано изображение {{para|image|<nowiki>[[Файл:Broom_icon.svg|50x40px]]</nowiki>}}:
{{Стиль|date={{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY}}}}
 
Пожалуйста, учтите:
* Если изображение не указано, то оно будет зависеть от параметра ''type''. (Смотрите о параметре [[#type]] выше.)
* Если указано {{para|image|none}}, то никакое изображение выводится не будет, и текст займет всю площадь шаблона.
* Если изображение выполняет чисто декоративную функцию, '''а также''' находится в [[Википедия:Правила использования изображений#Лицензия|общественном достоянии]], удобство и [[:en:Wikipedia:Manual of Style/Accessibility|доступность]] использования шаблоны может быть улучшена с помощью подавления ссылки на файл с помощью добавления параметров {{para|link}} и {{para|alt}}, как показано выше.
 
=== ''sect'' ===
Большинство шаблонов-сообщений, которые используются в статьях начинаются с '''Эта статья …''', и часто необходимо изменить фразу на '''Этот раздел …''' если шаблон используется в одной из секций статьи. Заполнение данного параметра включит отображение текста из параметра {{para|issue_sect}} и заменит текст из параметра {{para|issue}}.
 
{{em|Для использования данной возможности, убедитесь, что указан параметр {{para|issue_sect}}. Иначе шаблон будет пустым.}}
 
=== ''issue'', ''issue_sect'' и ''fix'' ===
Параметр ''issue'' необходим для описания проблемы в статье. Постарайтесь сделать его как можно более кратким и понятным (примерно 10-20 слов) и не забудьте включить ссылку на соответствующее [[ВП:Правила и руководства|правило или руководство]].
 
Параметр ''fix'' должен содержать рекомендации по улучшению статьи. В нём может быть больше слов, чем в параметре issue, но желательно не более двух предложений
 
Если шаблон в компактной (помещён в {{tl|multiple issues}}) или малой (параметр small) форме, параметр fix отображаться не будет. Например, {{tl|Мало внутренних ссылок}}:
* <code>|issue=<nowiki>Этой статье нужно '''больше [[Википедия:Внутренние ссылки|ссылок на другие статьи]]''' для [[Википедия:Связность статей|интеграции в энциклопедию]].</nowiki></code>
* <code>|fix=<nowiki>Пожалуйста, добавьте ссылки, [[ВП:МОЖНОССЫЛ|соответствующие контексту]].</nowiki></code>
 
При автономном использовании он отображает весь текст:
{{Мало внутренних ссылок|date={{CURRENTDAY}}-{{CURRENTMONTH}}-{{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=yes|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'' сообщает мета-шаблону, что в шаблон-сообщение был установлен в этот день: устанавливается как редакторами, так и [[ВП:Боты|ботами]]. Отображается мелким шрифтов в конце дополнительного сообщения.
 
'''Обратите внимание''', возможны только следующие виды дат:
* 2022-05-14 (предпочтительно)
* 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>.
== Дополнительные параметры ==
=== ''imageright'' ===
С помощью этого параметра можно указать изображение в правой части сообщения. Синтаксис такой же, как и для параметра {{para|image}}, за исключением того, что по умолчанию изображение отсутствует.
=== ''smallimage'' and ''smallimageright'' ===
С помощью этих параметров можно указать изображения для блока малого формата. Они не будут иметь никакого эффекта, если не указано {{para|small|left}}.
=== ''class'' ===
Пользовательские классы [[Каскадные таблицы стилей|CSS]] для применения к сообщению. Если вы добавляете несколько классов, они должны быть разделены пробелом.
=== ''style'' and ''textstyle'' ===
Дополнительные значения CSS могут быть определены без кавычек <code>" "</code>, но с завершающими точками с запятой <code>;</code>.
* {{para|style}} — определяет стиль, используемый всей таблицей окна сообщений. Это можно использовать для таких вещей, как изменение ширины окна.
* {{para|textstyle}} — относится к текстовой ячейке.
=== ''text'' and ''smalltext'' ===
Вместо указания {{para|issue}} и {{para|fix}} можно использовать параметр {{para|text}}.
Индивидуальный текст для малого формата может быть определен с помощью {{para|text-small}}.
=== ''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]].
== Отображение в мобильной версии ==
Разработчики ''MediaWiki'' постоянно проводят исследования читабельности шаблонов-сообщений для статей в мобильной версии Википедии. На текущий момент, на мобильную версию не влияет наш дизайн и макет, там происходит свое формирование функционала нашего шаблона. Для получения дополнительной информации см. [[:mw:Reading/Web/Projects/Mobile Page Issues]].
== Технические детали ==
Если вам необходимо использовать специальные символы внутри параметра {{para|text}}, то вам необходимо заменять их ESC-последовательностями:
<syntaxhighlight lang="moin">
{{ambox
| text  = <div>
Здесь знак равенства = открывающая и закрывающая фигурные скобки { }. 
А здесь знак разделения параметров {{!}} и две закрывающие фигурные скобки <nowiki>}}</nowiki>.
А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>.
</div>
}}
</syntaxhighlight>
{{ambox
| text  = <div>
Здесь знак равенства = открывающая и закрывающая фигурные скобки { }.
А здесь знак разделения параметров {{!}} и две фигурные скобки <nowiki>}}</nowiki>.
А здесь знак разделения параметров перед двумя закрывающими фигурными скобками <nowiki>|}}</nowiki>.
</div>
}}
* Этот шаблон использует <code>ambox</code> [[CSS]]-классы в [[MediaWiki:Common.css]] влияющие на его внешний вид, то есть он полностью перенастраиваемый.
* Внутри шаблона для формирования кода таблицы используется язык разметки HTML вместо языка викиразметки. Так делается во всех мета-шаблонах, так как у вики-разметки есть ряд недостатков. Например, она затрудняет использование [[ВП:ПАРС|функций парсера]] и специальных символов в параметрах.
* Теги <code><nowiki><div></nowiki></code>, окружающие текст в приведенном выше примере, обычно не нужны. Но если текст содержит разрыв строки или строк, то иногда мы получаем странный межстрочный интервал. Особенно это происходит при использовании вертикальных списков. Используйте теги <code><nowiki><div></nowiki></code>, чтобы исправить такое поведение.
== Семейство Mbox ==
{{Подробный список шаблонов семейства Mbox}}
== 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"
},
"type": {
"label": "type",
"description": "Название типа сообщения,  варианты: delete serious content style good discussion notice merge",
"type": "string",
"default": "notice"
},
"style": {
"label": "style",
"description": "Дополнительные параметры оформления css",
"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": "используется стандартное для этого типа изображение"
},
"imageright": {
"label": "imageright",
"type": "string",
"description": "Дополнительное изображение в правой части шаблона [[Файл:Example.png]]."
},
"fix": {
"label": "fix",
"description": "Текст меньшего шрифта под заголовком",
"type": "string"
},
"issue": {
"label": "issue",
"description": "Заголовок сообщения.",
"type": "string",
"required": true
},
"name": {
"label": "name",
"description": "Название шаблона",
"type": "string",
"required": true
}
},
"paramOrder": [
"name",
"type",
"issue",
"fix",
"image",
"imageright",
"style",
"data-value-1",
"data-value-2",
"data-value-3",
"data-label-1",
"data-label-2",
"data-label-3"
],
"format": "block"
}
</templatedata>
<!-- Категории -->
<includeonly>
[[Категория:Шаблоны-сообщения семейства Mbox]]
</includeonly>


[[Категория:Шаблоны:Документация]]
[[Категория:Шаблоны:Документация]]

Версия от 22:01, 3 декабря 2022

Источник — https://wikixw.ru/index.php?title=Шаблон:Ambox/doc&oldid=55211