More actions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{doc sub}} | |||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
{{Lua|Module:Format link|Module:Hatnote|Module:Arguments}} | {{Lua|Module:Format link|Module:Hatnote|Module:Arguments}} | ||
== Usage from wikitext == | == Usage from wikitext == | ||
| Line 26: | Line 26: | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | ||
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
[[Category:Modules]] | |||
[[Category:Hatnote modules| ]] | [[Category:Hatnote modules| ]] | ||
}}</includeonly><noinclude> | }}</includeonly><noinclude> | ||
[[Category:Module documentation pages]] | [[Category:Module documentation pages]] | ||
</noinclude> | </noinclude> | ||
Revision as of 00:35, 1 March 2025
 | 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 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
Cite error: Closing </ref> missing for <ref> tag</ref>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, 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.