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

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

Модуль «Надстрочное предупреждение» основан на более неиспользуемом шаблоне {{Надстрочное предупреждение}} и предназначен для вывода на страницах (например, подозрительный текст^{[некая претензия]}), таких как {{Нет АИ}}, {{Уточнить}} или {{Неопределённость}}. Единственный обязательный параметр — text.

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

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

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

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

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

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

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

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

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

С выделением предшествующего текста и обязательным заполнением даты:

{{safesubst:<noinclude/>#invoke:Надстрочное предупреждение|main|2={{safesubst:<noinclude/>CURRENTDAY}} |3={{safesubst:<noinclude/>CURRENTMONTH}} |4={{safesubst:<noinclude/>CURRENTYEAR}}
  | day = {{{2}}}
  | month = {{{3}}}
  | year = {{{4}}}
  | span-text = {{{1|}}}
  | text = 
  | link = 
  | talk = {{{talk|{{{обс|}}}}}}
  | comment = {{{comment|{{{c|{{{комм|}}}}}}}}}
  | comment-default = 
  | anchor = {{{anchor|{{{якорь|}}}}}}
  | cat1 = 
  | cat-date1 = 
  | cat2 =
  | cat-date2 = 
  | cat3 = 
  | cat-date3 = 
  | errorcat =
  | nocat = {{{nocat|}}}
}}

Без выделения предшествующего текста и обязательного заполнения даты:

{{safesubst:<noinclude/>#invoke:Надстрочное предупреждение|main|1={{safesubst:<noinclude/>CURRENTDAY}} |2={{safesubst:<noinclude/>CURRENTMONTH}} |3={{safesubst:<noinclude/>CURRENTYEAR}}
  | day = {{{1|}}}
  | month = {{{2|}}}
  | year = {{{3|}}}
  | text = 
  | link = 
  | talk = {{{talk|{{{обс|}}}}}}
  | comment = {{{comment|{{{c|{{{комм|}}}}}}}}}
  | comment-default = 
  | anchor = {{{anchor|{{{якорь|}}}}}}
  | cat1 = 
  | cat-date1 = 
  | cat2 =
  | cat-date2 = 
  | cat3 = 
  | cat-date3 = 
  | nocat = {{{nocat|}}}
  | errorcat =
}}

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

{{safesubst:<noinclude/>#invoke:Надстрочное предупреждение|main
  | span-text = {{{1|}}}
  | text = 
  | link = 
  | comment = {{{comment|{{{c|{{{комм|}}}}}}}}}
  | comment-default = 
  | anchor = {{{anchor|{{{якорь|}}}}}}
  | cat = 
  | nocat = {{{nocat|}}}
}}

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

Для шаблона {{Нет АИ 2}}:

{{safesubst:<noinclude/>#invoke:Надстрочное предупреждение|main|2={{safesubst:<noinclude/>CURRENTDAY}} |3={{safesubst:<noinclude/>CURRENTMONTH}} |4={{safesubst:<noinclude/>CURRENTYEAR}}
  | day = {{{2}}}
  | month = {{{3}}}
  | year = {{{4}}}
  | span-text = {{{1|}}}
  | text = {{#ifexpr: {{Прошло дней|{{{2}}}|{{{3}}}|{{{4}}}}} <= 14 
            | источник? 
            | источник не указан {{Прошло дней|{{{2}}}|{{{3}}}|{{{4}}}}}&nbsp;{{Plural:{{Прошло дней|{{{2}}}|{{{3}}}|{{{4}}}}}|день|дня|дней}}
           }}
  | link = РуСказки:Ссылки на источники
  | talk = {{{talk|{{{обс|}}}}}}
  | comment = {{{comment|{{{c|{{{комм|}}}}}}}}}
  | comment-default = не указан источник на утверждение
  | anchor = {{{anchor|{{{якорь|}}}}}}
  | cat1 = [[Категория:РуСказки:Нет источников с {{#time:xg Y|{{{4}}}-{{{3}}}-{{{2}}}}}]]
  | cat2 = {{Нет источника (сортировка по типу)}}
  | cat-date3 = > 14
  | cat3 = [[Категория:РуСказки:Статьи с утверждениями без источников более 14 дней]]
  | nocat = {{{nocat|}}}
  | errorcat = [[Категория:РуСказки:Страницы с ошибками параметров в шаблоне Нет АИ]]
}}