模組:Labelled list hatnote/doc

此模組提供一些程式以實現置於頁面頂部的簡短註解，亦即頂註，例如：

用法

labelledList

Invoking the labelledList()程式足夠實現大部分此類模板：

{{#invoke:Labelled list hatnote|labelledList|Universal label}}

或

{{#invoke:Labelled list hatnote|labelledList|Singular label|Plural label}}

For example, providing 「參見」 instead of 「Universal label」 duplicates the functionality of {{See also}}, while providing 「主條目」 instead of "Singular label" and "Plural label" duplicates the (article namespace) functionality of {{Main}}.

preprocessDisplays

preprocessDisplays()程式 takes a raw list of arguments and combines in any display arguments. 擧例説， {{see also|1|l1=One}} initially has the arguments table {'1', ['l1'] = 'One'}; this table would combine those into the table {'1|One'}. It overrides manual piping (e.g. {{see also|1{{!}}2|l1=One}} → {'1|One'}) and compresses sparse arrays if a parameter is skipped or left empty.

例子：

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

_labelledList

For modules that need to modify the functionality slightly while still using it, _labelledList() provides some flexibility. It takes three parameters:

A pages list, preferably preprocessed and compressed by preprocessDisplays
A labels table, where the first item is the singular or universal label, and the second either a plural label or a copy of the first.
An options table, preferably containing:
- a template string with the full title of the template. Defaults to the title of this module.
- a category string (or nil) as taken by makeWikitextError from Module:Hatnote, to optionally disable error categories
- a selfref string (or nil) as taken by _hatnote to enable the selfref option

例子：

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

錯誤

在使用基於此模塊的模板時而不提供頁面名稱作為參數的話，會顯示錯誤訊息。正常來説，這些訊息會連結到那些模板的説明文檔的「錯誤」段落。不過，if those templates use a module with _labelledList() and don't provide a template item in their options table, that error defaults to leading back here. The error can be solved by providing at least one valid page-name parameter to the template in question; the problem in the template can be fixed by providing some value to the template item of the _labelledList() options table.