Module:Hatnote list/doc

This is a documentation subpage for Module:Hatnote list (see that page for the module itself).
It contains usage information, categories and other content that is not part of the original module page.

Usage from wikitext[edit]

This module cannot be used from wikitext.

Usage from Lua[edit]

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[edit]

andList takes a list in table form, and returns a string with the list separated with "and" and commas as appropriate.

orList[edit]

orList takes a list in table form, and returns a string with the list separated with "or" and commas as appropriate.

forSee[edit]

_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.