The VuFind® project uses Lokalise to manage its internationalization. This page provides some notes on how to utilize the platform effectively.

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.

Details coming soon…

Lokalise users with administrative access have the power to update Lokalise with the latest translations in the project's GitHub repository, and to export the latest Lokalise translations into the project.

To manually load translations from VuFind®'s GitHub repository into Lokalise, follow these steps:

1. Log in to Lokalise and go to the GitHub app page within the site.
2. 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
3. First instance:
   1. 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
      • Cleanup mode
   2. Click “Pull now”
   3. This will pull all *new* translation tokens into Lokalise
4. Second instance:
   1. 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
   2. Click “Pull now”
   3. 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.

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.

To export the latest Lokalise translations into VuFind®, follow these steps:

1. Log in to Lokalise, and go to the “download” page.
2. Make sure the following download options are set:
   • File format: PHP INI (.ini)
   • Languages: All
   • File structure: Multiple files per language
   • Content to export: Data: All
   • Advanced settings: Don't use directory prefix
   • Empty translations: Don't export
   • App triggers: Ensure that GitHub is unchecked to prevent unwanted PR creation
   • …other settings should not matter.
3. Click “Build and download”
4. On a machine with the latest VuFind® dev branch checked out, unzip the downloaded .zip file somewhere (e.g. /tmp)
5. Run php $VUFIND_HOME/public/index.php language/importlokalise /tmp/language $VUFIND_HOME/language to load the updated translations (replace /tmp/language with the location of your unzipped files, if you chose somewhere other than /tmp).
6. Use git diff to inspect the loaded translations and make sure they are complete, appropriate and correct.
7. If all is well, commit the changes!