3664
правки
Модуль:Hatnote/doc: различия между версиями
нет описания правки
Mansur700 (обсуждение | вклад) (Новая страница: «{{docpage}} {{Module rating|release}} Модуль предназначен для реализации hatnote-шаблонов (например, {{t|основ...») |
Mansur700 (обсуждение | вклад) Нет описания правки |
||
| Строка 1: | Строка 1: | ||
{{docpage}} | {{docpage}}{{Module rating|protected}} | ||
{{Module rating| | {{используйте песочницу|testcases-other=Шаблон:Основная статья/тесты}} | ||
Модуль предназначен для реализации hatnote-шаблонов (например, {{t|основная статья}}, {{t|см. также}}). Также он содержит несколько функций для работы со ссылками и отслеживания ошибок. | Модуль предназначен для реализации hatnote-шаблонов (например, {{t|основная статья}}, {{t|см. также}}). Также он содержит несколько функций для работы со ссылками и отслеживания ошибок. См. тесты на странице [[Шаблон:Основная статья/тесты]]. | ||
== Основные функции == | == Основные функции == | ||
Основные функции содержатся в таблице {{code|p}}, все функции можно вызывать как из других модулей, так и через {{mwmw|invoke}}. При вызове из модуля функции принимают первым параметром таблицу с аргументами. Все описанные ниже параметры являются аргументами этой таблицы. Некоторые параметры принимают булевоподобные значения: их перечисление можно найти [[Модуль:Yesno|здесь]]. | Основные функции содержатся в таблице {{code|p}}, все функции можно вызывать как из других модулей, так и через {{mwmw|invoke}}. При вызове из модуля функции принимают первым параметром таблицу с аргументами. Все описанные ниже параметры являются аргументами этой таблицы. Некоторые параметры принимают булевоподобные значения: их перечисление можно найти [[Модуль:Yesno|здесь]]. | ||
=== <code>parse_link</code> === | |||
Принимает на вход ссылку, возвращает два значения: целевую страницу и видимую часть ссылки. Если ссылку не удалось разобрать, возвращает {{code|nil}}. Наличие квадратных скобок не обязательно. | |||
=== <code>format_link</code> === | === <code>format_link</code> === | ||
Формирует вики-ссылку. Превращает {{code|#}} в ссылках на разделы в знак параграфа, отбитый пробелами, делая их более читабельными (см. {{t|ссылка на раздел}}). | |||
Параметры: | |||
* первый параметр: название целевой страницы или вики-ссылка. | |||
* второй параметр: название раздела. Параметр будет проигнорирован, если раздел уже задан в первом параметре через {{code|#}}. | |||
* третий параметр: видимый текст ссылки. | |||
=== <code>remove_precision</code> === | === <code>remove_precision</code> === | ||
Убирает уточнение из первого параметра (см. {{t|без уточнения}}). | |||
=== <code>is_disambig</code> === | === <code>is_disambig</code> === | ||
| Строка 26: | Строка 34: | ||
* {{para|bold_links}} или {{para|ссылки болдом}}: при непустом и неложном значении каждая ссылка выделяется полужирным. | * {{para|bold_links}} или {{para|ссылки болдом}}: при непустом и неложном значении каждая ссылка выделяется полужирным. | ||
Возвращает таблицу, для неё предусмотрен метод {{code|tostring()}} и конкатенация. Именованные параметры этой таблицы — булевы переменные, истинные при обнаружении проблем. Отслеживаемые проблемы: | Возвращает таблицу, для неё предусмотрен метод {{code|tostring()}} и конкатенация. Именованные параметры этой таблицы — булевы переменные, истинные при обнаружении проблем. Отслеживаемые проблемы: {{code|red_link}}, {{code|bad_format}}, {{code|formatted}}, {{code|unparsable_link}}. Их описание [[#Отслеживаемые случаи|см. ниже]]. | ||
=== <code>hatnote</code> === | === <code>hatnote</code> === | ||
| Строка 35: | Строка 41: | ||
Параметры: | Параметры: | ||
* первый параметр — текст заметки. | * первый параметр — текст заметки. | ||
* {{para|id}}: id заметки. | |||
* {{para|extraclasses}}: дополнительные классы заметки. | * {{para|extraclasses}}: дополнительные классы заметки. | ||
* {{para|hide_disambig}}: при непустом и неложном значении к тексту добавляется класс {{code|dabhide}}, скрывающий подсветку для пользователей [[Тептар:Гаджеты/Выделение неоднозначностей|гаджета подсветки неоднозначностей]]. | * {{para|hide_disambig}}: при непустом и неложном значении к тексту добавляется класс {{code|dabhide}}, скрывающий подсветку для пользователей [[Тептар:Гаджеты/Выделение неоднозначностей|гаджета подсветки неоднозначностей]]. | ||
| Строка 70: | Строка 77: | ||
</source> | </source> | ||
Параметры: | {{видимый якорь|Параметры:|main-Параметры}} | ||
* {{para|prefix}} или {{para|префикс}}: обязательный параметр, текст перед списком ссылок. | * {{para|prefix}} или {{para|префикс}}: обязательный параметр, текст перед списком ссылок. | ||
* {{para|prefix_plural}} или {{para|префикс мн. ч.}}: если ссылок несколько, для префикса вместо предыдущего параметра будет использован этот. | * {{para|prefix_plural}} или {{para|префикс мн. ч.}}: если ссылок несколько, для префикса вместо предыдущего параметра будет использован этот. | ||
| Строка 76: | Строка 83: | ||
* {{para|dot}} или {{para|точка}}: при непустом и неложном значении выводится точка в конце. | * {{para|dot}} или {{para|точка}}: при непустом и неложном значении выводится точка в конце. | ||
* {{para|nocat}}: при непустом и неложном значении отключается категоризация. | * {{para|nocat}}: при непустом и неложном значении отключается категоризация. | ||
* {{para|preview_error}}: при непустом и неложном значении ошибка выводится только во время предпросмотра. | * {{para|empty_list_message}}: сообщение об ошибке, выводящееся при пустом списке ссылок. По умолчанию — «Не указано ни одной страницы». | ||
* {{para|preview_error}}: при непустом и неложном значении ошибка при пустом списке ссылок выводится только во время предпросмотра. | |||
Функция также принимает все параметры функций {{code|list}} и {{code|hatnote}} и передает их без изменения в эти функции. | Функция также принимает все параметры функций {{code|list}} и {{code|hatnote}} и передает их без изменения в эти функции. | ||
Вторым параметром (при вызове через другой модуль) функция принимает таблицу с переназначенными категориями. | Вторым параметром (при вызове через другой модуль) функция принимает таблицу с переназначенными категориями. Их идентификаторы [[#Отслеживаемые случаи|см. ниже]]: | ||
== Служебные функции == | == Служебные функции == | ||
Находятся в таблице {{code|tr}}, предназначены для отслеживания проблем и вывода сообщений об ошибках. Все функции можно вызывать только из других модулей. | Находятся в таблице {{code|tr}}, предназначены для отслеживания проблем и вывода сообщений об ошибках. Все функции можно вызывать только из других модулей. | ||
=== <code> | === <code>define_categories</code> === | ||
<source lang="lua">tr. | <source lang="lua">tr.define_categories(tracking_categories)</source> | ||
Создает объект, представляющий собой таблицу с категориями и функцией для их добавления. Первым параметром передается ассоциированный массив с идентификаторами отслеживающих категорий. | Создает объект, представляющий собой таблицу с категориями и функцией для их добавления. Первым параметром передается ассоциированный массив с идентификаторами отслеживающих категорий. | ||
==== <code>add</code> ==== | ==== <code>add</code> ==== | ||
<source lang="lua">categories:add(type, nocat)</source> | <source lang="lua">categories:add(type, nocat)</source> | ||
Добавляет в таблицу категории. Первый параметр — идентификатор, | или | ||
<source lang="lua">categories:add(category_name, nocat)</source> | |||
Добавляет в таблицу категории. Первый параметр — либо идентификатор, объявленный в {{code|define_categories()}}, либо название категории. Второй параметр — отключение категоризации. | |||
=== <code>error</code> === | === <code>error</code> === | ||
| Строка 102: | Строка 108: | ||
Параметры: | Параметры: | ||
* {{code|msg}}: текст сообщения. | * {{code|msg}}: текст сообщения. | ||
* {{code|categories}}: либо [[# | * {{code|categories}}: либо [[#define_categories|объект]], возвращаемый {{code|define_categories()}}, либо строка с категориями. | ||
* {{code|preview_only}}: при непустом и неложном значении ошибка выводится только во время предпросмотра. | * {{code|preview_only}}: при непустом и неложном значении ошибка выводится только во время предпросмотра. | ||
== Отслеживаемые случаи == | |||
* {{code|no_prefix}} — не задан префикс. Также выводится сообщение об ошибке. | |||
*: Категория: {{cl|Тептар:Страницы с модулем Hatnote без указания префикса}} | |||
* {{code|no_links}} — не задано ни одной ссылки. Также выводится сообщение об ошибке (либо в тексте статьи, либо только во время предварительного просмотра, подробнее см. [[#main-Параметры]]). | |||
*: Категория: {{cl|Тептар:Страницы с модулем Hatnote без ссылок}} | |||
* {{code|red_link}} — параметр содержит ссылку на несуществующую статью. | |||
*: Категория: {{cl|Тептар:Страницы с модулем Hatnote с красной ссылкой}} | |||
* {{code|bad_format}} — параметр содержит разделитель {{tc|!}} вместо параметра {{para|l''x''}} или лишние квадратные скобки. | |||
*: Категория: {{cl|Тептар:Страницы с модулем Hatnote с некорректно заполненными параметрами}} | |||
* {{code|formatted}} — параметр содержит {{code|<nowiki><span</nowiki>}} (в таком случае он не парсится, а выдаётся в готовом виде). Нужно для поддержки шаблонов {{t|не переведено}} в качестве параметров. | |||
*: Категория: {{cl|Тептар:Страницы с модулем Hatnote с готовым форматированием}} | |||
* {{code|unparsable_link}} — параметр содержит нестандартное оформление, которое не может быть разобрано модулем (например, {{tc|см. также|<nowiki>[https://example.com внешние ссылки]</nowiki>}} или {{tc|см. также|<nowiki>посторонний текст помимо [[ссылка|ссылки]]</nowiki>}}). | |||
*: Категория: {{cl|Тептар:Страницы с модулем Hatnote с нечитаемой ссылкой}} | |||
== Использование в других модулях == | |||
Некоторые функции используются в следующих модулях ({{plain link|url= https://massarn.com/w/index.php?search=insource%3A%2Frequire+%2A%5C%28%3F+%2A%5B%27%22%5D+%2A%28%5BMm%5Dodule%7C%5B%D0%9C%D0%BC%5D%D0%BE%D0%B4%D1%83%D0%BB%D1%8C%29+%2A%3A+%2A%5BHh%5Datnote+%2A%5B%27%22%5D%2F&title=%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F:%D0%9F%D0%BE%D0%B8%D1%81%D0%BA&profile=advanced&fulltext=1&ns828=1|name= проверить}}): | |||
* [[Модуль:ФИО]] | |||
* [[Модуль:Другие значения]] | |||
* [[Модуль:Основная статья]] | |||