ARK2/Localization - Revision history

John Layt: /* Localization */

2018-03-05T23:32:56Z

‎Localization

John Layt: /* Design Decisions To Be Made */

2017-09-27T22:50:41Z

‎Design Decisions To Be Made

John Layt: /* Translation Workflow */

2017-09-07T14:16:04Z

‎Translation Workflow

John Layt: /* Translation */

2017-09-07T14:01:46Z

‎Translation

John Layt: /* Localization */

2017-05-04T21:06:54Z

‎Localization

John Layt: /* Design Decisions To Be Made */

2016-12-31T23:32:44Z

‎Design Decisions To Be Made

John Layt: /* Design Decisions To Be Made */

2016-12-31T23:31:23Z

‎Design Decisions To Be Made

John Layt: /* Design Decisions To Be Made */

2016-12-31T23:30:07Z

‎Design Decisions To Be Made

John Layt: /* Localization */

2016-10-29T16:58:00Z

‎Localization

John Layt: Created page with "= Localization = Localization is the process of translating the user interface and data into the language and formats of the user. ARK2 uses the following components for loc..."

2016-10-29T16:46:30Z

Created page with "= Localization = Localization is the process of translating the user interface and data into the language and formats of the user. ARK2 uses the following components for loc..."

New page

= Localization =

Localization is the process of translating the user interface and data into the language and formats of the user.

ARK2 uses the following components for localization and translation:
* The [http://symfony.com/doc/current/components/intl.html Symfony Intl] component as a wrapper for the [http://php.net/manual/en/book.intl.php PHP Intl] extension and using ICU, for collation, formatting and parsing
* The [http://symfony.com/doc/current/components/translation.html Symfony Translation] component for translation
* [http://punic.github.io/ Punic], using CLDR, as a source of some translations

A key to providing Ark-As-A-Service will be translating the user interface and schemas into as many languages as possible to maximise the potential user base. ARK does not have the tools to make this process easy to perform or manage, and it would be a waste of resources to build them. It is recommended to use one of the existing online open-source translation projects to crowd-source the translations. This will allow interested parties and potential clients to translate ARK for themselves and to grow a local community to support ARK in their country.

Changes will be made to the translation process to bring ARK into line with industry best practices and tooling, allowing for common features such as correct plural forms.
* Translations would be performed using the Symfony Translation package
* Translations will be stored and transmitted in the XLIFF file format
* Translations will use keys (similar to current, but expanded)
* Translations will be split in a number of catalogues:
** Core interface
** User interface
** Admin interface
** Schema (one for each created)

Inparticular
* Markup table will be dropped entirely
* Aliases will be kept as table-driven translations using a custom catalogue loader
* A custom Address Book catalogue loader will be used to provide names via the translation system

Potential online portals include:
* [https://www.transifex.com Transifex] - Market leader, but now closed source, offers free hosting to open source projects, large community, great features and automated workflow, API, Github integration, etc.
* [http://zanata.org/ Zanata] - A Red Hat open-source project (in response to Transifex going closed) with free hosting and large existing community, or can be self-hosted (JBoss based), great features and automated workflow, API, Github integration, etc. No RTL?
* [https://weblate.org/en/features/ Weblate] - An open-source project with free and paid-for hosting, but no central community, or can be self-hosted, good features, API, Github integration, etc. Django based.
* [http://translationproject.org/html/welcome.html Translation Project] - A FSF open-source project with free hosting and large existing community, but very basic features and manual workflow.
* [http://pootle.translatehouse.org/index.html Pootle] - An open-source project, self-hosted, Django based

Zanata would seem the preferred option for a hosted service, but Weblate might be better if self-hosting.

A number of options exist for automating extraction of Symfony translations, or for allowing interactive editing inside the admin panel or profiler panel:
* https://jolicode.com/blog/translation-workflow-with-symfony2
* https://github.com/deanc/silex-web-translator
* https://github.com/Aecf/TranslatorToolBundle
* https://github.com/instaclick/TranslationEditorBundle
* https://github.com/lexik/LexikTranslationBundle
* https://github.com/manuelj555/ManuelTranslationBundle

None of these quite match our requirements, but may be adapted to achieve our workflow.

@@ Line 6: / Line 6: @@
 * The [http://symfony.com/doc/current/components/intl.html Symfony Intl] component as a wrapper for the [http://php.net/manual/en/book.intl.php PHP Intl] extension and ICU, for collation, formatting and parsing
 * The [http://symfony.com/doc/current/components/translation.html Symfony Translation] component for translation
 * The standard JS [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl Intl API], or the [https://github.com/andyearnshaw/Intl.js Intl Polyfill] where Intl is not available
 == Translation ==
-* Translations are stored and transmitted in the XLIFF file format, allowing offline apps to download the full catalogue
+* Translations are stored in the core database
 * Translations uses keys rather than source strings
 * Translations will be split in a number of catalogues:
@@ Line 21: / Line 21: @@
 * Actor and User IDs are translated live using a custom loader from the database
-The Admin Interface provides a basic interface for the maintaining of translation. Export and import interfaces are provided for the ???? online translation community.
+The Admin Interface provides a basic interface for the maintaining of translation. Export and import interfaces are provided for the chosen online translation community.
 == Translation Workflow ==

← Older revision		Revision as of 22:50, 27 September 2017
Line 74:		Line 74:

	None of these quite match our requirements, but may be adapted to achieve our workflow.		None of these quite match our requirements, but may be adapted to achieve our workflow.
		+
		+	Translations in javascript:
		+	* https://github.com/willdurand/BazingaJsTranslationBundle
		+	* https://github.com/wikimedia/jquery.i18n

@@ Line 42: / Line 42: @@
 * Translations are loaded from the XLIFF files, database is only used for Actors/Users
 * Translation Admin page is available, but changes do not take effect until exported to XLIFF
 == Design Decisions To Be Made ==

@@ Line 11: / Line 11: @@
 == Translation ==
-* Translations are stored and transmitted in the XLIFF file format
+* Translations are stored and transmitted in the XLIFF file format, allowing offline apps to download the full catalogue
 * Translations uses keys rather than source strings
 * Translations will be split in a number of catalogues:
 ** Core interface
 ** User interface
 ** Admin interface
 ** Schema (one for each created)
-* Actor and User IDs are translated using a custom loader from the database
+* Actor and User IDs are translated live using a custom loader from the database
 The Admin Interface provides a basic interface for the maintaining of translation. Export and import interfaces are provided for the ???? online translation community.
 == Design Decisions To Be Made ==

@@ Line 42: / Line 42: @@
 * https://github.com/manuelj555/ManuelTranslationBundle
 * https://github.com/Happyr/TranslationBundle
 None of these quite match our requirements, but may be adapted to achieve our workflow.

@@ Line 27: / Line 27: @@
 * [http://zanata.org/ Zanata] - A Red Hat open-source project (in response to Transifex going closed) with free hosting and large existing community, or can be self-hosted (JBoss based), great features and automated workflow, API, Github integration, etc. No RTL?
 * [https://weblate.org/en/features/ Weblate] - An open-source project with free and paid-for hosting, but no central community, or can be self-hosted, good features, API, Github integration, etc. Django based.
 * [http://translationproject.org/html/welcome.html Translation Project] - A FSF open-source project with free hosting and large existing community, but very basic features and manual workflow.
 * [http://pootle.translatehouse.org/index.html Pootle] - An open-source project, self-hosted, Django based

@@ Line 34: / Line 34: @@
 A number of options exist for automating extraction of Symfony translations, or for allowing interactive editing inside the admin panel or profiler panel:
 * https://jolicode.com/blog/translation-workflow-with-symfony2
 * https://github.com/deanc/silex-web-translator
 * https://github.com/Aecf/TranslatorToolBundle
@@ Line 39: / Line 40: @@
 * https://github.com/lexik/LexikTranslationBundle
 * https://github.com/manuelj555/ManuelTranslationBundle
 None of these quite match our requirements, but may be adapted to achieve our workflow.