Module:Disambiguation/doc

This is a documentation subpage for Module:Disambiguation (see that page for the module itself).
It contains usage information, categories and other content that is not part of the original module page.

This module is used in system messages.
Changes to it can cause immediate changes to the Festipedia user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them.

This module depends on the following other modules:

Module:Redirect

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

Usage[edit]

{{#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:

{{#invoke:Disambiguation|isDisambiguationPage|Merddin Emrys}} →
{{#invoke:Disambiguation|isDisambiguationPage|Charles Easton Spooner}} →
{{#invoke:Disambiguation|isDisambiguationPage|Beddgelert}} → yes

You can also use magic words like {{SUBJECTPAGENAME}}:

{{#invoke:Disambiguation|isDisambiguationPage|{{SUBJECTPAGENAME}}}} →

Usage within Lua modules[edit]

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 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[edit]

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. Templates causing false positives should be added to the falsePositives list in the code to exclude them.
The list of disambiguation templates is maintained at Module:Disambiguation/templates.