Module:See also/doc
This is the documentation page for Module:See also
 | This Lua module is used on 108,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
This module produces a "See also: a, b, and c" link. It implements the {{see also}} template.
Usage from wikitext[edit source]
This module cannot be used directly from #invoke. Instead, it can only be used through the {{see also}} template. Please see the template page for documentation.
Usage from other Lua modules[edit source]
Load the module:
local mSeealso = require('Module:See also')
You can then use the _seealso function like this:
mSeealso._seeAlso(args, options)
The args parameter should be a table of page link strings; if they use custom display values, each string should be preprocessed into a single piped string (e.g. page|display value). Links specifying a section are automatically formatted as page § section, rather than the MediaWiki default of page#section, if no custom display value is set.
The options variable is an optional configuration table. The following field is recognised:
- selfref - set to true to flag the output as a self-reference to Wikipedia. (See the {{selfref}} template for more details on self-references.)
Example 1[edit source]
mSeealso._seeAlso({'A'})
Produces:
<div role="note" class="hatnote">See also: [[A]]</div>
Displays as:
Example 2[edit source]
mSeealso._seeAlso({'A', 'B', 'C#D'})
Produces:
<div role="note" class="hatnote">See also: [[A]], [[B]], and [[C#D|C § D]]</div>
Displays as:
Example 3[edit source]
mSeealso._seeAlso({'A|the letter "A"', 'B|the letter "B"', 'C|the letter "C"'}, {selfref = true})
Produces:
<div role="note" class="hatnote selfref">See also: [[A|the letter "A"]], [[B|the letter "B"]], and [[C|the letter "C"]]</div>
Displays as:
Technical details[edit source]
This module uses Module:Hatnote to format the hatnote text, Module:Hatnote list to process the list of links, and Module:Arguments to fetch the arguments from wikitext.
