Module:Disambiguation/doc - Revision history

Matt at 22:15, 9 April 2025

2025-04-09T22:15:06Z

← Older revision		Revision as of 18:15, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
	~~{{used in system}}~~
	{{lua\|Module:Redirect}}		{{lua\|Module:Redirect}}
	This module detects if a given page is a disambiguation page.		This module detects if a given page is a disambiguation page.

Matt at 21:06, 6 April 2025

2025-04-06T21:06:07Z

Matt at 20:52, 5 March 2025

2025-03-05T20:52:10Z

← Older revision		Revision as of 16:52, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{used in system}}		{{used in system}}

Matt: Protected "Module:Disambiguation/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T19:25:48Z

Protected "Module:Disambiguation/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 15:25, 5 March 2025
(No difference)

Matt: Created page with "{{Module rating|protected}} {{used in system}} {{lua|Module:Redirect}} 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: * {{#invoke:Disambiguation|isDisambiguationPage|Paris}} → {{#invoke:Disambiguation|isDisambiguat..."

2025-03-04T18:02:27Z

Created page with "{{Module rating|protected}} {{used in system}} {{lua|Module:Redirect}} This module detects if a given page is a disambiguation page. ==Usage== <pre> {{#invoke:Disambiguation|isDisambiguationPage|Page title}} </pre> :returns <code>yes</code> if the page is a disambiguation page, or nothing if the page is not a disambiguation page Examples: * <code><nowiki>{{#invoke:Disambiguation|isDisambiguationPage|</nowiki>Paris}}</code> → {{#invoke:Disambiguation|isDisambiguat..."

New page

{{Module rating|protected}}
{{used in system}}
{{lua|Module:Redirect}}
This module detects if a given page is a disambiguation page.

==Usage==
<pre>
{{#invoke:Disambiguation|isDisambiguationPage|Page title}}
</pre>
:returns <code>yes</code> if the page is a disambiguation page, or nothing if the page is not a disambiguation page

Examples:
* <code><nowiki>{{#invoke:Disambiguation|isDisambiguationPage|</nowiki>[[Paris]]}}</code> → {{#invoke:Disambiguation|isDisambiguationPage|Paris}}
* <code><nowiki>{{#invoke:Disambiguation|isDisambiguationPage|</nowiki>[[New]]}}</code> → {{#invoke:Disambiguation|isDisambiguationPage|New}}
* <code><nowiki>{{#invoke:Disambiguation|isDisambiguationPage|</nowiki>[[Black swan (disambiguation)]]}}</code> → {{#invoke:Disambiguation|isDisambiguationPage|Black swan (disambiguation)}}
You can also use magic words like {{tl|SUBJECTPAGENAME}}:
* <code><nowiki>{{#invoke:Disambiguation|isDisambiguationPage|{{SUBJECTPAGENAME}}</nowiki>}}</code> → {{#invoke:Disambiguation|isDisambiguationPage|{{SUBJECTPAGENAME}}}}

===Usage within Lua modules===
Import this module, e.g with
<syntaxhighlight lang="lua">
local mDisambiguation = require('Module:Disambiguation')
</syntaxhighlight>
Then you can use the functions <code>isDisambiguation</code> and <code>_isDisambiguationPage</code>.

If you have already have a [[mw:Lua_reference_manual#Title_objects|Title object]] for the page to check, get the content using the title object's getContent() method, and pass that into <code>isDisambiguation</code>:
<syntaxhighlight lang="lua">
local isDab = mDisambiguation.isDisambiguation(content) -- returns true or false
</syntaxhighlight>
:(where <code>content</code> 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 <code>_isDisambiguationPage</code>:
<syntaxhighlight lang="lua">
local isDab = mDisambiguation._isDisambiguationPage(pageName) -- returns true or false
</syntaxhighlight>
:(where <code>pageName</code> is a string, the name of page to check)

===Internal operations===
* Although [[Wikipedia:Set index articles|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 {{tl|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]].

<includeonly>{{Sandbox other||
[[Category:Disambiguation and redirection templates]]
}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>

← Older revision		Revision as of 17:06, 6 April 2025
Line 12:		Line 12:

	Examples:		Examples:
	* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|</nowiki>[[Paris]]}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|Paris}}		* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|</nowiki>Paris}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|Paris}}
	* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|</nowiki>[[New]]}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|New}}		* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|</nowiki>New}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|New}}
	* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|</nowiki>[[Black swan (disambiguation)]]}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|Black swan (disambiguation)}}		* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|</nowiki>Black swan (disambiguation)}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|Black swan (disambiguation)}}
	You can also use magic words like {{tl\|SUBJECTPAGENAME}}:		You can also use magic words like {{tl\|SUBJECTPAGENAME}}:
	* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|{{SUBJECTPAGENAME}}</nowiki>}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|{{SUBJECTPAGENAME}}}}		* <code><nowiki>{{#invoke:Disambiguation\|isDisambiguationPage\|{{SUBJECTPAGENAME}}</nowiki>}}</code> → {{#invoke:Disambiguation\|isDisambiguationPage\|{{SUBJECTPAGENAME}}}}
Line 25:		Line 25:
	Then you can use the functions <code>isDisambiguation</code> and <code>_isDisambiguationPage</code>.		Then you can use the functions <code>isDisambiguation</code> and <code>_isDisambiguationPage</code>.

	If you have already have a ~~[[mw:Lua_reference_manual#Title_objects\|~~Title object]] for the page to check, get the content using the title object's getContent() method, and pass that into <code>isDisambiguation</code>:		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 <code>isDisambiguation</code>:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local isDab = mDisambiguation.isDisambiguation(content) -- returns true or false		local isDab = mDisambiguation.isDisambiguation(content) -- returns true or false
Line 38:		Line 38:

	===Internal operations===		===Internal operations===
	* Although ~~[[Wikipedia:Set index articles\|~~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		* 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 {{tl\|italic disambiguation}}. These templates should be added to the falsePositives list in the code to exclude them.		* 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 {{tl\|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]].		* The list of disambiguation templates is maintained at Module:Disambiguation/templates.

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|