Module:Hatnote list/doc
This is the documentation page for Module:Hatnote list
![]() | This Lua module is used on 705,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. |
![]() | This module is used in MediaWiki:Wantedpages-summary. Changes to it can cause immediate changes to the Starfleet logistics user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them. |
Usage from wikitext[edit source]
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 source]
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 source]
andList
takes a list in table form, and returns a string with the list separated with "and" and commas as appropriate.
orList[edit source]
orList
takes a list in table form, and returns a string with the list separated with "or" and commas as appropriate.
forSee[edit source]
_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.
External links[edit source]
- Module:Hatnote list/doc at Wikipedia, the free Terran-based encyclopedia that anyone can edit.