This is an old revision of the document!
Table of Contents
Lokalise
The VuFind® project uses Lokalise to manage its internationalization. This page provides some notes on how to utilize the platform effectively.
Notes for Translators
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…
Notes for Administrators
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.
Importing Translations from VuFind®
Details coming soon…
Exporting Translations to VuFind®
To export the latest Lokalise translations into VuFind®, follow these steps:
- Log in to Lokalise, and go to the “download” page.
- 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.
- Click “Build and download”
- On a machine with the latest VuFind® dev branch checked out, unzip the downloaded .zip file somewhere (e.g. /tmp)
- 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). - Use
git diff
to inspect the loaded translations and make sure they are complete, appropriate and correct. - If all is well, commit the changes!