From ae12e3f01978a50225661e3ad517f53f2d1f8737 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Thu, 14 Mar 2019 11:36:24 +0000 Subject: [PATCH] [ADF-4228] Started basic doc for RTL support (#4432) --- docs/roadmap.md | 2 +- docs/user-guide/README.md | 1 + docs/user-guide/rtl-support.md | 27 +++++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/user-guide/rtl-support.md diff --git a/docs/roadmap.md b/docs/roadmap.md index 80e7c520fb..afdc9da4d5 100644 --- 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. diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md index a0425ccfd4..1d442dfe05 100644 --- 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) diff --git a/docs/user-guide/rtl-support.md b/docs/user-guide/rtl-support.md new file mode 100644 index 0000000000..d50e1c6dbc --- /dev/null +++ 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 `` 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 + + ... + +``` + +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.