Module:Disambiguation/doc
From Wikipedia, the free encyclopedia
icon This is a documentation subpage for Module:Disambiguation.
It may contain usage information, categories and other content that is not part of the original module page.
It may contain usage information, categories and other content that is not part of the original module page.
This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.
[画像:Warning] This Lua module is used in system messages, and on approximately 251,000 pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
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. Please discuss changes on the talk page before implementing them.
Changes to it can cause immediate changes to the Wikipedia user interface.
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. Please discuss changes on the talk page before implementing them.
This module depends on the following other modules:
This module detects if a given page is a disambiguation page.
Usage
[edit ]{{#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}}→ yes{{#invoke:Disambiguation|isDisambiguationPage|Black swan (disambiguation)}}→ yes
You can also use magic words like {{SUBJECTPAGENAME }}:
{{#invoke:Disambiguation|isDisambiguationPage|{{SUBJECTPAGENAME}}}}→
Usage within Lua modules
[edit ]Import this module, e.g with
localmDisambiguation=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:
localisDab=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:
localisDab=mDisambiguation._isDisambiguationPage(pageName)-- returns true or false
- (where
pageNameis 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 by templates such as {{italic disambiguation }}. These templates should be added to the falsePositives list in the code to exclude them.
- The list of disambiguation templates is maintained at Module:Disambiguation/templates.