Module:Guru-translit/documentation

This module will transliterate text in the Gurmukhi අක්ෂරක්‍රමය. It is used to transliterate Punjabi and Pahari-Potwari. 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:Guru-translit/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.