Template:Dir

ltr

Template documentation

[view] [edit] [history] [purge]

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 ⧼Lang⧽.

• {{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.

All other languages will be assumed to use a left-to-right script.

Code	Language
aeb	تونسي / Tûnsî
aeb-arab	تونسي
aic	aic
ar	العربية
arc	ܐܪܡܝܐ
arq	جازايرية
ary	الدارجة
arz	مصرى
azb	تۆرکجه
bcc	جهلسری بلوچی
bgn	روچ کپتین بلوچی
bqi	بختیاری
bqp	bqp
ckb	کوردی
ckb-arab	ckb-Arab
dv	ދިވެހިބަސް
en-rtl	en-x-rtl
fa	فارسی
fa-af	fa-AF
glk	گیلکی
ha-arab	ha-Arab
haz	haz
he	עברית
khw	کھوار
kk-arab	قازاقشا (تٴوتە)
kk-cn	قازاقشا (جۇنگو)
ks	कॉशुर / کٲشُر
ks-arab	کٲشُر
ku-arab	کوردی (عەرەبی)
lki	لەکی
lrc	لۊری شومالی
luz	لئری دوٙمینی
mzn	مازِرونی
nqo	ߒߞߏ
ota	ota
phn	phn
pnb	پنجابی
prd	prd
prs	prs
ps	پښتو
sd	سنڌي
sdh	کوردی خوارگ
skr	سرائیکی
skr-arab	سرائیکی
tg-arab	tg-Arab
tly	tolışi
ug	ئۇيغۇرچە / Uyghurche
ug-arab	ئۇيغۇرچە
ur	اردو
uz-arab	uz-Arab
xpu	xpu
ydd	ydd
yi	ייִדיש

Examples

• {{dir}}, for the current user language which is ⧼lang⧽ (⧼lang⧽), returns ltr.
• {{dir|en}}, for English (English), returns ltr.
• {{dir|lang=en}}, for English (English), returns ltr.
• {{dir|ar}}, for Arabic (العربية), returns rtl.
• {{dir|yi}}, for Yiddish (ייִדיש), returns rtl.
• {{dir|2=right|3=left}}, for the current user language which is ⧼lang⧽ (⧼lang⧽), returns left.
• {{dir|rtl=right|ltr=left}}, for the current user language which is ⧼lang⧽ (⧼lang⧽), 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.
• {{dir|lang=yi|rtl=right|ltr=left}}, for Yiddish (ייִדיש), returns right.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Dir

Outputs “rtl” for right-to-left languages, else “ltr”. The default returned values “rtl” and “ltr” can also be customized.

Template parameters

Parameter		Description	Type	Status
Language	1	The language to get the direction for, by default the interface language Default {{int:lang}} Example {{PAGELANGUAGE}}	Line	required
Right-to-Left	2	Return value for right-to-left languages Default rtl Example left	String	optional
Left-to-Right	3	Return value for left-to-right languages Default ltr Example right	String	optional

Edit parameter translations

The above documentation is transcluded from Template:Dir/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.