Moduł:Labelled list hatnote

Dokumentacja Poniższa dokumentacja jest załączona do Moduł:Labelled list hatnote/doc. (edytuj | historia)

[wyczyść]
[↓ przejdź do kodu modułu ↓]

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:

1. Lista stron, najlepiej wstępnie przetworzona i skompresowana przez preprocessDisplays.
2. Tabela etykiet, w której pierwszym elementem jest etykieta pojedyncza lub uniwersalna, a drugim etykietą w liczbie mnogiej lub kopią pierwszej.
3. 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.

---

--------------------------------------------------------------------------------
--                               Labelled list                                --
--                                                                            --
-- This module does the core work of creating a hatnote composed of a list    --
-- prefixed by a colon-terminated label, i.e. "LABEL: [andList of pages]",    --
-- for {{see also}} and similar templates.                                    --
--------------------------------------------------------------------------------

local mHatnote = require('Module:Hatnote')
local mHatlist = require('Module:Hatnote list')
local mArguments --initialize lazily
local p = {}

-- Defaults global to this module
local defaults = {
	label = 'See also', --Final fallback for label argument
	labelForm = '%s: %s',
	prefixes = {'label', 'label ', 'l'},
	template = 'Module:Labelled list hatnote'
}

-- Helper function that pre-combines display parameters into page arguments.
-- Also compresses sparse arrays, as a desirable side-effect.
function p.preprocessDisplays (args, prefixes)
	-- Prefixes specify which parameters, in order, to check for display options
	-- They each have numbers auto-appended, e.g. 'label1', 'label 1', & 'l1'
	prefixes = prefixes or defaults.prefixes
	local pages = {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			local display
			for i = 1, #prefixes do
				display = args[prefixes[i] .. k]
				if display then break end
			end
			local page = display and
				string.format('%s|%s', string.gsub(v, '|.*$', ''), display) or v
			pages[#pages + 1] = page
		end
	end
	return pages
end

-- Produces a labelled pages-list hatnote.
-- The main frame (template definition) takes 1 or 2 arguments, for a singular
-- and (optionally) plural label respectively:
-- * {{#invoke:Labelled list hatnote|labelledList|Singular label|Plural label}}
-- The resulting template takes pagename & label parameters normally.
function p.labelledList (frame)
	mArguments = require('Module:Arguments')
	local labels = {frame.args[1] or defaults.label}
	labels[2] = frame.args[2] or labels[1]
	local template = frame:getParent():getTitle()
	local args = mArguments.getArgs(frame, {parentOnly = true})
	local pages = p.preprocessDisplays(args)
	local options = {
		extraclasses = frame.args.extraclasses,
		category = args.category,
		selfref = frame.args.selfref or args.selfref,
		template = template
	}
	return p._labelledList(pages, labels, options)
end

function p._labelledList (pages, labels, options)
	labels = labels or {}
	if #pages == 0 then
		return mHatnote.makeWikitextError(
			'no page names specified',
			(options.template or defaults.template) .. '#Errors',
			options.category
		)
	end
	label = (#pages == 1 and labels[1] or labels[2]) or defaults.label
	local text = string.format(
		options.labelForm or defaults.labelForm,
		label,
		mHatlist.andList(pages, true)
	)
	local hnOptions = {
		extraclasses = options.extraclasses,
		selfref = options.selfref
	}
	return mHatnote._hatnote(text, hnOptions)
end

return p