Moduł:Labelled list hatnote/doc

Ten moduł zapewnia garść funkcji ułatwiających wdrażanie notatek, które mają postać etykiety przed listą stron.

Sposób użycia[]

labelledList[]

Wywołanie funkcji labelledList() wystarczy, aby zaimplementować większość takich szablonów:

{{#invoke:Przypis listy z etykietami|labelledList|Uniwersalna etykieta}}

lub

{{#invoke:Przypis listy z etykietami|labelledList|Liczba pojedyncza etykiety|Liczba mnoga etykiety}}

Na przykład podanie "Zobacz również" zamiast "Etykiety uniwersalnej" powiela funkcjonalność {{see also}}, jednocześnie zapewniając "Artykuł główny" i "Artykuły główne" zamiast "Liczba pojedyncza etykiety" i "Liczba mnoga etykiety" funkcja (przestrzeni nazw artykułów) {{main}}.

preprocessDisplays[]

Funkcja preprocessDisplays() pobiera nieprzetworzoną listę argumentów i łączy się z dowolnymi argumentami wyświetlanymi. Na przykład {{see also|1|l1=One}} początkowo ma tabelę argumentów {'1', ['l1'] = 'One'}; ta tabela połączyłaby je w tabeli {'1|One'}. Zastępuje ręczne "piping" (np. {{see also|1{{!}}2|l1=One}} → {'1|One'}) i kompresuje rzadkie tablice, jeśli parametr zostanie pominięty lub pozostanie pusty.

Przykład:

local mLabelledList = require('Module:Labelled list hatnote')
local pages = mLabelledList.preprocessDisplays(args)

_labelledList[]

W przypadku modułów, które muszą nieznacznie zmodyfikować funkcjonalność podczas korzystania z niej, _labelledList() zapewnia pewną elastyczność. Wymaga trzech parametrów:

Lista stron, najlepiej wstępnie przetworzona i skompresowana przez preprocessDisplays.
Tabela etykiet, w której pierwszym elementem jest etykieta pojedyncza lub uniwersalna, a drugim etykietą w liczbie mnogiej lub kopią pierwszej.
Tabela opcji, najlepiej zawierająca:
- ciąg template z pełnym tytułem szablonu. Domyślnie tytuł tego modułu.
- ciąg category (lub zero) pobrany przez makeWikitextError z Moduł:Hatnote, aby opcjonalnie wyłączyć kategorie błędów.
- ciąg selfref (lub zero) pobrany przez _hatnote w celu włączenia opcji selfref.

Przykład:

local mLabelledList = require('Module:Labelled list hatnote')
return mLabelledList._labelledList(pages, labels, options)

Błędy[]

Ten moduł powoduje, że oparte na nim szablony generują komunikat o błędzie, jeśli nie podano nazw stron jako parametrów szablonów. Zwykle powinny one prowadzić z powrotem do sekcji "Błędy" w dokumentacji tych szablonów. Jeśli jednak te szablony używają modułu z _labelledList() i nie zawierają elementu template w tabeli opcji, błąd domyślnie prowadzi do powrotu tutaj. Błąd można rozwiązać, podając co najmniej jeden poprawny parametr nazwy strony dla danego szablonu; problem w szablonie można rozwiązać, dostarczając pewną wartość do elementu template tabeli _labelledList() options.