Differences

This shows you the differences between two versions of the page.

--- development:architecture:localization:lokalise [2023/09/21 12:53] – [Importing Translations from VuFind®] demiankatz
+++ development:architecture:localization:lokalise [2024/01/11 19:06] (current) – [Importing Translations from VuFind®] demiankatz
@@ Line 1: / Line 1: @@
 ====== Lokalise ======
-The VuFind® project uses Lokalise to manage its internationalization. This page provides some notes on how to utilize the platform effectively.
+The VuFind® project uses [[https://lokalise.com/|Lokalise]] to manage its internationalization. This page provides some notes on how to utilize the platform effectively.
 ===== Notes for Translators =====
@@ Line 7: / Line 7: @@
 Volunteer translators can be granted access to one or more languages used by the project. It is then possible to edit and add translations through a web-based interface. If you would like to volunteer as a translator, please contact info@vufind.org and let us know which language(s) you can help with.
-==== Providing Translations ====
-// Details coming soon... //
+====Useful Resources====
+  * Training video on YouTube: [[https://youtu.be/ZxhXvnkcLQ4?si=L7df3KAd5YZ3I6H0|Lokalise editor for translators tutorial]]
+  * FOLIO's guide to using Lokalise: [[https://wiki.folio.org/display/I18N/How+to+Translate+FOLIO |How to Translate FOLIO]]
+====Getting started====
+. Log into Lokalise using the "Open project" link in the email invitation from Lokalise. You'll need to set your password the first time you log in. Use this [[https://app.lokalise.com/projects/|direct link to Lokalise]] in the future.
+. From the dashboard, click the name of the language you are going to work on. This will bring you to the Editor view.
+. Make sure the FILTER is set to **Untranslated** to see the list of words and phrases that need translation. **Disregard any entries labeled @parent_ini; these do not need your attention.**
+. Identify an item you'd like to translate. The term to be translated will be on the left side, and the word Empty will be on the right side. This is the view within the full list:
+{{:development:architecture:localization:lokalise1.jpg?800|}}
+. To enter your translation, click the word **Empty**. This will open a text entry box into which you can type the translation in your target language.
+{{:development:architecture:localization:lokalise2.jpg?800|}}
+. Lokalise will also offer options for machine-generated translations in the right hand sidebar; you can click one of those, and it will populate the text entry box with that translation. You can use that translation as it is, or you can edit it.
+. Click **Save** when you are ready to save the translation.
+====Additional Suggestions====
+===Access words in text domains===
+To access text domains within the VuFind word/phrase list, click **Filter**, **Filename**. This will allow you to focus on such areas as CallNumberFirst, ILSMessages, and DDC23.
+{{:development:architecture:localization:lokalise3.jpg?600|}}
+===Check entire word list for formatting issues===
+To check for formatting issues within the existing language entries, click **Filter**, **QA** (Quality Assurance). You can focus on issues such as extra whitespaces, unbalanced brackets, HTML issues, etc.
+{{:development:architecture:localization:lokalise4.jpg?600|}}
 ===== Notes for Administrators =====
@@ Line 17: / Line 57: @@
 ==== Importing Translations from VuFind® ====
-To manually load translations from VuFind®'s GitHub repository into Lokalise, follow these steps:
+Lokalise is currently set up to automatically update via webhooks when GitHub receives a push.
+However, if you wish to manually load translations from VuFind®'s GitHub repository into Lokalise, or if you want to double-check the configuration of the automated process, follow these steps:
   - Log in to Lokalise and go to the GitHub app page within the site.
-  - Double-check that the following pull options are set to ON (and all other options are OFF):
+  - The VuFind Github Repo is listed twice as Lokalise struggles with the available settings to add new tokens and update existing translations in a single run
-    * Replace \n with line break
+  - First instance:
-    * Replace modified values
+    - Double-check that the following pull options are set to ON (and all other options are OFF):
-    * Differentiate keys by file
+      * Replace \n with line break
-    * Cleanup mode
+      * Differentiate keys by file
-  - Click "Pull now"
+      * Cleanup mode
+    - Click "Pull now"
+    - This will pull all *new* translation tokens into Lokalise
+  - Second instance:
+    - Double-check that the following pull options are set to ON (and all other options are OFF):
+      * Replace \n with line break
+      * Differentiate keys by file
+      * Replace modified values
+    - Click "Pull now"
+    - This will pull changed translations into Lokalise
+:!: Note that if new translation files are being added on Github these need to be added to the imported files, Lokalise does not do that on its own. To add new files from the GitHub app settings, click "Edit" and then "Select Files to Pull" and check off the new files in the file tree for each of the two configured repositories.
+Note that language mappings for both Github instances need to be identical (e.g. Basque and Basque(Spain), Galician and Galician(Spain)) otherwise languages will show twice with different names.
 Note that it may take a few minutes for processing to complete.