Module:Disambiguation/doc explained

This module detects if a given page is a disambiguation page.

Usage

{{#invoke:Disambiguation|isDisambiguationPage|Page title}}

returns yes if the page is a disambiguation page, or nothing if the page is not a disambiguation page

Examples:

• <nowiki>{{#invoke:Disambiguation|isDisambiguationPage|</nowiki>[[Paris]]}} →
• <nowiki>{{#invoke:Disambiguation|isDisambiguationPage|</nowiki>[[New]]}} →
• <nowiki>{{#invoke:Disambiguation|isDisambiguationPage|</nowiki>[[Black swan (disambiguation)]]}} →

You can also use magic words like :

• <nowiki>{{#invoke:Disambiguation|isDisambiguationPage|{{SUBJECTPAGENAME}}</nowiki>}} →

Usage within Lua modules

Import this module, e.g withlocal 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 content is 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 pageName is a string, the name of page to check)

Internal operations

• Although set index articles are treated by some templates as disambiguation pages, they are actually considered a special type of list and are not treated as disambiguation pages by this module
• As this module relies on detecting templates with names like "disambiguation" in the article text, it is subject to false positives by templates such as . These templates should be added to the falsePositives list in the code to exclude them.
• The list of disambiguation templates is maintained at .