模組:Families/doc

此模块用於檢索和管理維基詞典的各種語言系屬及其相關資訊。請參閱Wiktionary:語系以了解更多資訊。

此模块提供對其他模块的存取。 要從模板中存取資訊，請參閱Module:families/templates。

資訊本身儲存在 Module:families/data 中，該模块不應被任何其他模块直接使用，只能透過 Module:families 提供的函數存取資料。

找尋語言系屬

此模組導出許多用於查找語言系屬的函數。

getByCode

getByCode(code)

尋找代碼與所提供代碼相符的語言系屬。如果存在，則傳回代表該族的 Family 物件，否則返回 nil。

尋找代碼與所提供的代碼相符的系列。 如果存在，則傳回代表家庭的 Family 物件。 否則，它會返回零。

getByCanonicalName

getByCanonicalName(name)

尋找其規範名稱（維基詞典上用於表示該語言的名稱）與所提供的名稱相符的語言系屬。如果存在，則回傳代表家庭的 Family 物件，否則回傳 nil。 家族的規範名稱應該始終是唯一的（維基詞典上，兩個語言系屬共享相同的規範名稱是錯誤的），因此這保證最多給出一個結果。

Family 物件

Family 物件是從上述函數之一傳回的。它是一個語言系屬及其關聯資料的 Lua 表示形式。它有許多可以呼叫的方法（使用 : 語法），例如：

local m_families = require("Module:families")
local fam = m_families.getByCode("ine")
local name = fam:getCanonicalName()
-- "name" will now be "Indo-European"

Family:getCode

:getCode()

返回語言系屬的代碼。例如：印歐語系的 "ine"。

Family:getCanonicalName

:getCanonicalName()

返回語言系屬的規範名稱。這是維基詞典上用來代表該系屬的唯一名稱。例如：印歐語系的"印歐語系"。

Family:getDisplayForm

:getDisplayForm()

返回語言系屬的顯示形式。對於語言系屬，這與 :getCategoryName("nocap") 傳回的值相同，即它讀取「NAME」（如"印歐語系"）（和英語維基詞典不同，中文維基詞典的 NAME 亦包含語言系屬後綴）。對於語言和僅用於詞源的語言，這與規範名稱相同；對於文字，它讀取「NAME」（例如"阿拉伯文"）。 :makeCategoryLink 中使用的顯示文字始終與顯示形式相同。

Family:getAllNames

:getAllNames()

傳回該系屬已知的所有名稱的表，包括規範名稱。這些名稱不能保證是唯一的，有時多個系屬共享同一名稱。例如：斯拉夫語支的 {"Slavic", "Slavonic"}。

Family:getFamily

:getFamily()

傳回該系屬的上層系屬的 Family 物件。

Family:getProtoLanguage

:getProtoLanguage()

傳回該系屬的祖語的Language物件（如果存在；請參閱 Module:languages）。

Family:getCategoryName

:getCategoryName(nocap)

傳回該系屬的主要分類的名稱。例如："日耳曼語族" 的分類 Category:日耳曼語族

除非給予可選參數 nocap，否則傳回值開頭的系屬名稱將大寫；這對於分類名稱是正確的，但如果系屬名稱是小寫且該函數的傳回值用在句子中間，則不正確。（以下文字為針對英語維基詞典的情況。）例如，代碼為 qfa-mix 的偽系屬名稱為 "混合語言"，當用作分類名稱 Category:派生自混合語言的詞，該名稱應保持小寫，但在 Category:混合語言 中應大寫。如果您正在考慮使用getCategoryName("nocap")，請改用 getDisplayForm()。

Family:getWikidataItem

:getWikidataItem()

回傳該系屬的維基數據項。

Family:getWikipediaArticle

:getWikipediaArticle()

傳回該系屬的維基百科條目，通常源自 :getWikidataItem()。