Module:Other uses/doc: Difference between revisions
SkyWarrior (talk | contribs) m unexplained content removal |
High-use template |
||
Line 1: | Line 1: | ||
<!-- 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]]) --> |
||
{{high-risk |
{{high-risk}} |
||
{{Module rating|protected}} |
{{Module rating|protected}} |
||
This module produces an "other uses" hatnote for linking to disambiguation pages. It implements the {{tl|other uses}} template. |
This module produces an "other uses" hatnote for linking to disambiguation pages. It implements the {{tl|other uses}} template. |
||
Line 41: | Line 41: | ||
<!-- Categories below this line, please; interwikis at Wikidata --> |
<!-- Categories below this line, please; interwikis at Wikidata --> |
||
[[Category:Hatnote modules]] |
[[Category:Hatnote modules]] |
||
}}</includeonly> |
}}</includeonly> |
Latest revision as of 10:27, 21 April 2023
![]() | This Lua module is used on approximately 143,000 pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This module produces an "other uses" hatnote for linking to disambiguation pages. It implements the {{other uses}} template.
Usage from wikitext
[edit]otheruses()
[edit]The otheruses()
function directly implements {{other uses}} and probably shouldn't be used anywhere else.
otherX()
[edit]The otherX()
function allows direct implementation of templates that differ from {{other uses}} in only phrasing. For example, where {{other uses}} is phrased with "other uses", {{other places}} is phrased with "other places with the same name" and can be implemented using otherX()
, which takes the custom phrasing as its parameter at the module invocation. {{other places}} in particular could be implemented with this wikitext:
{{#invoke:other uses|otherX|places with the same name}}
Note that the leading "other" is automatically supplied; if a template would not use this phrasing, it should not use otherX()
.
Usage from Lua
[edit]To use this module from Lua, first load the module:
local mOtheruses = require('Module:Other uses')
The module functions can then be used through the _otheruses()
function:
mOtheruses._otheruses(args, options)
Parameters of _otheruses()
[edit]- args
- A table containing strings of link text, without brackets. For example,
{"PAGE1", "PAGE2#SECTION", "PAGE3|LABEL"}
. Make sure that there are no gaps or nil values, as that can confuse themw.text.listToText()
function the module uses. If in doubt, usecompressSparseArray()
from Module:TableTools. This may be empty or nil. - options
- A table containing a number of optional named values; you must supply at least one of
options.defaultPage
oroptions.title
; in most cases setting the latter tomw.title.getCurrentTitle().prefixedText
is advisable. The following options are supported:defaultPage
: String; completely overrides the linked page when no arguments are suppliedtitle
: String; sets the title used before the "(disambiguation)" suffix.disambiguator
: String; replaces "disambiguation" in the suffixotherText
: String; replaces "uses" in "other uses"