Directionality support



Support for different directions (left-to-right, right-to-left) is an important aspect for multilingual software.

Since , the support has been considerably improved.

This page gives some relevant information, and guidelines for developers and wiki administrators if you want to make a feature or extension compatible with the right-to-left interface and different directionality in general.

User-level tips
Some general tips for users, before getting to details for developers:


 * Most browsers support changing the direction of a plain-text editing area, such as article search boxes, wiki syntax editing, edit summary, etc. Depending on browsers and operating systems, this is done by Ctrl-Shift (Chrome and IE on Windows), Ctrl-Shift-X (Firefox), Option-Click-Change direction (Mac).  This should help you typing in a direction that is different from the site's usual direction.


 * When typing a section in a language that has a direction that is different from the site's, add a div tag with appropriate lang, dir and class attributes. For example, when typing an English section in the Arabic Wikipedia, type   in the beginning and  in the end.


 * When typing just a few words inside a paragraph, put them inside a  tag with appropriate lang and dir attributes. (Many wikis have a template for this, such as   ).

When a template is available, it's usually preferred to using the Unicode character itself.
 * To separate numbers from an adjacent word with different directionality, use RLM or LRM characters. Many wikis have templates for this, for example    in the Hebrew Wikipedia,    in the Arabic Wikipedia,    in the Persian Wikipedia, etc.

You can report bugs in RTL handling in Phabricator in any MediaWiki-related project using the RTL tag.

ResourceLoader
Thanks to <tvar|rl>ResourceLoader</> including <tvar|url>CSSJanus</>, CSS is automatically flipped to right-to-left when the user language is RTL. This is default since <tvar|version>1.18</> (in previous versions it was bug>bugzilla:6100</>|dependent on the wiki content language). There is relatively little CSS that must depend on the content language.

As a temporary work-around test RTL interface with debug off. (Issue being tracked as <tvar|task>T29025</>.)
 * Attention: when using ResourceLoader's mode>ResourceLoader/Features#Debug mode</>|debug mode, the CSS may be inconsistently rendered compared to the production mode.

What kind of languages?

 * $wgLang - user language (and the respective direction)


 * $wgContLang - site content language (and respective direction) -> here LTR

This sets the TOC (and stuff like grammar, although not really relevant mostly) to that language. To do that only, use parserOptions->setTargetLanguage
 * Title->getPageLanguage - page content language (and respective direction) -> by default the same as site content language
 * There are some default exceptions: see below
 * It can be set in extensions by the hook pcl>Manual:Hooks/PageContentLanguage</>|PageContentLanguage

This returns $wgLang in 1.18 and higher but $wgContLang in 1.17 (by default).
 * In extensions that should remain compatible with 1.17, you can use wfUILang, however this breaks compatibility with 1.16 and below.

What should follow which kind?

 * Special pages follow the user language by default.


 * Source code should be English (CSS/JS pages are set to English by default).


 * Pages with translated subpages should follow the language of the translation (e.g. "Page" is wgContLang, "Page/he" is "he"). This is the default for the MediaWiki namespace.


 * Input boxes and textareas follow content direction by default.


 * When viewing a diff, it follows the user language, but the actual diff text is in the page content language.

What should I add in the source code?
Example: <tvar|xmp>SpecialRecentchanges->setTopText</> which adds the "<tvar|msg>recentchangestext</>" message in the wiki content language.
 * Anything on special pages that is different from the user language should have a <tvar|tag> </> tag.


 * Anything on custom namespaces that contains text different from the default wiki content should also have a  tag.


 * When the diff text is not the same as the page content language, use <tvar|code> </> where $diff is a DifferenceEngine object.

lang/dir attributes
You should use HTML: but sometimes that is difficult in dynamically generated elements and you can fall back on CSS:

Wiki content
You can use <tvar|ltr> </> and <tvar|rtl> </> classes to make use of edit section links and ul/ol elements based on that direction.


 * E.g.

This is of course used for the page content of articles.


 * On file pages, it is only added around the actual text while the rest of the file page is custom UI (file history, ...).


 * On category pages it is added as on regular pages, but the text in the user language is embedded in a  with   and   attributes according to the user language.


 * On special pages it is not added because these are largely in the user language. A piece of text on special pages can be in the content language, which should then be embedded in these classes.  It is for example used in the CodeReview extension for the code summary and code comments, which can contain ul/ol elements (* and # wikitext) in the wiki content language and in principle not the user language obviously.

Adding UI stuff within these classes should not be done. For example, the category links and FlaggedRevs review form are inside #bodyContent but outside .mw-content-ltr/rtl.

A new feature is that these classes can be used within these classes. For example, .mw-content-rtl can be used in an LTR (mw-content-ltr) article. This is useful for multilingual pages. Prior to this, local MediaWiki:Common.css hacks had to be used to make e.g. bullet lists show correctly in <div dir="ltr/rtl"> text. You should therefore use <div class="mw-content-ltr/rtl"> instead of <div dir="ltr/rtl"> when editing wiki pages.

See also Manual:Interface/IDs and classes.

body classes
The body tag has an <tt>ltr</tt> or <tt>rtl</tt> class by default, which follows the user language. You shouldn't use that, because CSS is automatically flipped based on the user language. The body tag also features a new (1.18) <tt>sitedir-ltr</tt> and <tt>sitedir-rtl</tt> class which follows <tt>$wgContLang->getDir</tt>. If there is need for it, a "userlang-ltr/rtl" and/or "pagelang-ltr/rtl" could be added as well.

float/text-align
You can use <tt>$wgLang->alignStart</tt>, <tt>$wgContLang->alignStart</tt>, <tt>$wgLang->alignEnd</tt>, <tt>$wgContLang->alignEnd</tt> which gives the appropriate 'right' or 'left' values.

You can use CSS <tt>float</tt> or <tt>text-align</tt> of which the value (left/right) is flipped for RTL interface languages.

Examples
Special:AllMessages is a special page, which means it follows the user language direction. However, the actual messages should follow the direction of the selected language. The cells in the table containing the content of the messages, have a lang & dir attribute.
 * Special:Allmessages = English, LTR
 * Special:Allmessages/he = Hebrew, RTL

The Translate extension, making use of the PageContentLanguage hook, sets the right language (and consequently direction) for translated pages, see e.g. Wikimedia_maintenance_notice/ar which benefits from the mw-content-rtl class on an LTR wiki.

Local wikis
MediaWiki:Common.css pages and relatives are also flipped. This means that you have to add @noflip where needed.

See T33923: site CSS should not be flipped by default

Issues

 * Most major features and extensions have improved support since about 1.19, see translatewiki:Project:Better directionality and i18n development for that.
 * Known remaining issues:
 * External link icons are flipped according to user language direction (minor issue)
 * LiquidThreads: Use contlang instead of pagelang, otherwise special page returns userlang
 * WikiLove: kittens aligned left ( Blabla.jpg ) should be aligned right in RTL wikis (minor issue)
 * OmegaWiki: needs general overhaul (Expression and DefinedMeaning pages should follow user direction) + 23035
 * Search bugs: https://bugzilla.wikimedia.org/buglist.cgi?quicksearch=rtl