Skip to content
Brian Riley edited this page Nov 18, 2021 · 5 revisions

Overview

The DMPTool uses Translation.io to manage translations. Translation.io provides a convenient user interface for managing translations. Translation.io will auto-translate (via Google Translate) new text when the DMPTool team uploads changes.

The DMPTool team will then retrieve the latest translations from Translation.io each time we issue a new release/version of the DMPTool (typically once every 2-3 weeks).

Get Involved

In order to start contributing to the translation of the DMPTool, our team will need to get you setup as a translator for this project. Create an account on Translation.io and then contact us to request access and specify the email address you used to create your Translation.io account as well as which languages you'd like to translate.

Communication

Translation.io will notify us when you've provided new translations. We will retrieve the latest translations from the site prior to publishing a new release/version of DMPTool (typically every 2-3 weeks).

If you have made a large number of translation changes (e.g. you provided translations for a new language that we do not already support) and can not wait until the next release/version is ready, we recommend creating a new Github issue and requesting that we create a new release/version of the DMPTool that will include your translations (please add the 'translations' label to the issue).

Translation.io will notify you (depending on your email preferences defined in Translation.io) when we have uploaded new text that has not yet been translated.

New languages

If you would like to add support for a new language you should follow the 'Get involved' instructions above. We will then enable the language in Translation.io and the DMPTool and provide you with access to begin translating.

Difference between DMPRoadmap and DMPTool

The DMPTool is based on the DMPRoadmap open-source codebase. Each of these codebases maintains its own set of translations. When we provide you with access to be a translator in Translation.io, you will be given access to update both of these projects.

The DMPRoadmap project contains the core text behind the application (e.g. Plan editing pages, template maintenance pages, my dashboard page, etc.). All translations you provide for this project will benefit a large number of DMPRoadmap based systems (e.g. DMPonline, DMPOPIDoR, DMP Assistant, etc.)

The DMPTool project contains text that is specific to the DMPTool (e.g. about us page, homepage, etc.)

Translation.io allows you to easily switch between projects on the Projects page. Clicking on the specific Project will bring you to the translations for that project: Screenshot of Translation.io project selection

Translating

The main translation page of Translation.io is broken up into a 2 column layout. The left hand side of the screen allows you to filter and search through the list of translatable text. The right hand side of the screen allows you to translate the text you have selected on the left hand side of the screen.

Screenshot of Translation.io interface

Language selection

You can change the language by clicking on the language code at the top of the page near the project name:

Screenshot of Translation.io language selection

Filtering

The 'Filters' dropdown on the left hand side of the page allows you to refine the list of translatable text. The most useful filters are 'untranslated' which will show you any new text that has yet to be translated and 'autotranslated' which will display any text whose translation was automatically generated by Google translate.

Screenshot of Translation.io language selection

Translating

Once you have selected a text item on the left, you will be presented with a list of suggestions on the right hand side of the page and a text area that you can use to enter a translation. Any changes you make are automatically saved.

In some circumstances a text item may contain HTML (e.g. <a href="https//dmptool.org">DMPTool home page</a> or parameter markup (e.g. Welcome to the %{application_name} or Welcome to the %<app_name>s). This markup MUST be retained when you provide a translation.

Translation.io makes it easy for you to retain markup. If you click on the markup in the untranslated text box it will copy the markup into your translation. Screenshot of Translation.io language selection

Translation.io will also provide warning indicators to your translations if you have forgotten to retain any markup, or the markup has typos: Screenshot of Translation.io language selection

Developers

Please see the DMPRoadmap translation wiki for more information about using Translation.io to manage your own installation of the DMPTool codebase.

Clone this wiki locally