Introduction
The eduLNK software aims to provide software to be able to run a secure, persistent and privacy-preserving link shortener for research and education.
More on the project rationale may be found here: eduLNK
eduLNK is based on short, the software developed by SURF and currently used for their edu.nl link shortener service.
To make the software as accessible as possible we want to provide support for as many languages as possible.
At the time of writing, the product supports
- Dutch
- English
- Spanish
- German
This guide describes how you may add your favourite language to the product. To support the translation effort, we have deployed a tool called weblate, which should provide you with an easy user interface to contribute a translation.
Application reference and demo service
To provide you with context for the translation, we have a demo of the latest version of the software available at https://test.edulnk.org/. eduLNK needs to establish of a user is a member of our community and supports both federated identity as well as the InAcademia service to so so.
This demo version uses the integration platform of the InAcademia service. To validate yourself as a member of the R&E community, for this test version, you can validate using the "Login with InAcademia" button top right, which will take you to a test IdP. To complete validation, please authenticate as "student1" with password "student1" and when presented with the InAcademia consent screen, please press "continue". This should take you into 'student1's shortened links, and provide access to all available end-user pages of the application.
At the end of this document we have also added screenshots of the application as a reference to assist in translating.
Registering with Incubator weblate
To provide a new translation, or contribute to an existing one, please register at the Incubator weblate instance at https://weblate.incubator.geant.org.
After you have responded to the activation email, you will be able to login with the credentials you just created.
Now please proceed to the short project: https://weblate.incubator.geant.org/projects/short/
Translating messages
We kindly ask you to translate two sets of text, called 'components' in weblate:
- Common GUI element such as texts and buttons, as can be found in "messages" component
- A number of validation messages to notify users of errors when entering data, as shown in the "validators" section
To start translating, please select "messages".
This will show an overview of all the languages the messages component has already been translated into, either completed (like e.g. Dutch) or where a partial translation is available (like e.g. Nuosu).
Contribute to an existing translation
To contribute or complete a partial translation, please select the language you want to work on, this will take you to the overview page of the messages component for the selected language. Then select "Translate" to go to the translation screen.
The translation screen will who all text elements that need translation (52 messages in this case) with the English version as a reference. In the above example, you may now provide a translation for the equivalent of "Login with {{value}}" in Nuosu.
When you are done translating this word, you may go to the next one by selecting "save".
A faster way to translate is provided by selecting "zen mode", which is the link with the lightning icon in the top right, or by going to https://weblate.incubator.geant.org/zen/short/messages/ii/ (replace ii with your langauge).
Zen mode provides a list of all the things that need translating on 1 page, and personally, I find this much easier and faster to work with.
Starting a new translation
If your favourite language is not yet available, please select the "Start new translation" button from the messages component page (https://weblate.incubator.geant.org/projects/short/messages/)
You will be asked to select which language you want to add, and then be redirected to the language overview page for the component. From there you can contribute your translation by as described in the section "Contribute to an existing translation"
Translating "validations"
Please note we have both a messages component and a validations component. We kindly ask you to provided translations for both. To start translating validations, please select "validations" from the project page or go directly to the validation component by selecting https://weblate.incubator.geant.org/projects/short/validators/
Application screenshots (for reference and context)
Welcome screen
| Links management screen
|
Link and QR preview | Edit existing link  |
New link created  | About page  |
Support page  |
