Moduł:Labelled list hatnote/doc

Dokumentacja dla tego modułu może zostać utworzona pod nazwą Moduł:Labelled list hatnote/doc/doc

Błąd skryptu: Błąd Lua w linii 1: '=' expected near 'modu'.

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 <code>labelledList()</code> wystarczy, aby zaimplementować większość takich szablonów:

<code><nowiki>{{#invoke:Przypis listy z etykietami|labelledList|Uniwersalna etykieta}}</nowiki></code>

lub

<code><nowiki>{{#invoke:Przypis listy z etykietami|labelledList|Liczba pojedyncza etykiety|Liczba mnoga etykiety}}</nowiki></code>

Na przykład podanie "Zobacz również" zamiast "Etykiety uniwersalnej" powiela funkcjonalność {{tl|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) {{tl|main}}.

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

Przykład: <source lang="lua">
local mLabelledList = require('Module:Labelled list hatnote')
local pages = mLabelledList.preprocessDisplays(args)
</source>

=== _labelledList ===
W przypadku modułów, które muszą nieznacznie zmodyfikować funkcjonalność podczas korzystania z niej, <code>_labelledList()</code> zapewnia pewną elastyczność. Wymaga trzech parametrów:
# Lista stron, najlepiej wstępnie przetworzona i skompresowana przez <code>preprocessDisplays</code>.
# 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 <code>template</code> z pełnym tytułem szablonu. Domyślnie tytuł tego modułu.
#* ciąg <code>category</code> (lub zero) pobrany przez <code>makeWikitextError</code> z [[Moduł:Hatnote]], aby opcjonalnie wyłączyć kategorie błędów.
#* ciąg <code>selfref</code> (lub zero) pobrany przez <code>_hatnote</code> w celu włączenia opcji selfref.

Przykład: <source lang="lua">
local mLabelledList = require('Module:Labelled list hatnote')
return mLabelledList._labelledList(pages, labels, options)
</source>

== 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 <code>_labelledList()</code> i nie zawierają elementu <code>template</code> 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 <code>template</code> tabeli <code>_labelledList()</code> <code>options</code>.

<noinclude>
[[Kategoria:Dokumentacje modułów]]
</noinclude>
<includeonly>
[[Kategoria:Moduły]]
</includeonly>