Module:Languages/templates/doc

From The Languages of David J. Peterson
Jump to navigation Jump to search

This is the documentation page for Module:Languages/templates

This module provides access to Module:languages from templates, so that they can make use of the information stored there.

Usage

If you know a language's code (for example, "en") and you want to find out its canonical name, you can use this:

  • {{#invoke:languages/templates|getByCode|en|getCanonicalName}} (returns "English")

If you know a language's canonical name (for example, "English") and you want to find out its code, use this:

  • {{#invoke:languages/templates|getByCanonicalName|English|getCode}} (returns "en")

Both of these functions are subst:able (type {{subst:#invoke:...).

Exported functions

exists

{{#invoke:languages/templates|exists|language code}}

Check whether a language code exists and is valid. It will return "1" if the language code exists, and the empty string "" if it does not.

This is rarely needed, because a script error will result when someone uses a code that is not valid, so you do not need this just to check for errors. However, in case you need to decide different actions based on whether a certain parameter is a language code or something else, this function can be useful.

getByCode

{{#invoke:languages/templates|getByCode|language code|item to look up|index}}

Queries information about a language code.

  • The language code should be one of the codes that is defined in Module:languages data. If it is missing or does not exist, the result will be a script error.
  • The item is the name of one of the functions of a language object, such as getCanonicalName or getScripts. If no item has been provided, the result will be a script error.
  • The index is optional, and is used for items that are lists, such as getOtherNames or getScripts. It selects which item in the list to return. On items that are single strings, like getFamily, it has no effect. If an index is given that is higher than the number of items in the list, the result will be an empty string.

For example, to request the canonical name of the language whose code is en:

{{#invoke:languages/templates|getByCode|en|getCanonicalName}}
  • Result: English

To request its second name, if any:

{{#invoke:languages/templates|getByCode|en|getOtherNames|1}}
  • Result: Modern English

To request its family:

{{#invoke:languages/templates|getByCode|en|getFamily}}
  • Result: gmw

getByCanonicalName

{{#invoke:languages/templates|getByCanonicalName|language name}}

Gets the language code corresponding to a canonical name.

{{#invoke:languages/templates|getByCanonicalName|English}}
en

getByName

{{#invoke:languages/templates|getByName|language name}}

Like the above, except it will also accept other names for the language that are listed in the language's otherNames field. For instance:

{{#invoke:languages/templates|getByName|Modern English}}
en

getCanonicalName

{{#invoke:languages/templates|getCanonicalName|language code}}

Gets the canonical name for a language code if the language code is valid, or else returns an empty string. It uses a table that converts language code to canonical name, generated by Module:languages/code to canonical name. Requires more Lua memory than getByCode (about 10 megabytes) for a single instance, but may require less memory on pages that call the function many times.

Unlike {{#invoke:languages/templates|getByCode|<language_code>|getCanonicalName}}, this function does does not yield a script error for an invalid language code.

{{#invoke:languages/templates|getCanonicalName|en}}
{{#invoke:languages/templates|getCanonicalName|invalid code}}
English

See also