模块:Disambiguation/doc

此页面是Module:Disambiguation的模块文档。
此页面可能包含了模板的使用说明、分类和其他内容。

此模块使用Lua语言：

本模块用于检测指定的页面是否为消歧义页面。

用法

{{#invoke:Disambiguation|isDisambiguationPage|页面标题}}

如果目标页面为消歧义页面将返回yes，否则将不返回任何内容。

示例：

请注意，标题繁简必须与原始标题一致。

您也可以使用魔术字，例如{{SUBJECTPAGENAME}}：

导入本模块，例如使用

local mDisambiguation = require('Module:Disambiguation')

然后，您就可以使用函数isDisambiguation和_isDisambiguationPage。

如果您已经有要检查的页面的标题对象，请使用标题对象的getContent()方法获取内容，并将其传递给isDisambiguation：

local isDab = mDisambiguation.isDisambiguation(content) -- returns true or false

（其中content是一个字符串，即要检查的页面的Wikitext内容）

如果您不需要标题，可以将页面名称传递给_isDisambiguationPage：

local isDab = mDisambiguation._isDisambiguationPage(pageName) -- returns true or false

（其中pageName是一个字符串，即要检查的页面名称）

尽管同类索引条目被某些模板视为消歧义页面，但它们实际上是一种特殊类型的列表，并且不被本模块视为消歧义页面。
由于本模块依赖于检测条目文本中具有“消歧义”等名称的模板，所以会受到{{需要消歧义}}等模板的误报，这些模板应当添加到代码中的falsePositives列表中以便排除它们。
消歧义模板列表在Module:Disambiguation/templates中维护。