Module:Labelled list hatnote/doc

This module provides a handful of functions that make it easy to implement hatnotes that take the form of a label in front of a list of pages.

labelledList
Invoking the  function is enough to implement most such templates:

or

For example, providing "See also" instead of "Universal label" duplicates the functionality of see also, while providing "Main article" and "Main articles" instead of "Singular label" and "Plural label" duplicates the (article namespace) functionality of main.

preprocessDisplays
The  function takes a raw list of arguments and combines in any display arguments. For example,  initially has the arguments table  ; this table would combine those into the table. It overrides manual piping (e.g.  →  ) and compresses sparse arrays if a parameter is skipped or left empty.

Example:

_labelledList
For modules that need to modify the functionality slightly while still using it,  provides some flexibility. It takes three parameters:
 * 1) A pages list, preferably preprocessed and compressed by
 * 2) 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.
 * 3) An options table, preferably containing:
 * 4) * a  string with the full title of the template. Defaults to the title of this module.
 * 5) * a  string (or nil) as taken by   from Module:Hatnote, to optionally disable error categories
 * 6) * a  string (or nil) as taken by   to enable the selfref option

Example:

Errors
This module causes templates based on it to produce an error message if no page names are provided as template parameters. Normally, these should lead back to "Errors" sections in the documentation of those templates. However, if those templates use a module with  and don't provide a   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  item of the     table.