Template:Translit module documentation

This module will transliterate Undetermined language text.

The module should preferably not be called directly from templates or other modules. To use it from a template, use {{xlit}}. Within a module, use Module:languages#Language:transliterate.

For testcases, see Module:Translit module documentation/testcases.

Functions

tr(text, lang, sc)

Transliterates a given piece of text written in the script specified by the code sc, and language specified by the code lang. When the transliteration fails, returns nil.

---

The following documentation is located at Template:Translit module documentation/documentation. ^[edit]

Useful links: subpage list • transclusions • redirects • sandbox

This template generates documentation pages for transliteration modules. It requires a single parameter: the language or script code. The second parameter provides optional text to be displayed after "This module will transliterate x language text".

If the second parameter is not provided, the languages that use the module will be listed, if they can be detected. In all cases, a category will be added for every language, and the category Transliteration modules will be added, with the canonical name corresponding to the code in the module name as sortkey (for example, Module:sa-translit → [[Category:Transliteration modules|Sanskrit]]).

Module:languages/byTranslitModule finds the languages that use the module, and the translitModuleLangList function in Module:documentation lists them, and the categorize function in Module:module categorization adds categories for each one. This will only work if the transliteration module is listed in the language's data file or in the language's entry in Module:translit-redirect/data.