Template:Dir/doc
Appearance
This is a documentation subpage for Template:Dir. It contains usage information, categories, and other content that is not part of the original template page. |
Usage
[edit]Outputs "rtl" for right-to-left languages else "ltr". The default returned values "rtl" and "ltr" can also be customized.
Syntax
[edit]{{dir|language-code}}
- The language-code parameter should be conforming to BCP47, as required by web standards (HTML/CSS …), rather than Wikimedia labels for designating languages in domain names (in some cases, Wikimedia language codes are not conforming and only used for interwikis and URLs; most of them are being migrated to BCP47, which is based on some parts of the ISO649 standard).
- If no language-code parameter is specified, it defaults to the preferred UI language of the visitor viewing the current page, which for you is currently en.
{{dir|language-code|return value for RTL scripts|return value for LTR scripts}}
- The 2nd and 3rd (optional) parameters allows changing the default return values for languages written in RTL and LTR scripts, whose default are respectively "rtl" and "ltr".
- This can be used to customize CSS styles such as text alignment or floating side or lateral margins/borders/paddings, or to change the displayed text/symbols or names of images/icons depending on the script direction.
Note
[edit]Currently it recognizes the following codes of languages usually written in a right-to-left script:
- ar | arc | ary | arz | azb | bcc | ckb | bgn | bqi | dv | fa | fa-af | glk | ha-arab | he | kk-arab | kk-cn | ks | ku-arab | mzn | pnb | prd | ps | sd | ug | ur | ydd | yi
Languages to add (see talk page):
Examples
[edit]{{dir}}
, for the current user language which is English (English), returns ltr.{{dir|en}}
, for English (English), returns ltr. (should be ltr){{dir|ar}}
, for Arabic (العربية), returns rtl. (should be rtl){{dir|yi}}
, for Yiddish (ייִדיש), returns rtl. (should be rtl){{dir|bgn}}
, for Western Balochi (روچ کپتین بلوچی), returns rtl. (should be rtl){{dir|2=right|3=left}}
, for the current user language which is English (English), returns left.{{dir|en|right|left}}
, for English (English), returns left.{{dir|ar|right|left}}
, for Arabic (العربية), returns right.{{dir|yi|right|left}}
, for Yiddish (ייִדיש), returns right.
TemplateData
[edit]This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.
TemplateData for Dir
Outputs “rtl” for right-to-left languages, else “ltr”. The default returned values “rtl” and “ltr” can also be customized.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Language | 1 | The language to get the direction for, by default the interface language
| Line | required |
Right-to-Left | 2 | Return value for right-to-left languages
| String | optional |
Left-to-Right | 3 | Return value for left-to-right languages
| String | optional |
Edit parameter translations