Template:Transliteration/doc

This template is used to mark up text transliterated or romanised from a non-Latin alphabet script to Latin alphabet script.

This template should only be used for the transliterations of non-Latin scripts; for non-English language text displayed in its native script (such as Greek, Cyrillic and Arabic), lang should be used, which tags non-transliterated text (written in original script). Transliteration is often used alongside that template, to allow non-readers of the script to interpret the text.

This template adds a tooltip label naming the transliteration scheme, and renders text in italics by default. This template is important for MOS:ACCESSIBILITY, as it invisibly tags text with the correct language, allowing for screenreaders to use the correct style of pronunciation.

It also displays text in an appropriate font; romanisations marked up in lang may display in fonts designed for that language's native text, whereas the transliteration template displays text in the same font as the rest of the article.

Some languages, such as Chinese, have more than one style of transliteration (such as Wade–Giles, pinyin, etc). This template can be used for these different transliteration schemes, though Wikipedia has a number of language-specific templates, some of which support more than one transliteration styles in their parameters, that may be better suited for marking up transliterations.

Example
The following code tags a Ukrainian name and its transliteration according to the Ukrainian National scheme.

Rationale
This template is intended to unify all "transliteration" templates, such as IAST and ISOtranslit. These templates are still usable, but they just transclude or are redirected back to. For example, (e.g.  is a shortcut for  . Other transliteration templates that once existed, such as ArabDIN, are now handled natively by this template:  ).

This template is kept separate from lang to address formatting issues (via CSS classes) and identification of transliteration schemes used. Ultimately, if these concerns are smartly addressed in the CSS file and/or in lang, using  should be equivalent to using.

Usage
There are two ways of using this template: with or without specifying the transliteration scheme used:
 * two parameters, with ISO 639 language code:  means that "al-Khwarizmi" is a transliteration from the Arabic in a loose or unspecified scheme.
 * two parameters, with ISO 15924 script code:  means that "MAQI" transliterates an Ogham inscription without specifying the language. Potentially useful when writing systems themselves are under discussion, e.g.  , not   or   when discussing the letter.
 * three parameters, with ISO 639 language code:  the second parameter specifies the scheme used (DIN vs. ALA).
 * three parameters, with ISO 15924 script code:  for.

There is no need to add italic markup to transliteration templates. Proper nouns – the names of people and places – are typically not italicized, and as such should use no to suppress the default italicization of Latin scripts.

Note: the language code is ISO 639 or IETF private-use tag (see Template:Lang); other forms of IETF BCP 47 language tags are not supported.

Transliteration scheme codes
Codes for supported transliteration schemes can be seen by viewing the source of Module:Lang/data – the translit_title_table data-structure lists for each such code the corresponding transliteration schemes. These may vary by language – e.g. code "ISO" means scheme ISO 233 for Arabic but ISO 11940 for Thai.

Examples
Inputting: Results in:
 * / DIN 31635: / ISO 233:   / ALA:
 * RTGS: / ISO 11940:

ISO:
 * русский :
 * Аҧсуа :
 * عربي :
 * ISO has huge issues transliterating, so it's better to use the Library of Congress transliteration, the German Institute for Standardization or Hans Wehr transliteration; see Arabic transliteration and MOS:APOSTROPHE
 * தமிழ் :
 * বাংলা :
 * ελληνικά :
 * ქართული  :
 * 漢語拼音 :
 * ภาษาไทย :

CSS
In order to apply a style to all text marked as transliteration, use a CSS selector that chooses all text with  in the title attribute (tooltip). For instance, if you add the following to your common.css, all transliterations will be colored :

TemplateData
{	"description": "Marks a text span transliterated from a particular language or writing system, and, optionally, according to a specific transliteration system.", "params": { "1": {			"label": "Language or script code", "description": "ISO 639 language code, possibly with an ISO 15924 script code", "required": true, "type": "line", "example": "hi (Hindi), sr-Cyrl (Serbian written in the Cyrillic script), und-Hani (an undetermined language written with Chinese characters), mis (an unknown language)" },		"2": {			"label": "Text or transliteration scheme", "description": "Latin-alphabet transliterated text, or, optionally, transliteration scheme (e.g., bgn/pcgn)", "required": true, "type": "string" },		"3": {			"label": "Text", "description": "Latin-alphabet transliterated text (required if a transliteration scheme is entered above)", "required": false, "suggested": true, "type": "string" },		"italics": { "aliases": [ "i", "italic" ],			"label": "Italics", "description": "Allows for control over whether transliterated text is italicized. It is useful to disable italics in cases like proper names.", "type": "string", "suggestedvalues": [ "yes", "no", "invert", "unset", "inherit" ],			"default": "inherit" }	},	"paramOrder": [ "1",		"2",		"3",		"italics" ] }