DavidWhitten: Created page with "{{Documentation subpage}} ; Usage : Outputs "`rtl`" for right-to-left languages else "`ltr`". : The default returned values "`rtl`" and "`ltr`" can..."

2019-06-05T16:11:52Z

Created page with "{{Documentation subpage}} ; Usage : Outputs "<tt>rtl</tt>" for right-to-left languages else "<tt>ltr</tt>". : The default returned values "<tt>rtl</tt>" and "<tt>ltr</tt>" can..."

New page

{{Documentation subpage}}
; Usage
: Outputs "<tt>rtl</tt>" for right-to-left languages else "<tt>ltr</tt>".
: The default returned values "<tt>rtl</tt>" and "<tt>ltr</tt>" can also be customized.

; Syntax
:* <tt><nowiki>{{</nowiki>dir<nowiki>}}</nowiki></tt>
:* <tt><nowiki>{{</nowiki>dir|lang=''language-code''<nowiki>}}</nowiki></tt>
:* <tt><nowiki>{{</nowiki>dir|''language-code''<nowiki>}}</nowiki></tt>
:*: The 1st (optional) parameter ''language-code'' (whose value may be passed alternatively by name as <tt>|lang=</tt>) 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 <tt>{{uselang}}</tt>.
:* <tt><nowiki>{{</nowiki>dir|lang=''language-code''|rtl=''return value for RTL scripts''|ltr=''return value for LTR scripts''<nowiki>}}</nowiki></tt>
:* <tt><nowiki>{{</nowiki>dir|''language-code''|''return value for RTL scripts''|''return value for LTR scripts''<nowiki>}}</nowiki></tt>
:* <tt><nowiki>{{</nowiki>dir|rtl=''return value for RTL scripts''|ltr=''return value for LTR scripts''<nowiki>}}</nowiki></tt>
:* <tt><nowiki>{{</nowiki>dir|2=''return value for RTL scripts''|3=''return value for LTR scripts''<nowiki>}}</nowiki></tt>
:*: The 2nd and 3rd (optional) parameters allow changing the default return values for languages written in RTL and LTR scripts (respectively), whose default are "<tt>rtl</tt>" and "<tt>ltr</tt>". These return values may be passed alternatively by name as <tt>|rtl=</tt> and <tt>ltr=</tt>.
:*: 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.

{| class="wikitable
! Code !! Language
|-
| aeb-arab || {{#language:aeb-arab|{{int:lang}}}}
|-
| ar || {{#language:ar|{{int:lang}}}}
|-
| arc || {{#language:arc|{{int:lang}}}}
|-
| arz || {{#language:arz|{{int:lang}}}}
|-
| azb || {{#language:azb|{{int:lang}}}}
|-
| bcc || {{#language:bcc|{{int:lang}}}}
|-
| bgn || {{#language:bgn|{{int:lang}}}}
|-
| bqi || {{#language:bqi|{{int:lang}}}}
|-
| ckb || {{#language:ckb|{{int:lang}}}}
|-
| dv || {{#language:dv|{{int:lang}}}}
|-
| en-rtl || {{#language:en-rtl|{{int:lang}}}}
|-
| fa || {{#language:fa|{{int:lang}}}}
|-
| fa-af || {{#language:fa-af|{{int:lang}}}}
|-
| glk || {{#language:glk|{{int:lang}}}}
|-
| ha || {{#language:ha|{{int:lang}}}}
|-
| he || {{#language:he|{{int:lang}}}}
|-
| khw || {{#language:khw|{{int:lang}}}}
|-
| kk-arab || {{#language:kk-arab|{{int:lang}}}}
|-
| kk-cn || {{#language:kk-cn|{{int:lang}}}}
|-
| ks || {{#language:ks|{{int:lang}}}}
|-
| ks-arab || {{#language:ks-arab|{{int:lang}}}}
|-
| ku-arab || {{#language:ku-arab|{{int:lang}}}}
|-
| lki || {{#language:lki|{{int:lang}}}}
|-
| lrc || {{#language:lrc|{{int:lang}}}}
|-
| luz || {{#language:luz|{{int:lang}}}}
|-
| mzn || {{#language:mzn|{{int:lang}}}}
|-
| pnb || {{#language:pnb|{{int:lang}}}}
|-
| prd || {{#language:prd|{{int:lang}}}}
|-
| ps || {{#language:ps|{{int:lang}}}}
|-
| sd || {{#language:sd|{{int:lang}}}}
|-
| sdh || {{#language:sdh|{{int:lang}}}}
|-
| skr-arab || {{#language:skr-arab|{{int:lang}}}}
|-
| ug || {{#language:ug|{{int:lang}}}}
|-
| ug-arab || {{#language:ug-arab|{{int:lang}}}}
|-
| ur || {{#language:ur|{{int:lang}}}}
|-
| ydd || {{#language:ydd|{{int:lang}}}}
|-
| yi || {{#language:yi|{{int:lang}}}}
|}

; Examples
:* <tt><nowiki>{{dir}}</nowiki></tt>, for the current user language which is {{#language:{{uselang}}|en}} ({{#language:{{uselang}}}}), returns <tt>{{dir}}</tt>.
:* <tt><nowiki>{{dir|en}}</nowiki></tt>, for {{#language:en|en}} ({{#language:en}}), returns <tt>{{dir|en}}</tt>.
:* <tt><nowiki>{{dir|lang=en}}</nowiki></tt>, for {{#language:en|en}} ({{#language:en}}), returns <tt>{{dir|lang=en}}</tt>.
:* <tt><nowiki>{{dir|ar}}</nowiki></tt>, for {{#language:ar|en}} ({{#language:ar}}), returns <tt>{{dir|ar}}</tt>.
:* <tt><nowiki>{{dir|yi}}</nowiki></tt>, for {{#language:yi|en}} ({{#language:yi}}), returns <tt>{{dir|yi}}</tt>.
:* <tt><nowiki>{{dir|2=right|3=left}}</nowiki></tt>, for the current user language which is {{#language:{{uselang}}|en}} ({{#language:{{uselang}}}}), returns <tt>{{dir|2=right|3=left}}</tt>.
:* <tt><nowiki>{{dir|rtl=right|ltr=left}}</nowiki></tt>, for the current user language which is {{#language:{{uselang}}|en}} ({{#language:{{uselang}}}}), returns <tt>{{dir|rtl=right|ltr=left}}</tt>.
:* <tt><nowiki>{{dir|en|right|left}}</nowiki></tt>, for {{#language:en|en}} ({{#language:en}}), returns <tt>{{dir|en|right|left}}</tt>.
:* <tt><nowiki>{{dir|ar|right|left}}</nowiki></tt>, for {{#language:ar|en}} ({{#language:ar}}), returns <tt>{{dir|ar|right|left}}</tt>.
:* <tt><nowiki>{{dir|yi|right|left}}</nowiki></tt>, for {{#language:yi|en}} ({{#language:yi}}), returns <tt>{{dir|yi|right|left}}</tt>.
:* <tt><nowiki>{{dir|lang=yi|rtl=right|ltr=left}}</nowiki></tt>, for {{#language:yi|en}} ({{#language:yi}}), returns <tt>{{dir|lang=yi|rtl=right|ltr=left}}</tt>.

{{DEFAULTSORT:{{PAGENAME}}}}
<includeonly>
[[Category:Internationalization templates]]
[[Category:formatting templates]]
</includeonly>

Template:Dir/doc - Revision history

DavidWhitten: Created page with "{{Documentation subpage}} ; Usage : Outputs "rtl" for right-to-left languages else "ltr". : The default returned values "rtl" and "ltr" can..."

DavidWhitten: Created page with "{{Documentation subpage}} ; Usage : Outputs "`rtl`" for right-to-left languages else "`ltr`". : The default returned values "`rtl`" and "`ltr`" can..."