Editing Module:Languages/documentation

{{language data search}}
This module is used to retrieve and manage the languages that can have Wiktionary entries, and the information associated with them. See [[Wiktionary:Languages]] for more information.

For the languages and language varieties that may be used in etymologies, see [[Module:etymology languages]]. For language families, which sometimes also appear in etymologies, see [[Module:families]].

This module provides access to other modules. To access the information from within a template, see [[Module:languages/templates]].

The information itself is stored in the various data modules that are subpages of this module. These modules should '''not''' be used directly by any other module, the data should only be accessed through the functions provided by this module.

Data submodules:
* [[Module:languages/data2|Two-letter codes]]
* Three-letter codes by their first letter: {{#invoke:string|gsub|abcdefghijklmnopqrstuvwxyz|%a|<nowiki /> [[Module:languages/data3/%1|%1]]}}
* [[Module:languages/datax|Codes containing hyphens (<code>-</code>)]]

Extra data submodules (for less frequently used data):
* [[Module:languages/extradata2|Two-letter codes]]
* Three-letter codes by their first letter: {{#invoke:string|gsub|abcdefghijklmnopqrstuvwxyz|%a|<nowiki /> [[Module:languages/extradata3/%1|%1]]}}
* [[Module:languages/extradatax|Codes containing hyphens (<code>-</code>)]]

==Finding and retrieving languages==

The module exports a number of functions that are used to find languages.

===getByCode===
<code><span class="n">getByCode</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">paramForError</span><span class="p">,</span> <span class="n">allowEtymLang</span><span class="p">,</span> <span class="n">allowFamily</span><span class="p">)</span></code>

Finds the language whose code matches the one provided. If it exists, it returns a <code class="nf">Language</code> object representing the language. Otherwise, it returns {{code|lua|nil}}, unless <code class="n">paramForError</code> is given, in which case an error is generated. If <code class="n">paramForError</code> is {{code|lua|true}}, a generic error message mentioning the bad code is generated; otherwise <code class="n">paramForError</code> should be a string or number specifying the parameter that the code came from, and this parameter will be mentioned in the error message along with the bad code. If <code class="n">allowEtymLang</code> is specified, etymology language codes are allowed and looked up along with normal language codes. If <code class="n">allowFamily</code> is specified, language family codes are allowed and looked up along with normal language codes.

===getByCanonicalName===
<code><span class="n">getByCanonicalName</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">paramForError</span><span class="p">,</span> <span class="n">allowEtymLang</span><span class="p">,</span> <span class="n">allowFamily</span><span class="p">)</span></code>

Finds the language whose canonical name (the name used to represent that language on Wiktionary) or other name matches the one provided. If it exists, it returns a <code class="nf">Language</code> object representing the language. Otherwise, it returns {{code|lua|nil}}, unless <code class="n">paramForError</code> is given, in which case an error is generated. If <code class="n">allowEtymLang</code> is specified, etymology language codes are allowed and looked up along with normal language codes. If <code class="n">allowFamily</code> is specified, language family codes are allowed and looked up along with normal language codes.

The canonical name of languages should always be unique (it is an error for two languages on Wiktionary to share the same canonical name), so this is guaranteed to give at most one result.

This function is powered by [[Module:languages/canonical names]], which contains a pre-generated mapping of non-etymology-language canonical names to codes. It is generated by going through the [[:Category:Language data modules]] for non-etymology languages. When <code class="n">allowEtymLang</code> is specified for the above function, [[Module:etymology languages/by name]] may also be used, and when <code class="n">allowFamily</code> is specified for the above function, [[Module:families/by name]] may also be used.

===getByName===
<code><span class="n">getByName</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></code>

Like {{code|lua|getByCanonicalName()}}, except it also looks at the <code class="n">otherNames</code> listed in the non-etymology language data modules, and does not (currently) have options to look up etymology languages and families.

===getNonEtymological===
<code><span class="n">getNonEtymological</span><span class="p">(</span><span class="n">lang</span><span class="p">)</span></code>

If given an etymology language, this iterates through parents until a regular language or family is found, and the corresponding object is returned. If given a regular language or family, the object itself is returned.

===Finding all languages===
Use [[Module:languages/iterateAll]] to find all languages.

==Language objects==

A <code class="nf">Language</code> object is returned from one of the functions above. It is a Lua representation of a language and the data associated with it. It has a number of methods that can be called on it, using the <code>:</code> syntax. For example:

<syntaxhighlight lang="lua">
local m_languages = require("Module:languages")
local lang = m_languages.getByCode("fr")
local name = lang:getCanonicalName()
-- "name" will now be "French"
</syntaxhighlight>

===Language:getCode===
<code><span class="n">:getCode</span><span class="p">()</span></code>

Returns the language code of the language. Example: {{code|lua|"fr"}} for French.

===Language:getCanonicalName===
<code><span class="n">:getCanonicalName</span><span class="p">()</span></code>

Returns the canonical name of the language. This is the name used to represent that language on Wiktionary, and is guaranteed to be unique to that language alone. Example: {{code|lua|"French"}} for French.

===Language:getDisplayForm===
<code><span class="n">:getDisplayForm</span><span class="p">()</span></code>

Returns the display form of the language. The display form of a language, family or script is the form it takes when appearing as the ''SOURCE'' in categories such as <code>English terms derived from ''SOURCE''</code> or <code>English given names from ''SOURCE''</code>, and is also the displayed text in <code>:makeCategoryLink</code> links. For regular and etymology languages, this is the same as the canonical name, but for families, it reads "NAME languages" (e.g. {{code|lua|"Indo-Iranian languages"}}), and for scripts, it reads "NAME script" (e.g. {{code|lua|"Arabic script"}}).

===Language:getOtherNames===
<code><span class="n">:getOtherNames</span><span class="p">(</span><span class="n">onlyOtherNames</span><span class="p">)</span></code>

Returns a table of the "other names" that the language is known by, excluding the canonical name. The names are not guaranteed to be unique, in that sometimes more than one language is known by the same name. Example: {{code|lua|{"Manx Gaelic", "Northern Manx", "Southern Manx"} }} for [[:Category:Manx language|Manx]]. If <code>onlyOtherNames</code> is given and is non-{{code|lua|nil}}, only names explicitly listed in the <code>otherNames</code> field are returned; otherwise, names listed under <code>otherNames</code>, <code>aliases</code> and <code>varieties</code> are combined together and returned. For example, for Manx, Manx Gaelic is listed as an alias, while Northern Manx and Southern Manx are listed as varieties. It should be noted that the <code>otherNames</code> field itself is deprecated, and entries listed there should eventually be moved to either <code>aliases</code> or <code>varieties</code>.

===Language:getAliases===
<code><span class="n">:getAliases</span><span class="p">()</span></code>

Returns a table of the aliases that the language is known by, excluding the canonical name. Aliases are synonyms for the language in question. The names are not guaranteed to be unique, in that sometimes more than one language is known by the same name. Example: {{code|lua|{"High German", "New High German", "Deutsch"} }} for [[:Category:German language|German]].

===Language:getVarieties===
<code><span class="n">:getVarieties</span><span class="p">(</span><span class="n">flatten</span><span class="p">)</span></code>

Returns a table of the known subvarieties of a given language, excluding subvarieties that have been given explicit etymology language codes. The names are not guaranteed to be unique, in that sometimes a given name refers to a subvariety of more than one language. Example: {{code|lua|{"Southern Aymara", "Central Aymara"} }} for [[:Category:Aymara language|Aymara]]. Note that the returned value can have nested tables in it, when a subvariety goes by more than one name. Example: {{code|lua|{"North Azerbaijani", "South Azerbaijani", {"Afshar", "Afshari", "Afshar Azerbaijani", "Afchar"}, {"Qashqa'i", "Qashqai", "Kashkay"}, "Sonqor"} }} for [[:Category:Azerbaijani language|Azerbaijani]]. Here, for example, Afshar, Afshari, Afshar Azerbaijani and Afchar all refer to the same subvariety, whose preferred name is Afshar (the one listed first). To avoid a return value with nested tables in it, specify a non-{{code|lua|nil}} value for the <code>flatten</code> parameter; in that case, the return value would be {{code|lua|{"North Azerbaijani", "South Azerbaijani", "Afshar", "Afshari", "Afshar Azerbaijani", "Afchar", "Qashqa'i", "Qashqai", "Kashkay", "Sonqor"} }}.

===Language:getType===
<code><span class="n">:getType</span><span class="p">()</span></code>

Returns the type of language, which can be {{code|lua|"regular"}}, {{code|lua|"reconstructed"}} or {{code|lua|"appendix-constructed"}}.

===Language:getWikimediaLanguages===
<code><span class="n">:getWikimediaLanguages</span><span class="p">()</span></code>

Returns a table containing <code>WikimediaLanguage</code> objects (see [[Module:wikimedia languages]]), which represent languages and their codes as they are used in Wikimedia projects for interwiki linking and such. More than one object may be returned, as a single Wiktionary language may correspond to multiple Wikimedia languages. For example, Wiktionary's single code <code>sh</code> (Serbo-Croatian) maps to four Wikimedia codes: <code>sh</code> (Serbo-Croatian), <code>bs</code> (Bosnian), <code>hr</code> (Croatian) and <code>sr</code> (Serbian).

The code for the Wikimedia language is retrieved from the <code>wikimedia_codes</code> property in the data modules. If that property is not present, the code of the current language is used. If none of the available codes is actually a valid Wikimedia code, an empty table is returned.

===Language:getWikipediaArticle===
<code><span class="n">:getWikipediaArticle</span><span class="p">()</span></code>

Returns the name of the Wikipedia article for the language. If the property <code>wikipedia_article</code> is present in the data module it will be used first, otherwise a sitelink will be generated from <code>:getWikidataItem</code> (if set). Otherwise <code>:getCategoryName</code> is used as fallback.

===Language:getWikidataItem===
<code><span class="n">:getWikidataItem</span><span class="p">()</span></code>

Returns the Wikidata item id for the language or <code>nil</code>. This corresponds to the the second field in the data modules.

===Language:getScripts===
<code><span class="n">:getScripts</span><span class="p">()</span></code>

Returns a table of <code>Script</code> objects for all scripts that the language is written in. See [[Module:scripts]].

===Language:getScriptCodes===
<code><span class="n">:getScriptCodes</span><span class="p">()</span></code>

Returns the table of script codes in the language's data file.

===Language:getFamily===
<code><span class="n">:getFamily</span><span class="p">()</span></code>

Returns a <code>Family</code> object for the language family that the language belongs to. See [[Module:families]].

===Language:getAncestors===
<code><span class="n">:getAncestors</span><span class="p">()</span></code>

Returns a table of <code class="nf">Language</code> objects for all languages that this language is directly descended from. Generally this is only a single language, but creoles, pidgins and mixed languages can have multiple ancestors.

===Language:getCategoryName===
<code><span class="n">:getCategoryName</span><span class="p">(</span><span class="n">nocap</span><span class="p">)</span></code>

Returns the name of the main category of that language. Example: {{code|lua|"French language"}} for French, whose category is at [[:Category:French language]]. Unless optional argument <code>nocap</code> is given, the language name at the beginning of the returned value will be capitalized. This capitalization is correct for category names, but not if the language name is lowercase and the returned value of this function is used in the middle of a sentence.

===Language:makeCategoryLink===
<code><span class="n">:makeCategoryLink</span><span class="p">()</span></code>

Creates a link to the category; the link text is the canonical name.

===Language:makeEntryName===
<code><span class="n">:makeEntryName</span><span class="p">(</span><span class="n">term</span><span class="p">)</span></code>

Converts the given term into the form used in the names of entries. This removes diacritical marks from the term if they are not considered part of the normal written form of the language, and which therefore are not permitted in page names. It also removes certain punctuation characters like final question marks or periods which are never present in page names. Example for Latin: {{code|lua|"amō"}} &rarr; {{code|lua|"amo"}} (macron is removed).

The replacements made by this function are defined by the <code>entry_name</code> setting for each language in the data modules.

===Language:makeSortKey===
<code><span class="n">:makeSortKey</span><span class="p">(</span><span class="n">entryName</span><span class="p">)</span></code>

Creates a sort key for the given entry name, following the rules appropriate for the language. This removes diacritical marks from the entry name if they are not considered significant for sorting, and may perform some other changes. Any initial hyphen is also removed, and anything parentheses is removed as well.

The <code>sort_key</code> setting for each language in the data modules defines the replacements made by this function, or it gives the name of the module that takes the entry name and returns a sortkey.

===Language:transliterate===
<code><span class="n">:transliterate(text, sc, module_override)</span></code>

Transliterates the text from the given script into the Latin script (see [[Wiktionary:Transliteration and romanization]]). The language must have the <code>translit_module</code> property for this to work; if it is not present, {{code|lua|nil}} is returned.

The <code>sc</code> parameter is handled by the transliteration module, and how it is handled is specific to that module. Some transliteration modules may tolerate {{code|lua|nil}} as the script, others require it to be one of the possible scripts that the module can transliterate, and will show an error if it's not one of them. For this reason, the <code>sc</code> parameter should always be provided when writing non-language-specific code.

The <code>module_override</code> parameter is used to override the default module that is used to provide the transliteration. This is useful in cases where you need to demonstrate a particular module in use, but there is no default module yet, or you want to demonstrate an alternative version of a transliteration module before making it official. It should not be used in real modules or templates, only for testing. All uses of this parameter are tracked by [[Template:tracking/module_override]].

===Language:hasTranslit===
<code><span class="n">:hasTranslit</span><span class="p">()</span></code>

Returns {{code|lua|true}} if the language has a transliteration module, {{code|lua|false}} if it doesn't.

===Language:getRawData===
<code><span class="n">:getRawData</span><span class="p">()</span></code>
: <span style="color: #BA0000">This function is not for use in entries or other content pages.</span>

Returns a blob of data about the language. The format of this blob is undocumented, and perhaps unstable; it's intended for things like the module's own unit-tests, which are "close friends" with the module and will be kept up-to-date as the format changes.

===Language:getRawExtraData===
<code><span class="n">:getRawExtraData</span><span class="p">()</span></code>
: <span style="color: #BA0000">This function is not for use in entries or other content pages.</span>

Returns a blob of data about the language that contains the "extra data". Much like with getRawData, the format of this blob is undocumented, and perhaps unstable; it's intended for things like the module's own unit-tests, which are "close friends" with the module and will be kept up-to-date as the format changes.

==Error function==
See [[Module:languages/error]].

==See also==
* {{temp|Module:etymology languages}}
* {{temp|Module:families}}
* {{temp|Module:languages/templates}}
* {{temp|Module:languages/JSON}}

<includeonly>
[[Category:Language and script modules]]
[[Category:JSON-generating modules]]
</includeonly>