Template:Dir/doc


 * Usage
 * Outputs "rtl" for right-to-left languages else "ltr".
 * The default returned values "rtl" and "ltr" can also be customized.


 * Syntax
 *  
 *  
 *  
 * 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 </tt>.
 *  </tt>
 *  </tt>
 *  </tt>
 *  </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 "rtl</tt>" and "ltr</tt>". These return values may be passed alternatively by name as |rtl=</tt> and 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:
 * ar | arc | arz | azb | bcc | bgn | 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</tt>
 * All other languages will be assumed to use a left-to-right script.


 * Examples
 *  </tt>, for the current user language which is  (<span lang="" dir=""> ), returns </tt>.
 *  </tt>, for  (<span lang="en" dir=""> ), returns </tt>.
 *  </tt>, for  (<span lang="en" dir=""> ), returns </tt>.
 * <tt> </tt>, for   (<span lang="ar" dir=""> ),  returns <tt></tt>.
 * <tt> </tt>, for   (<span lang="yi" dir=""> ),  returns <tt></tt>.
 * <tt> </tt>, for the current user language which is  (<span lang="" dir=""> ), returns <tt></tt>.
 * <tt> </tt>, for the current user language which is  (<span lang="" dir=""> ), returns <tt></tt>.
 * <tt> </tt>, for   (<span lang="en" dir=""> ),  returns <tt></tt>.
 * <tt> </tt>, for   (<span lang="ar" dir=""> ),  returns <tt></tt>.
 * <tt> </tt>, for   (<span lang="yi" dir=""> ),  returns <tt></tt>.
 * <tt> </tt>, for   (<span lang="yi" dir=""> ),  returns <tt></tt>.