Модуль:Hatnote/doc: различия между версиями

Материал из Народные сказки
Перейти к навигации Перейти к поиску
Нет описания правки
Нет описания правки
Строка 34: Строка 34:
* {{Para|bold_links}} или {{Para|ссылки болдом}}: при непустом и неложном значении каждая ссылка выделяется полужирным.
* {{Para|bold_links}} или {{Para|ссылки болдом}}: при непустом и неложном значении каждая ссылка выделяется полужирным.


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


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


=== <code>main</code> ===
=== <code>main</code> ===
Строка 85: Строка 85:
* {{Para|empty_list_message}}: сообщение об ошибке, выводящееся при пустом списке ссылок. По умолчанию — «Не указано ни одной страницы».
* {{Para|empty_list_message}}: сообщение об ошибке, выводящееся при пустом списке ссылок. По умолчанию — «Не указано ни одной страницы».
* {{Para|preview_error}}: при непустом и неложном значении ошибка при пустом списке ссылок выводится только во время предпросмотра.
* {{Para|preview_error}}: при непустом и неложном значении ошибка при пустом списке ссылок выводится только во время предпросмотра.
Функция также принимает все параметры функций {{code|list}} и {{code|hatnote}} и передает их без изменения в эти функции.
Функция также принимает все параметры функций {{Code|list}} и {{Code|hatnote}} и передает их без изменения в эти функции.


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


== Служебные функции ==
== Служебные функции ==
Находятся в таблице {{code|tr}}, предназначены для отслеживания проблем и вывода сообщений об ошибках. Все функции можно вызывать только из других модулей.
Находятся в таблице {{Code|tr}}, предназначены для отслеживания проблем и вывода сообщений об ошибках. Все функции можно вызывать только из других модулей.


=== <code>define_categories</code> ===
=== <code>define_categories</code> ===
Строка 100: Строка 100:
или
или
<source lang="lua">categories:add(category_name, nocat)</source>
<source lang="lua">categories:add(category_name, nocat)</source>
Добавляет в таблицу категории. Первый параметр — либо идентификатор, объявленный в {{code|define_categories()}}, либо название категории. Второй параметр — отключение категоризации.
Добавляет в таблицу категории. Первый параметр — либо идентификатор, объявленный в {{Code|define_categories()}}, либо название категории. Второй параметр — отключение категоризации.


=== <code>error</code> ===
=== <code>error</code> ===
Строка 107: Строка 107:


Параметры:
Параметры:
* {{code|msg}}: текст сообщения.
* {{Code|msg}}: текст сообщения.
* {{code|categories}}: либо [[#define_categories|объект]], возвращаемый {{code|define_categories()}}, либо строка с категориями.
* {{Code|categories}}: либо [[#define_categories|объект]], возвращаемый {{Code|define_categories()}}, либо строка с категориями.
* {{code|preview_only}}: при непустом и неложном значении ошибка выводится только во время предпросмотра.
* {{Code|preview_only}}: при непустом и неложном значении ошибка выводится только во время предпросмотра.


== Отслеживаемые случаи ==
== Отслеживаемые случаи ==
* {{code|no_prefix}} — не задан префикс. Также выводится сообщение об ошибке.
* {{Code|no_prefix}} — не задан префикс. Также выводится сообщение об ошибке.
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote без указания префикса}}
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote без указания префикса}}
* {{code|no_links}} — не задано ни одной ссылки. Также выводится сообщение об ошибке (либо в тексте статьи, либо только во время предварительного просмотра, подробнее см. [[#main-Параметры]]).
* {{Code|no_links}} — не задано ни одной ссылки. Также выводится сообщение об ошибке (либо в тексте статьи, либо только во время предварительного просмотра, подробнее см. [[#main-Параметры]]).
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote без ссылок}}
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote без ссылок}}
* {{code|red_link}} — параметр содержит ссылку на несуществующую статью.
* {{Code|red_link}} — параметр содержит ссылку на несуществующую статью.
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с красной ссылкой}}
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с красной ссылкой}}
* {{code|bad_format}} — параметр содержит разделитель {{Tc|!}} вместо параметра {{Para|l''x''}} или лишние квадратные скобки.
* {{Code|bad_format}} — параметр содержит разделитель {{Tc|!}} вместо параметра {{Para|l''x''}} или лишние квадратные скобки.
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с некорректно заполненными параметрами}}
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с некорректно заполненными параметрами}}
* {{code|formatted}} — параметр содержит {{code|<nowiki><span</nowiki>}} (в таком случае он не парсится, а выдаётся в готовом виде). Нужно для поддержки шаблонов {{T|не переведено}} в качестве параметров.
* {{Code|formatted}} — параметр содержит {{Code|<nowiki><span</nowiki>}} (в таком случае он не парсится, а выдаётся в готовом виде). Нужно для поддержки шаблонов {{T|не переведено}} в качестве параметров.
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с готовым форматированием}}
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с готовым форматированием}}
* {{code|unparsable_link}} — параметр содержит нестандартное оформление, которое не может быть разобрано модулем (например, {{Tc|см. также|<nowiki>[https://example.com внешние ссылки]</nowiki>}} или {{Tc|см. также|<nowiki>посторонний текст помимо [[ссылка|ссылки]]</nowiki>}}).
* {{Code|unparsable_link}} — параметр содержит нестандартное оформление, которое не может быть разобрано модулем (например, {{Tc|см. также|<nowiki>[https://example.com внешние ссылки]</nowiki>}} или {{Tc|см. также|<nowiki>посторонний текст помимо [[ссылка|ссылки]]</nowiki>}}).
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с нечитаемой ссылкой}}
*: Категория: {{cl|Википедия:Страницы с модулем Hatnote с нечитаемой ссылкой}}



Версия от 18:52, 14 мая 2023

Шаблон:Module rating

Модуль предназначен для реализации hatnote-шаблонов (например, {{Основная статья}}, {{См. также}}). Также он содержит несколько функций для работы со ссылками и отслеживания ошибок. См. тесты на странице Шаблон:Основная статья/тесты.

Основные функции

Основные функции содержатся в таблице P, все функции можно вызывать как из других модулей, так и через Шаблон:mwmw. При вызове из модуля функции принимают первым параметром таблицу с аргументами. Все описанные ниже параметры являются аргументами этой таблицы. Некоторые параметры принимают булевоподобные значения: их перечисление можно найти здесь.

parse_link

Принимает на вход ссылку, возвращает два значения: целевую страницу и видимую часть ссылки. Если ссылку не удалось разобрать, возвращает Nil. Наличие квадратных скобок не обязательно.

format_link

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

Параметры:

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

remove_precision

Убирает уточнение из первого параметра (см. {{без уточнения}}).

is_disambig

Функция, определяющая, является ли первый параметр страницей разрешения неоднозначности. Список шаблонов неоднозначностей берется со страницы MediaWiki:Disambiguationspage.

list

Формирует список из вики-ссылок.

Параметры:

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

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

hatnote

Формирует код <div class="hatnote">...</div>.

Параметры:

  • первый параметр — текст заметки.
  • |id =: id заметки.
  • |extraclasses =: дополнительные классы заметки.
  • |hide_disambig =: при непустом и неложном значении к тексту добавляется класс dabhide, скрывающий подсветку для пользователей гаджета подсветки неоднозначностей.

main

Генерирует текст-заметку. Позволяет ссылаться на неограниченное число страниц. Синтаксис:

  • вызов из вики-текста:
{{#invoke:Hatnote|main|префикс= префиксШаблон:optp}}
  • вызов из другого модуля:
-- подключение модуля
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 = 'Википедия:Статьи с шаблоном «См. также» с красными ссылками'
})

Параметры:

  • |prefix = или |префикс =: обязательный параметр, текст перед списком ссылок.
  • |prefix_plural = или |префикс мн. ч. =: если ссылок несколько, для префикса вместо предыдущего параметра будет использован этот.
  • |sep = или |разделитель =: разделитель между префиксом и списком ссылок.
  • |dot = или |точка =: при непустом и неложном значении выводится точка в конце.
  • |nocat =: при непустом и неложном значении отключается категоризация.
  • |empty_list_message =: сообщение об ошибке, выводящееся при пустом списке ссылок. По умолчанию — «Не указано ни одной страницы».
  • |preview_error =: при непустом и неложном значении ошибка при пустом списке ссылок выводится только во время предпросмотра.

Функция также принимает все параметры функций list и hatnote и передает их без изменения в эти функции.

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

Служебные функции

Находятся в таблице tr, предназначены для отслеживания проблем и вывода сообщений об ошибках. Все функции можно вызывать только из других модулей.

define_categories

tr.define_categories(tracking_categories)

Создает объект, представляющий собой таблицу с категориями и функцией для их добавления. Первым параметром передается ассоциированный массив с идентификаторами отслеживающих категорий.

add

categories:add(type, nocat)

или

categories:add(category_name, nocat)

Добавляет в таблицу категории. Первый параметр — либо идентификатор, объявленный в define_categories(), либо название категории. Второй параметр — отключение категоризации.

error

tr.error(msg, categories, preview_only)

Выводит сообщение об ошибке. Если ошибка генерируется шаблоном, то отображается название этого шаблона; если прямым вызовом через Шаблон:mwmw, то название вызываемого модуля.

Параметры:

  • msg: текст сообщения.
  • categories: либо объект, возвращаемый define_categories(), либо строка с категориями.
  • preview_only: при непустом и неложном значении ошибка выводится только во время предпросмотра.

Отслеживаемые случаи

  • no_prefix — не задан префикс. Также выводится сообщение об ошибке.
    Категория: Шаблон:cl
  • no_links — не задано ни одной ссылки. Также выводится сообщение об ошибке (либо в тексте статьи, либо только во время предварительного просмотра, подробнее см. #main-Параметры).
    Категория: Шаблон:cl
  • red_link — параметр содержит ссылку на несуществующую статью.
    Категория: Шаблон:cl
  • bad_format — параметр содержит разделитель {{!}} вместо параметра |lx = или лишние квадратные скобки.
    Категория: Шаблон:cl
  • formatted — параметр содержит &lt;span (в таком случае он не парсится, а выдаётся в готовом виде). Нужно для поддержки шаблонов {{не переведено}} в качестве параметров.
    Категория: Шаблон:cl
  • unparsable_link — параметр содержит нестандартное оформление, которое не может быть разобрано модулем (например, {{см. также|[https://example.com внешние ссылки]}} или {{см. также|посторонний текст помимо [[ссылка|ссылки]]}}).
    Категория: Шаблон:cl

Использование в других модулях

Некоторые функции используются в следующих модулях (Шаблон:plain link):