This is the documentation page for Module:Hatnote list
|This Lua module is used on 710,000+ pages.|
To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the module's /sandbox or /testcases subpages. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them.
Usage from wikitext
This module cannot be used from wikitext.
Usage from Lua
To call the module, use
local mHatList = require('Module:Hatnote list')
or similar, then access its methods through the
mHatList variable (or whatever was used).
andList takes a list in table form, and returns a string with the list separated with "and" and commas as appropriate.
orList takes a list in table form, and returns a string with the list separated with "or" and commas as appropriate.
_forSee takes three arguments: a table of trimmed arguments with blanks removed, a "from" number with the index to start at, and an options table, and returns a string with a number of "
For X, see [[Y]]" sentences. The links are formatted using the methods from Module:Hatnote.
As a convenience, the
forSee method (without the leading underscore) takes the same arguments except with a frame instead of an args table, using
getArgs() from Module:Arguments to preprocess the arguments.