Module:Hatnote list/doc

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

This module depends on the following other modules:

Usage from wikitext

This module is not designed be used directly from wikitext even though forSee does take an initial frame argument and could potentially be used from wikitext, e.g.:

{{Hatnote|PREFIX {{#invoke:Hatnote list|forSee|{{Tl|For}}|Module:For|{{Tl|About}}|Module:About}} POSTFIX}} →

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

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

orList

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

forSee

_forSee takes three arguments:

A table of trimmed arguments with blanks removed
A "from" number with the index to start at
An options table

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