Template:Transliteration/doc

Revision as of 08:48, 20 December 2024 by Astaryuu (talk | contribs) (Created page with "{{Documentation subpage}} {{Redirect|Template:Transl|the template for translated text|Template:Translation}} {{High use}} {{COinS safe|n}} {{Lua|Module:Lang}} {{Template shortcut|tlit}} {{Language templates}} 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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Template:Redirect

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 edit

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

Markup Renders as
{{lang|uk|Ярослав Рудницький}} ({{transliteration|uk|ukrainian|Yaroslav Rudnytskyi}})

Ярослав Рудницький (Yaroslav Rudnytskyi)

Rationale edit

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 {{transl}}. For example, (e.g. {{IAST|saṃskṛtam}} is a shortcut for {{transliteration|sa|IAST|saṃskṛtam}}. Other transliteration templates that once existed, such as {{ArabDIN}}, are now handled natively by this template: {{transliteration|ar|DIN|...}}).

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 {{transliteration|xx|...}} should be equivalent to using {{lang|xx-Latn|...}}.

Usage edit

There are two ways of using this template: with or without specifying the transliteration scheme used:

  • two parameters, with ISO 639 language code: {{transliteration|ar|al-Khwarizmi}} means that "al-Khwarizmi" is a transliteration from the Arabic in a loose or unspecified scheme.
  • two parameters, with ISO 15924 script code: {{transliteration|Ogam|MAQI}} means that "MAQI" transliterates an Ogham inscription without specifying the language. Potentially useful when writing systems themselves are under discussion, e.g. {{transliteration|Cyrl|š}}, not {{transliteration|cu|š}} or {{transliteration|ru|š}} when discussing the letter Ш.
  • three parameters, with ISO 639 language code: {{transliteration|ar|DIN|al-Ḫawārizmī}} / {{transliteration|ar|ALA|al-Khawārizmī}} the second parameter specifies the scheme used (DIN vs. ALA).
  • three parameters, with ISO 15924 script code: {{transliteration|Arab|DIN|Ḫ}} vs {{transliteration|Arab|ALA|Kh}} for Template:Script/Arabic.

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

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 edit

Inputting:

  • {{transliteration|ar|[[al-Khwarizmi]]}} / [[DIN 31635]]: {{transliteration|ar|DIN|al-Ḫawārizmī}} / [[ISO 233]]: {{transliteration|ar|ISO|al-H̱awārizmī}} / [[ALA-LC Romanization|ALA]]: {{transliteration|ar|ALA|al-Khawārizmī}}
  • [[Royal Thai General System of Transcription|RTGS]]: {{transliteration|th|phasa thai}} / [[ISO 11940]]: {{transliteration|th|ISO|p̣hās̄ʹāthịy}}
  • {{cuneiform|[[Sumerian language|𒅴𒂠]]}} {{transliteration|sux|EME.GIR<sub>15</sub>}} / {{cuneiform|6|[[Hittite language|𒉈𒅆𒇷]]}} {{transliteration|hit|ne-ši-li}}

Results in:

ISO:

CSS edit

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

[title~=transliteration] { color: teal; }

Tracking category edit

TemplateData edit

Template:Templatedata header

Marks a text span transliterated from a particular language or writing system, and, optionally, according to a specific transliteration system.

Template parameters

ParameterDescriptionTypeStatus
Language or script code1

ISO 639 language code, possibly with an ISO 15924 script code

Example
hi (Hindi), sr-Cyrl (Serbian written in the Cyrillic script), und-Hani (an undetermined language written with Chinese characters), mis (an unknown language)
Linerequired
Text or transliteration scheme2

Latin-alphabet transliterated text, or, optionally, transliteration scheme (e.g., bgn/pcgn)

Stringrequired
Text3

Latin-alphabet transliterated text (required if a transliteration scheme is entered above)

Stringsuggested
Italicsitalics i italic

Allows for control over whether transliterated text is italicized. It is useful to disable italics in cases like proper names.

Suggested values
yes no invert unset inherit
Default
inherit
Stringoptional

See also edit

Template:ISO 15924 script codes and related Unicode data