模组: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()。