This is a documentation subpage for Module:Hatnote list. It may contain usage information, categories and other content that is not part of the original module page. |
This Lua module is used in MediaWiki:Wantedpages-summary, and on approximately 1,170,000 pages, or roughly 2% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This module depends on the following other modules: |
Usage from wikitext edit
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 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
Cite error: A <ref>
tag is missing the closing </ref>
(see the help page).</ref>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.