View source for 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/data/2|Two-letter codes]]
* Three-letter codes by their first letter: {{#invoke:string|gsub|abcdefghijklmnopqrstuvwxyz|%a|<nowiki /> [[Module:languages/data/3/%1|%1]]}}
* [[Module:languages/data/exceptional|Codes containing hyphens (<code>-</code>)]]

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

==Finding and retrieving languages==

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

{{module documentation|section_level=3|identifier=^export}}

==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>

{{module documentation|section_level=3|identifier=^Language}}

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

==Subpages==
{{subpages|Module:languages}}

==See also==
* [[Module:families]]

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