Evergreen DokuWiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
 **New Developers Working Group**
====== Internationalization ======

Evergreen is designed to work in multiple languages, but it requires a bit of configuration to get it set up. 

===== Enabling a Language =====

==== 1. Install Translation Files ====

**Prerequisite:**

As root, install a translation tool: 
  - Refresh local package cache: apt update
  - Navigate to /home/opensrf/Evergreen
  - Install the translator (replace "ubuntu-focal" with your OS if different): <code>make -f Open-ILS/src/extras/Makefile.install ubuntu-focal-translator</code>

**Prior to installing Evergreen:**

As opensrf, navigate to Evergreen/build/i18n:
  - mkdir locale
  - make newpot
  - make LOCALE=cs-CZ updatepo  //(where cs-CZ is the language you are configuring)//
  - make LOCALE=cs-CZ install //(where cs-CZ is the language you are configuring)//

Repeat steps 2-4 for each additional language.

**Copy Files**

At this point, you should have PO files under: 
  * /Evergreen/Open-ILS/src/data/locale/   (subfolders for each section)
  * /Evergreen/Open-ILS/src/templates/locale/ (one file per section per language)

Copy each of these folders to the corresponding location on your server.
  * cp -r /home/opensrf/Evergreen/Open-ILS/src/data/locale/ /openils/var/data/
  * cp -r /home/opensrf/Evergreen/Open-ILS/src/templates/locale/ /openils/var/templates/

==== 2. Configure the Evergreen Database (if needed) ====

All language files you use need to be present in the locales table, so any custom files or files that aren’t included in master will need to be added. 

See if the one you need is already present: 

<code>SELECT * FROM config.i18n_locale;</code>

{{:newdevs:pasted:20230915-113812.png}}

Add an entry for each additional language you wish to add:

<code>INSERT INTO config.i18n_locale VALUES ('cs-CZ','cze','Czech','Czech');</code>

If you've created a local translation file to override the default strings, add that as well: 

<code>INSERT INTO config.i18n_locale (code, marc_code, name, description) 
VALUES ('en-PINES', 'eng', 'PINES', 'PINES English');</code>

Add the generated seed data if it was not already installed. Navigate to /Evergreen/build/i18n/locale/cs-CZ and run:

<code>psql -U evergreen -a -f 950.data.seed-values.sql</code>
==== 3. Modify eg_vhost.conf ====

  - Switch to root
  - File location: etc/apache2/eg_vhost.conf 
  - Look for the "Locale messages files" section around line 700
  - Uncomment or add lines for the new languages you are adding: <code>PerlAddVar OILSWebLocale "cs_cz"
PerlAddVar OILSWebLocale "/openils/var/data/locale/opac/cs-CZ.po"</code>
  - The default language is US English, but you can change that by uncommenting and modifying the OILSWebDefaultLocale line:<code>PerlAddVar OILSWebDefaultLocale "cs-cz"</code>
  - Restart services<code>su - opensrf -c "bash -i -c '/openils/bin/osrf_control --localhost --restart-all'"</code>
  - Restart Apache<code>/etc/init.d/apache2 restart</code>
  - Clear browser cache

==== 4. Configure the Angular Staff Client ====

The newer Angular administration interfaces provide a button to add translations (for example, the MARC Coded Value Map controls the Audience dropdown fields in the OPAC advanced search), but you will need to edit a file in order to enable it for each language.

  - Switch to opensrf user
  - Edit Open-ILS/src/eg2/src/environments/environment.prod.ts
  - Modify the locales array (eg, locales: ['en-US','cs-CZ','es-ES']
  - Recompile Angular: Go to the Open-ILS/src/eg2 folder and run: ng build
    
===== Marking Up Evergreen (Angular HTML Template Pages) =====

Most strings only require the addition of "i18n" to the innermost tag surrounding text: 

<code><button type="button" class="btn btn-success" (click)="close(true)" i18n>Confirm</button></code>

Tags that include the text rather than wrapping around the next need to be structured slightly differently.

Label example: 
<code><eg-link-table-link i18n-label label="Claiming" routerLink="/staff/admin/acq/claiming"></eg-link-table-link></code>

Page banner example:
<code><eg-staff-banner bannerText="Acquisitions Administration" i18n-bannerText></eg-staff-banner></code>

Example of a patch that adds new strings:
  * [[https://git.evergreen-ils.org/?p=working/Evergreen.git;a=commitdiff;h=a581623b2cfd56d072a1c3b00ad138811a448d50|LP#1951307: Contextual confirm dialog button text]]

===== Marking Up Evergreen (Angular TypeScript Pages) =====

When creating a message in TypeScript, use the $localize tag handler with backticks around the text. 

Example: 
<code>warning_msg = $localize`Watch out!`;</code>

Example:
<code>warning_msg = $localize`There is a problem with ${this.barcode}`;</code>

===== Marking Up Evergreen (Template Toolkit Pages) =====

Template Toolkit pages (aka TT2 or .tt2 files) should wrap every display string with "l()" to indicate that it should be translated:
<code>[% l('Library Hours') %]</code>

===== Translating Strings in Launchpad =====

Evergreen translation files are stored in Launchpad. They are downloaded and brought into Evergreen as PO files. 

  * [[https://translations.launchpad.net/evergreen|Launchpad - Translations]]

You can add or update translations directly in Launchpad one string at a time or edit them locally with POEditor and then upload them. 

  * [[https://poeditor.com/join/project/2FlOsiPYag|POEditor site]]
  * [[:poeditor|Working with POEditor]]

===== Notes =====

  * When selecting a language on one screen, it affects other areas of Evergreen.  Ex: Changing the selector to Spanish in the OPAC will also cause the staff side to show Spanish.
  * When changing languages, it's best to refresh your browser and clear your browser cache

===== Finding common translations using CLDR data: Czech, Spanish, French =====

The [[https://cldr.unicode.org/|Unicode CLDR project]] has a wealth of information on locale-based data. For example, the [[https://cldr.unicode.org/translation/date-time/date-time-names|Date/Time Names]] and [[https://cldr.unicode.org/translation/date-time/date-time-patterns|Date/Time Patterns]] can be helpful when working with dates. The summary tables serve as a concise reference for our most common languages.

Find the Field Name you need in the documentation (e.g. weekdayOfMonth) and then reference the summary tables to find translations:

  * [[https://unicode.org/cldr/charts/42/summary/cs.html|Czech (cz) locale data summary]]
  * [[https://www.unicode.org/cldr/cldr-aux/charts/28/summary/fr.html|French (fr) locale data summary]]
  * [[https://www.unicode.org/cldr/cldr-aux/charts/28/summary/es.html|Spanish (es) locale data summary]]

===== Known Issues =====

See [[i18n:problem_children|i18n Problem Children]] for an overview of the known translation issues:

{{METATOC >:i18n:problem_children}}

===== Additional Resources =====

  * [[https://angular.io/guide/i18n-overview|Angular Internationalization site]]
  * [[evergreen-admin:customizations:i18n|Internationalization (I18N), Localization (L10N), and Globalization (G11N)]]
  * [[:eg_translations|Evergreen Translations]]
  * Presentation: Localization Is So Much More Than Just Translation - [[https://tinyurl.com/evergreentranslation|Slides]] - [[https://youtu.be/hqmWpFEXL48|Video]]





{{tag>i18n devdocs}}