Редактирование: Модуль:Hatnote/doc (раздел)

== Основные функции ==
Основные функции содержатся в таблице {{Code|P}}, все функции можно вызывать как из других модулей, так и через {{Mwmw|invoke}}. При вызове из модуля функции принимают первым параметром таблицу с аргументами. Все описанные ниже параметры являются аргументами этой таблицы. Некоторые параметры принимают булевоподобные значения: их перечисление можно найти [[Модуль:Yesno|здесь]].

=== <code>parse_link</code> ===
Принимает на вход ссылку, возвращает два значения: целевую страницу и видимую часть ссылки. Если ссылку не удалось разобрать, возвращает {{Code|Nil}}. Наличие квадратных скобок не обязательно.

=== <code>format_link</code> ===
Формирует вики-ссылку. Превращает {{Code|#}} в ссылках на разделы в знак параграфа, отбитый пробелами, делая их более читабельными (см. {{T|Ссылка на раздел}}). 

Параметры:
* первый параметр: название целевой страницы или вики-ссылка.
* второй параметр: название раздела. Параметр будет проигнорирован, если раздел уже задан в первом параметре через {{Code|#}}.
* третий параметр: видимый текст ссылки.

=== <code>remove_precision</code> ===
Убирает уточнение из первого параметра (см. {{T|Без уточнения}}).

=== <code>is_disambig</code> ===
Функция, определяющая, является ли первый параметр [[РуСказки:Неоднозначность|страницей разрешения неоднозначности]]. Список шаблонов неоднозначностей берется со страницы [[MediaWiki:Disambiguationspage]].

=== <code>list</code> ===
Формирует список из вики-ссылок.

Параметры:
* нумерованные параметры — ссылки на страницы.
* {{Para|l1}}, {{Para|l2}} и т. д. — текст ссылок.
* {{Para|list_sep}} или {{Para|разделитель списка}}: разделитель списка, по умолчанию — {{No wikify|«, »}}.
* {{Para|natural_join}}: при неложном значении вместо последнего разделителя выводится союз «и».
* {{Para|links_ns}} или {{Para|ПИ ссылок}}: ко всем ссылкам добавляется префикс указанного пространства имен.
* {{Para|bold_links}} или {{Para|ссылки болдом}}: при непустом и неложном значении каждая ссылка выделяется полужирным.

Возвращает таблицу, для неё предусмотрен метод {{Code|tostring()}} и конкатенация. Именованные параметры этой таблицы — булевы переменные, истинные при обнаружении проблем. Отслеживаемые проблемы: {{Code|red_link}}, {{Code|bad_format}}, {{Code|formatted}}, {{Code|unparsable_link}}. Их описание [[#Отслеживаемые случаи|см. ниже]].

=== <code>hatnote</code> ===
Формирует код {{Tag|div|params=class="hatnote"|content=...}}.

Параметры:
* первый параметр — текст заметки.
* {{Para|id}}: id заметки.
* {{Para|extraclasses}}: дополнительные классы заметки.
* {{Para|hide_disambig}}: при непустом и неложном значении к тексту добавляется класс {{Code|dabhide}}, скрывающий подсветку для пользователей [[Википедия:Гаджеты/Выделение неоднозначностей|гаджета подсветки неоднозначностей]].

=== <code>main</code> ===
Генерирует текст-заметку. Позволяет ссылаться на неограниченное число страниц.
Синтаксис:
* вызов из вики-текста:
: {{Tpre|#invoke:Hatnote|main|префикс{{=}} ''префикс''{{Optp|префикс мн. ч.{{=}} ''префикс для нескольких ссылок''|разделитель списка{{=}} ''разделитель списка''|ПИ ссылок{{=}} ''пространство имен'' |extraclasses {{=}} ''дополнительные классы''|точка{{=}} ''true{{\}}false''|hide_disambig{{=}} ''true{{\}}false''|_spaced=yes}}}}
* вызов из другого модуля:
: <source lang="lua">
-- подключение модуля
local hatnote = require('Модуль:Hatnote').main

-- пример использования без изменения категорий по умолчанию
local res1 = hatnote{
    'Какая-то статья',
    l1 = 'Какой-нибудь текст ссылки',
    prefix = 'Основная статья:',
    prefix_plural = 'Основные статьи:',
    dot = true,
    nocat = args.nocat -- следует всегда передавать nocat, если он предусмотрен
}

-- и с изменением
local res2 = hatnote({
    'Еще какая-то статья',
    prefix = 'См. также:',
    list_sep = '; ',
    natural_join = false,
    nocat = args.nocat
}, {
    red_link = 'Википедия:Статьи с шаблоном «См. также» с красными ссылками'
})
</source>

{{Видимый якорь|Параметры:|main-Параметры}}
* {{Para|prefix}} или {{Para|префикс}}: обязательный параметр, текст перед списком ссылок.
* {{Para|prefix_plural}} или {{Para|префикс мн. ч.}}: если ссылок несколько, для префикса вместо предыдущего параметра будет использован этот.
* {{Para|sep}} или {{Para|разделитель}}: разделитель между префиксом и списком ссылок.
* {{Para|dot}} или {{Para|точка}}: при непустом и неложном значении выводится точка в конце.
* {{Para|nocat}}: при непустом и неложном значении отключается категоризация.
* {{Para|empty_list_message}}: сообщение об ошибке, выводящееся при пустом списке ссылок. По умолчанию — «Не указано ни одной страницы».
* {{Para|preview_error}}: при непустом и неложном значении ошибка при пустом списке ссылок выводится только во время предпросмотра.
Функция также принимает все параметры функций {{Code|list}} и {{Code|hatnote}} и передает их без изменения в эти функции.

Вторым параметром (при вызове через другой модуль) функция принимает таблицу с переназначенными категориями. Их идентификаторы [[#Отслеживаемые случаи|см. ниже]]: