Module:Hatnote list/doc
Sarna News
- HEXTECH Review - Wave 3 Brings More Urban Options To Your Battlefield
- Your BattleTech News Round-Up For March, 2024
- Crashing 'Mechs With Jennifer Brozek, Author Of The Rogue Academy Trilogy
- Getting The Word Out With Rem Alternis, Catalyst Community & Marketing Director
- Bad 'Mechs - Yeoman
- Read more →
 | 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 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. |
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 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.