模組:Disambiguation/doc

此頁面為 Module:Disambiguation 的說明文件

此頁面是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中維護。