Модуль:Надстрочное предупреждение/doc

Это страница документации Модуль:Надстрочное предупреждение.

Модуль «Надстрочное предупреждение» основан на более неиспользуемом шаблоне {{Надстрочное предупреждение}} и предназначен для вывода на страницах надстрочных шаблонов-предупреждений (например, подозрительный текст^{[некая претензия]}), таких как {{нет АИ}}, {{уточнить}} или {{неопределённость}}. Единственный обязательный параметр — <syntaxhighlight lang="text" class="" id="" style="" inline="1">text</syntaxhighlight>.

Часть шаблонов также могут оборачивать предшествующий предупреждению текст в теги ‎<span> (например, непонятный текст^{[некая претензия]}), а также учитывать дату установки. В шаблонах с заполнением даты рекомендуется использовать модуль Unsubst (см. ниже), чтобы при подстановке шаблона в него автоматически добавлялась текущая дата, например:
{{subst:нет АИ}} → {{нет АИ|10|11|2024}}.

Все шаблоны на основе модуля поддерживают подстановку вида {{subst:когда}} → {{когда}} для отсутствия в статьях ошибочного кода из шаблонов.

При неправильном заполнении даты шаблоны, написанные на базе этого модуля, добавляют категорию [[Категория:Википедия:Надстрочные предупреждения с некорректно заданной датой]] (0).

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

Параметры шаблона
Параметр	Описание
<syntaxhighlight lang="text" class="" id="" style="" inline="1">day</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">month</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">year</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">errorcat</syntaxhighlight>	Параметры для указания даты установки шаблона. Дата указывается только цифрами. В параметре <syntaxhighlight lang="text" class="" id="" style="" inline="1">errorcat</syntaxhighlight> можно задать категорию, в которую будут помещаться статьи с неправильно заданной датой. Если вы видите предупреждение «Ошибка: некорректно задана дата установки», то, скорее всего, вы не указали дату простановки шаблона, для этого замените `{{название шаблона\|параметры}}` на `{{subst:название шаблона\|параметры}}`.
<syntaxhighlight lang="text" class="" id="" style="" inline="1">span-text</syntaxhighlight>	Параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">span-text</syntaxhighlight> задает текст, выделяемый шаблоном. По умолчанию выделяется таким образом^{[источник?]}, однако стили текста можно изменить на любой желаемый при помощи параметра <syntaxhighlight lang="text" class="" id="" style="" inline="1">templatestyles</syntaxhighlight>, загружающего стили для определённого шаблона (для работы необходимо добавить параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">name</syntaxhighlight> с названием шаблона}}). Предназначен для шаблонов, подобных {{нет АИ 2}}.
<syntaxhighlight lang="text" class="" id="" style="" inline="1">comment</syntaxhighlight> <syntaxhighlight lang="text" class="" id="" style="" inline="1">comment-default</syntaxhighlight>	Комментарий к шаблону для указания сути претензии к тексту. В параметре <syntaxhighlight lang="text" class="" id="" style="" inline="1">comment-default</syntaxhighlight> желательно задать текст комментария по умолчанию с возможностью указания причины при каждой установке шаблона, иначе в качестве оного будет выводиться ссылка, заданная в параметре <syntaxhighlight lang="text" class="" id="" style="" inline="1">link</syntaxhighlight>. Также вместе с комментарием выводится дата установки шаблона (если она задана). Рекомендуется использовать в локальных шаблонах также более краткие названия параметра — <syntaxhighlight lang="text" class="" id="" style="" inline="1">c</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">комм</syntaxhighlight> (вот так: <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{{comment\|{{{c\|{{{комм\|}}}}}}}}}</syntaxhighlight>) для удобства быстрого набора с клавиатуры.
<syntaxhighlight lang="text" class="" id="" style="" inline="1">text</syntaxhighlight>	Текст надстрочного предупреждения (например: <syntaxhighlight lang="text" class="" id="" style="" inline="1">источник?</syntaxhighlight> → ^{[источник?]}). Единственный обязательный параметр, при отсутствии которого выводится ошибка «Ошибка: не задан параметр `text`».
<syntaxhighlight lang="text" class="" id="" style="" inline="1">link</syntaxhighlight>	Название страницы с соответствующим руководством к действию в случае обнаружения шаблона (например, <syntaxhighlight lang="text" class="" id="" style="" inline="1">Википедия:Ссылки на источники</syntaxhighlight> → ^{[источник?]}). Ссылка задается без квадратных скобок.
<syntaxhighlight lang="text" class="" id="" style="" inline="1">talk</syntaxhighlight>	Ссылка на раздел страницы, где ведется обсуждение текста, к которому поставлено предупреждение. В локальных шаблонах следует задавать два названия для параметра: <syntaxhighlight lang="text" class="" id="" style="" inline="1">обс</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">talk</syntaxhighlight> (вот так: <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{{talk\|{{{обс\|}}}}}}</syntaxhighlight>).
<syntaxhighlight lang="text" class="" id="" style="" inline="1">anchor</syntaxhighlight>	Якорь на предупреждение для возможности создать ссылку из обсуждения. В локальных шаблонах параметру рекомендуется задать два названия: <syntaxhighlight lang="text" class="" id="" style="" inline="1">anchor</syntaxhighlight> и <syntaxhighlight lang="text" class="" id="" style="" inline="1">якорь</syntaxhighlight> (вот так: <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{{anchor\|{{{якорь\|}}}}}}</syntaxhighlight>.
<syntaxhighlight lang="text" class="" id="" style="" inline="1">cat</syntaxhighlight> `catN` `cat-dateN` <syntaxhighlight lang="text" class="" id="" style="" inline="1">nocat</syntaxhighlight>	Параметры для задания категорий. Параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">cat</syntaxhighlight> — для категории, не зависящей от наличия или отсутствия даты в шаблоне. Для параметров `catN` статья с попадает в категорию только в случае выполнения условия, заданного в параметре `cat-dateN` с соответствующим индексом (от 1 до 3), содержимое которого может состоять из оператора (знака сравнения) и числа (по умолчанию — `>= 0`; например: `cat-date2 >= 100` будет означать, что начиная с 100 дня после момента установки статья будет попадать в категорию «cat2»). Ссылка на категорию задается с квадратными скобками, либо соответствующим шаблоном. Категоризация работает только в основном пространстве имен. Параметр <syntaxhighlight lang="text" class="" id="" style="" inline="1">nocat</syntaxhighlight> подавляет категоризацию.
<syntaxhighlight lang="text" class="" id="" style="" inline="1">noprint</syntaxhighlight>	Не отображать предупреждение в печатной версии (следует указывать для большинства малозначительных проблем с шаблонами, не касающихся источников и т. д.).

Локальные параметрыПравить

обс (talk) — ссылка на раздел страницы, где ведется обсуждение текста, к которому поставлено предупреждение (на странице обсуждения или форуме). Если необходимо сослаться на раздел на странице обсуждения, достаточно указать только названия раздела, то бишь если в ссылке отсутствует или находится в начале символ решетки (<syntaxhighlight lang="text" class="" id="" style="" inline="1">#</syntaxhighlight>), то ссылка ведет в соответствующий раздел на странице обсуждения. В противном случае — на раздел другой страницы. Ссылка задается без квадратных скобок. Например:
- {{нет АИ|10|11|2024|обс=Предложения}} → ^{[источник? (обс.)]}
- {{нет АИ|10|11|2024|обс=Википедия:Форум/Архив/Вниманию участников/2016/01#Спам или не спам?}} → ^{[источник? (обс.)]}
комм (c, comment) — комментарий к шаблону для указания сути претензии к тексту; задаётся с целью её конкретизации. Если комментарий задан в статье, то текст предупреждения подчеркивается пунктиром. Например:
- {{нет АИ|10|11|2024|комм=бла-бла-бла}} → ^{[источник?]}
якорь (anchor) — якорь на предупреждение для возможности создать ссылку из обсуждения. Принцип работы аналогичен шаблону {{якорь2}}. Например:
- на шаблон с кодом {{нет АИ|10|11|2024|якорь=Пример}} в графе «link» раздела «Использование» ведет ссылка <syntaxhighlight lang="text" class="" id="" style="" inline="1">[[Шаблон:Надстрочное предупреждение#Пример|ссылка]]</syntaxhighlight> → ссылка.

Заготовка для копированияПравить

Для шаблонов с указанием даты установкиПравить

С выделением предшествующего текста и обязательным заполнением даты: <syntaxhighlight lang="wikitext">^{Ошибка: не задан параметр text}</syntaxhighlight>

Без выделения предшествующего текста и обязательного заполнения даты: <syntaxhighlight lang="wikitext">^{Ошибка: не задан параметр text}</syntaxhighlight>

Для шаблонов без указания даты установкиПравить

<syntaxhighlight lang="wikitext">^{Ошибка: не задан параметр text}</syntaxhighlight>

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

Для шаблона {{нет АИ 2}}: <syntaxhighlight lang="wikitext">Ошибка: некорректно задана дата установки</syntaxhighlight>