Module:Disambiguation/doc
From Thetacola Wiki
Jump to navigationJump to search
This is the documentation page for Module:Disambiguation
| File:Ambox warning orange.svg | This Lua module is used on approximately 317,000 pages, or roughly 25340% of all 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 detects if a given page is a disambiguation page.
Usage
{{#invoke:Disambiguation|isDisambiguationPage|Page title}}
- returns
yesif the page is a disambiguation page, or nothing if the page is not a disambiguation page
Examples:
{{#invoke:Disambiguation|isDisambiguationPage|Paris}}→{{#invoke:Disambiguation|isDisambiguationPage|New}}→{{#invoke:Disambiguation|isDisambiguationPage|Black swan (disambiguation)}}→ yes
You can also use magic words like {{SUBJECTPAGENAME}}:
{{#invoke:Disambiguation|isDisambiguationPage|{{SUBJECTPAGENAME}}}}→
Usage within Lua modules
Import this module, e.g with
local mDisambiguation = require('Module:Disambiguation')Then you can use the functions isDisambiguation and _isDisambiguationPage.
If you have already have a Title object for the page to check, get the content using the title object's getContent() method, and pass that into isDisambiguation:
local isDab = mDisambiguation.isDisambiguation(content) -- returns true or false- (where
contentis a string, the wikitext content of page to check)
If you don't otherwise need the title, you can pass in the page name to _isDisambiguationPage:
local isDab = mDisambiguation._isDisambiguationPage(pageName) -- returns true or false- (where
pageNameis a string, the name of page to check)
