Difference between revisions of "Hatnote list/doc"
(→Usage from wikitext: example) |
|||
| Line 4: | Line 4: | ||
== Usage from wikitext == | == Usage from wikitext == | ||
| − | This module is not designed be used directly from wikitext. | + | This module is not designed be used directly from wikitext even though <code>forSee</code> does take an initial <code>frame</code> argument and could potentially be used from wikitext, e.g.: |
| + | *{{#invoke:DemoTemplate|hatnote|PREFIX {{#invoke:Hatnote list|forSee|USE1|Article1|USE2|Article2}} POSTFIX}} | ||
== Usage from Lua == | == Usage from Lua == | ||
Revision as of 17:31, 6 October 2019
| This template is used on 705,000+ pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
| This is used in MediaWiki:Wantedpages-summary. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this 's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this . Please discuss any changes on the talk page before implementing them. |
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 For USE1, see [[:Article1]]. For USE2, see [[:Article2]]. 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, 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.