View source for Template:Language data documentation

{{language data search}}
This module contains definitions and metadata for {{#switch:{{#titleparts:{{PAGENAME}}|1|3}}|2='''two-letter language codes'''|3='''three-letter language codes''' starting with <code>{{#titleparts:{{PAGENAME}}|1|4}}</code>|exceptional='''exceptional''' language codes: those that consist of two- or three-letter sequences separated by hyphens|#default=language codes}}. See [[Wiktionary:Languages]] for more information.

This module '''must not''' be used directly in other modules or templates. The data should be accessed through [[Module:languages]]. {{#ifeq:{{NAMESPACENUMBER}}|828|For the corresponding extra data, see [[{{FULLPAGENAME}}/extra]].}}

==Errors==
{{language data consistency check}}

==Required values==
Every entry in the table must contain the following indexed fields:

; <code>1</code>
: The "canonical" name of the language. This is the name that is used in Wiktionary entries and category names.
; <code>2</code>
: The Wikidata item ID (Q number) for the language. Must be specified as a number (a positive integer). Set to <code>nil</code> if not known/present. This replaces the older <code>wikipedia_article</code> property, which can still be used to link to specific sections or language editions.

==Optional values==
; <code>3</code>
: The code for the family that the language belongs to. See [[Wiktionary:Families]].
; <code>4</code>
: A list of script codes. See [[Wiktionary:Scripts]]. These represent all the scripts (writing systems) that this language uses in the real world, as well as the ones that Wiktionary uses. The scripts that are used most often on Wiktionary should be first in the list, as this will speed up script detection.
: Many templates and modules detect the script of text in a particular language using the {{code|lua|Language:findBestScript}} method in [[Module:languages]]. This function goes down the list of scripts and counts how many characters in the text belong to each script. If all the characters belong to one script, that script will be returned; otherwise, the script with the most characters will be returned. Thus, script detection will be faster if the most frequently used scripts are first in the list. If none of the characters match any of the listed scripts, then the <code>None</code> script is returned (even if the characters would match a script not listed). Translingual (<code>mul</code>) and Undetermined (<code>und</code>) have the special value {{code|lua|"All"}}, which means they are treated as having every script. This value should not be set for any other language codes.
: Due to the [[WT:Lua memory errors|ongoing problems with Lua memory limits]], this should be given as a comma-separated list in a string (and not a table). This is then converted into a table when returned. For example: {{code|lua|"Latn, Brai, Shaw, Dsrt"}}.
; <code>type</code>
: The type of language (which affects how it is handled on Wiktionary). Possible values are:
:* <code>regular</code> - This value is the default, so it doesn't need to be specified. It indicates that the is attested according to [[WT:CFI]] and therefore permitted in the main namespace. There may also be reconstructed terms for the language, which are placed in the Reconstruction namespace and must be prefixed with * to indicate a reconstruction.
:* <code>reconstructed</code> - This language is not attested according to CFI, and therefore is allowed only in the Reconstruction namespace. All terms in this language are reconstructed, and must be prefixed with *.
:* <code>appendix-constructed</code> - This language is attested but does not meet the additional requirements set out for constructed languages ([[WT:CFI#Constructed languages]]). Its entries must therefore be in the Appendix namespace, but they are not reconstructed and therefore should not have * prefixed in links.
; <code>ancestors</code>
: A list of the language codes of the direct ancestors of this language. For example, the ancestor of English is listed as <code>enm</code> (Middle English); <code>ang</code> (Old English, the ancestor of Middle English), <code>gem-pro</code> (Proto-Germanic, the ancestor of Old English){{,}} and <code>ine-pro</code> (Proto-Indo-European, the ancestor of Proto-Germanic) are not listed.
: For most languages, only one ancestor code should be given, but multiple ancestors can be listed for pidgins, creoles and mixed languages.
: The ancestor language list should not be included if the language's direct ancestor is the proto-language of the family to which the language belongs. In such a case, if the family code has been provided, [[Module:languages]] will automatically add the proto-language as the language's ancestor. For example, Proto-Germanic (<code>gem-pro</code>) belongs to the Indo-European (<code>ine</code>) family, and its direct ancestor is Proto-Indo-European (<code>ine-pro</code>). Because Proto-Indo-European is the proto-language of the Indo-European languages, Proto-Germanic does not need an <code>ancestors</code> table; Proto-Indo-European will be automatically returned as its ancestor by the {{code|lua|getAncestors}} function.
: Due to the [[WT:Lua memory errors|ongoing problems with Lua memory limits]], this should be given as a comma-separated list in a string (and not a table). This is then converted into a table when returned. For example: {{code|lua|"cr, fr"}}.
; <code>wikimedia_codes</code>
: A list of the [[Wiktionary:Wikimedia language codes|Wikimedia language codes]] that this language maps to. This is used to translate Wiktionary codes to Wikimedia codes, which are usually the same but there are a few languages where it is different. The language codes must be valid Wikimedia codes (as determined by the wiki software), and if they are not defined in one of the language data modules, they must be defined in [[Module:wikimedia languages/data]].
: Due to the [[WT:Lua memory errors|ongoing problems with Lua memory limits]], this should be given as a comma-separated list in a string (and not a table). This is then converted into a table when returned. For example: {{code|lua|"en, simple"}}.
: Note that Wikimedia <-> Wiktionary language codes are currently defined in four places: the language modules (as documented here); [[Module:wikimedia languages/data]]; {{code||interwiki_langs}} in [[Module:translations/data]]; and the {{code||wiktprefix}} field of the `metadata` variable in [[MediaWiki:Gadget-TranslationAdder-Data.js]]. FIXME: Unify this data.
; <code>wikipedia_article</code>
: The name of the Wikipedia article for the language. Should normally only be supplied if the Wikidata id cannot be used.
; <code>translit</code>
: <small>''See the [[#Substitutions|Substitutions]] section for instructions on syntax.''</small>
: Defines how a language should be transliterated, which will be automatically applied to any terms in scripts that do not have their <code>isTransliterated</code> value set to {{code|lua|false}} in [[Module:scripts/data]]. This is used by <code>transliterate</code> in [[Module:languages]].
; <code>link_tr</code>
: Set this to <code>true</code> to link the language's transliteration in headwords. This can also be a comma-separated list of script codes, which means that links are only applied to terms using those scripts. Note that transliterations are not linked in links other than headwords (those generated using {{cd|full_link()}} in [[Module:links]]) unless the {{cd|respect_link_tr}} flag is set in {{cd|full_link()}}'s data structure.
; <code>override_translit</code>
: Set this to <code>true</code> to make the automatic transliteration override an any given manual transliteration. Otherwise, this can be a comma-separated list of script codes, which means that the override is only applied to terms using those scripts.
; <code>display_text</code>
: <small>''See the [[#Substitutions|Substitutions]] section for instructions on syntax.''</small>
: Defines replacements to create the display form of the text, which is the form actually displayed on the page. This is occasionally necessary if there is a recurring issue of editors adding the wrong character, which is sometimes an issue when two or more characters are easy to confuse. For example, the palochka <code>ӏ</code>, used in Cyrillic in many Caucasian languages, is frequently entered as <code>I</code>, or even Latin <code>l</code> or <code>I</code>. As this is an ongoing issue (even among native speakers), the easiest way to solve the problem is to automatically correct the display form for those languages. This is used by <code>makeDisplayText</code> in [[Module:languages]].
; <code>strip_diacritics</code>
: <small>''See the [[#Substitutions|Substitutions]] section for instructions on syntax.''</small>
: Defines replacements to strip diacritics from the displayed form of a term in order to get the logical pagename. This is typically used to remove certain diacritical marks according to the customs or standard practice of the language. For example, it is used to remove accent marks from Russian words (<code>ру́сский</code> &rarr; <code>русский</code>), and macrons from Latin and Old English words (<code>ōs</code> &rarr; <code>os</code>), as these are not used in the normal written form of these languages. This is used by <code>stripDiacritics</code> in [[Module:languages]].
; <code>sort_key</code>
: <small>''See the [[#Substitutions|Substitutions]] section for instructions on syntax.''</small>
: Defines replacements to create a category sort key from the page name. The purpose is to:
:# Remove any characters that should be ignored in sorting.
:# Replace characters with other characters, if the sorting rules for that language do not distinguish them. For example, in German, the characters "ä" and "a" are considered equivalent for sorting, and are both treated as "a".
:# Replace characters that should be sorted in different places with special characters that mimic that behaviour, (which is necessary due to MediaWiki software using the Unicode codepoint to determine sort order, which is often arbitrary). For instance, in Mongolian, the letter "ү" should be sorted after "у", but due to its codepoint it is sorted after the final letter "я" by default. As such, we can replace "ү" with "у" plus a character with a very high codepoint, which ensures that it is always sorted straight after. The data modules contain an in-built way to do this for the sake of convenience: with the above example, this would be done by using {{code|lua|"у" .. p[1]}}. Another character could be inserted straight after by using {{code|lua|"у" .. p[2]}} (and so on).
: Note: the term is converted to lowercase before applying any substitutions, so you should not try to process capital letters (as it will not work). This is used by <code>makeSortKey</code> in [[Module:languages]].
; <code>dotted_dotless_i</code>
: Set this to <code>true</code> for languages that distinguish between the {{w|Dotted and dotless I in computing|dotted and dotless I}} (such as some Turkic languages).

==Substitutions==
: {{code|lua|translit}}, {{code|lua|display_text}}, {{code|lua|strip_diacritics}} and {{code|lua|sort_key}} all use the same syntax, which is designed to be as flexible as possible:
:* If they are a string, then this is treated as the name of a dedicated module which will be used to generate the output. For example, {{code|lua|"sa-translit"}} refers to [[Module:sa-translit]].
:* If they are a table, then it can contain two kinds of keys:
:*# The keys {{code|lua|from}}, {{code|lua|to}}, {{code|lua|remove_diacritics}} and {{code|lua|remove_exceptions}} relate to text substitution (see below).
:*# Script code keys are used to specify script-specific behaviour. These, in turn, can be strings (for dedicated modules) or tables (for text substitution). In addition, a value with the key {{code|Lua|1}} can be used as a fallback, which will be used if no specific behaviour is defined for that script.
:: Note: if script keys and text substitution keys are given in the same table, then the text substitution will be applied after the script-specific behaviour has completed. Ensure any fallback text substitutions are given as a subtable with key {{code|Lua|1}} if you want to avoid this. It is not possible to process the output of a script-specific module with another module, however: this should be done (for example) with a [[tail call]] in the first module.
: Dedicated modules must take the arguments {{code|lua|text, lang, sc}}, where {{code|lua|text}} is the input text (usually the page name or input by the user), {{code|lua|lang}} is the language code (not the language object), and {{code|lua|sc}} is the script code (not the script object). For performance reasons, they should <u>only</u> be used when it is not possible to achieve the desired result via text substitution.
: Text substitution replaces or removes certain characters (or sets of characters) for particular contexts. There are three ways to do this:
:# Using the {{code|lua|from}} and {{code|lua|to}} keys.
:# {{code|lua|remove_diacritics}} (and optionally {{code|lua|remove_exceptions}}).
:# Both of the above (in that order).
: {{code|lua|from}} is paired with {{code|lua|to}}, and both of them must be tables that are organised pairwise: each element in {{code|lua|from}} is a pattern to identify which characters in the term to replace, while the corresponding element in {{code|lua|to}} defines what to replace them with (as arguments to [[mw:Extension:Scribunto/Lua_reference_manual#mw.ustring.gsub|{{code|lua|mw.ustring.gsub}}]]).
: If the replacement is not present (or if it is {{code|lua|false}} or {{code|lua|nil}}), then any matching characters are removed altogether. This means that the {{code|lua|from}} list can be longer than the {{code|lua|to}} list, and an empty replacement will be assumed for any elements in {{code|lua|from}} that have no counterpart in {{code|lua|to}}.
: The tables can contain literal characters, or the patterns (a simplified form [[regular expression]]s) that are used by the standard Scribunto [[mw:Extension:Scribunto/Lua reference manual#mw.ustring.gsub|{{code|lua|mw.ustring.gsub}}]] function. See [[mw:Extension:Scribunto/Lua reference manual#Patterns|the Scribunto reference manual]] for more information. Note that patterns make double substitutions a viable way to achieve more complex results. See the Latin sortkey for Mandarin (<code>cmn</code>) as an example of this.
: {{code|lua|remove_diacritics}} is a string which contains characters that will be removed after the text is decomposed. For instance, if {{code|lua|remove_diacritics}} is a combining acute accent, all acute accents will be stripped, even if they are part of precomposed characters (such as {{l|mul|á}} or {{l|mul|ά|tr=-}}). Despite the name, the characters to be stripped need not be diacritics: for instance, including an apostrophe would remove all apostrophes (though be careful with hyphens, which must be be [[mw:Extension:Scribunto/Lua_reference_manual#Patterns|escaped]] as {{code|lua|%-}}).
: Furthermore, if {{code|lua|remove_diacritics}} is given, then it is possible to specify a {{code|lua|remove_exceptions}} table, which prevents specific characters from having their diacritics stripped. For instance, if {{code|lua|remove_diacritics}} is a combining diaeresis, but {{code|lua|remove_exceptions}} contains {{code|lua|"ё"}}, then any instances of <code>ё</code> will remain unchanged. On the other hand, an instance of <code>ӱ</code> would still become <code>у</code> (unless {{code|lua|"ӱ"}} is also added to {{code|lua|remove_exceptions}}).
: If no value is specified for a given field, or a table of script-specific values is given but there is no value for the script in question and no {{code|lua|from}}/{{code|lua|to}} or {{code|lua|remove_diacritics}} fields, the script will be checked for a script-wide fallback, which uses the same data format. This is used, for example, to supply a script-wide sort key module for Ethiopic in lieu of specifying the same value for all languages that have Ethiopic as their script (or one of their scripts).

== Formerly supported values ==
; <code>aliases</code>, <code>varieties</code>, <code>otherNames</code>
: This data is now located in the extra data modules; see [[Module:languages]] and [[Template:language extradata documentation]].
; <code>family</code>
: Now <code>3</code>.
; <code>scripts</code>
: Now <code>4</code>.
<!--

--><noinclude>{{documentation}}</noinclude>