[ADF-4228] Started basic doc for RTL support (#4432)

2025-07-24 17:32:15 +00:00 · 2019-03-14 11:36:24 +00:00
parent ced2e05d10
commit ae12e3f019
3 changed files with 29 additions and 1 deletions
--- a/docs/roadmap.md
+++ b/docs/roadmap.md
@@ -12,7 +12,7 @@ Last updated 26 Feb 2019:
 - Accessibility (508 compliance and automatic tests).
 - Search highlighting.
 - Better metadata viewer (whitelisting by default).
- Arabic language support.
+- Support for languages that are written right-to-left (such as Arabic).
 - Continue with Governance features into ADF.
 - Better experience in plugin/extensions.
 - Application dashboards.
--- a/docs/user-guide/README.md
+++ b/docs/user-guide/README.md
@@ -17,5 +17,6 @@ on an item below to see the corresponding guide page.
 -   [Transclusion](transclusion.md)
 -   [Typography](typography.md)
 -   [Walkthrough - adding indicators to highlight information about a node](metadata-indicators.md)
+-   [Right-to-left language support](rtl-support.md)

 <!--guide end-->
--- a/docs/user-guide/rtl-support.md
+++ b/docs/user-guide/rtl-support.md
@@ -0,0 +1,27 @@
+---
+Title: Right-to-left language support
+Added: 2019-03-13
+---
+
+# Right-to-left language support
+
+ADF currently has limited support for languages that are written from right to left (such as Arabic).
+
+ADF has been updated and tested to work with the HTML
+[`dir` attribute](https://www.w3.org/TR/html51/dom.html#the-dir-attribute)
+added to the main `<body>` element in `index.html`. When the attribute is set to
+`rtl`, text in the app will be right-aligned as required for right-to-left languages:
+
+```html
+<body dir="rtl">
+    ...
+</body>
+```
+
+Also, we have a [translation file](internationalization.md) for Arabic (code: "ar"),
+which is the
+[most widely used](https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers)
+language written from right to left.
+
+It is on our [roadmap](../roadmap.md) to extend and improve our support for RTL languages
+in the coming versions of ADF.