Template:Dir/doc
 | 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
- Outputs "rtl" for right-to-left languages else "ltr".
- The default returned values "rtl" and "ltr" can also be customized.
- Syntax
-
- {{dir}}
- {{dir|lang=language-code}}
- {{dir|language-code}}
- The 1st (optional) parameter language-code (whose value may be passed alternatively by name as |lang=) 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|lang=language-code|rtl=return value for RTL scripts|ltr=return value for LTR scripts}}
- {{dir|language-code|return value for RTL scripts|return value for LTR scripts}}
- {{dir|rtl=return value for RTL scripts|ltr=return value for LTR scripts}}
- {{dir|2=return value for RTL scripts|3=return value for LTR scripts}}
- The 2nd and 3rd (optional) parameters allow changing the default return values for languages written in RTL and LTR scripts (respectively), whose default are "rtl" and "ltr". These return values may be passed alternatively by name as |rtl= and ltr=.
- This can be used to customize CSS styles such as text alignment or floatting side or lateral margins/borders/paddings, or to change the displayed text/symbols or names of images/icons depending on the script direction.
- Note
- Currently it recognizes the following codes of languages usually written in a right-to-left script:
- ar | arc | arz | azb | bcc | ckb | bqi | dv | fa | fa-af | glk | ha | he | kk-arab | kk-cn | ks | ku-arab | mzn | pnb | prd | ps | sd | ug | ur | ydd | yi
- All other languages will be assumed to use a left-to-right script.
- Examples
-
- {{dir}}, for the current user language which is English (English), returns ltr.
- {{dir|en}}, for English (English), returns ltr.
- {{dir|lang=en}}, for English (English), returns ltr.
- {{dir|ar}}, for العربية (العربية), returns rtl.
- {{dir|yi}}, for ייִדיש (ייִדיש), returns rtl.
- {{dir|2=right|3=left}}, for the current user language which is English (English), returns left.
- {{dir|rtl=right|ltr=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 العربية (العربية), returns right.
- {{dir|yi|right|left}}, for ייִדיש (ייִדיש), returns right.
- {{dir|lang=yi|rtl=right|ltr=left}}, for ייִדיש (ייִדיש), returns right.