Public Kiosk Translations
In the Public Kiosk, translations are created and edited in several different ways depending on which part of the kiosk is being localized.
Translations made on the Kiosk machine
Permalink to Translations made on the Kiosk machinePublic UI text translations are created and edited using the Language tab in the Admin UI on the Windows kiosk machine.
Administration UI text translations are made using a set of utilities run on the Windows kiosk machine. This is a more advanced localization activity that may require assistance from the SOS team. Steps to perform a translation of the Admin UI are described in the Admin UI Translations section.
Translations made on the SOS machine
Permalink to Translations made on the SOS machineKiosk dataset names and descriptions are translated using the SOS Data Catalog and playlists as described in the Kiosk Dataset Translations section.
Group names are translated using playlists as described in the Group Name Translations section.
After finishing your dataset and group translation changes, run media2kiosk, then transfer the resulting files to the kiosk machine using the FTP tab in the Admin UI.
Kiosk Dataset Translations
Permalink to Kiosk Dataset TranslationsThe names and descriptions for datasets in the Public Kiosk are generated by the media2kiosk utility and are written to directories under /shared/sos/kiosk/datasets, where they are used by the kiosk after being transferred there.
Here is a summary of where the dataset informational text displayed in the kiosk comes from:
- The default locale (en_US) names and descriptions are read from the SOS Data Catalog. The descriptions are stripped of any HTML formatting that may have been used
- If there are any translations previously imported into the SOS Data Catalog, those are automatically extracted as well for each of their locales. More information on dataset name and description translations in the Data Catalog is in the Dataset Translations section
- Playlists may also be used to define translations for dataset names and descriptions. These are very similar to the localization playlists used more generally in SOS, which are described in the Dataset Translation Playlists section. How to use these translation playlists is explained next
Translation playlists for datasets reside on the SOS machine under the
/shared/sos/kiosk/playlists/locale/datasets directory. This
directory holds a set of playlists following the naming convention xx_YY.sos
,
where “xx_YY” is the locale code, as described earlier. All the dataset
translations for a given locale are placed together in the same playlist. You
may notice that there is an en_US.sos playlist under the datasets
sub directory. This does not contain translations per se, but the file
contains entries for all the datasets in the default kiosk configuration with
shortened dataset names and descriptions. This was done to work better for
viewing by the general public and can be thought of as a way to override the
Data Catalog text.
English Sample
Permalink to English SampleFor reference, here is a portion of the en_US.sos playlist for datasets, which includes two datasets:
Each of the two datasets shown uses three playlist keywords that are applicable to translations:
include =
path to the dataset playlistrename =
kiosk name for the datasetdescription =
kiosk description for the dataset. Description is a dataset playlist property first introduced in SOS 5.0. The description may have multiple lines, but must always be enclosed between{{
and}}
characters
Translations to other languages work exactly the same way, except that the values for rename and description will not be in English.
Traditional Chinese Sample
Permalink to Traditional Chinese SampleFor example, here are the same two datasets in Traditional Chinese from the translation playlist /shared/sos/kiosk/playlists/locale/datasets/zh_TW.sos:
How to Edit Translations
Permalink to How to Edit TranslationsEditing a translation (or English override text) is done by simply modifying
the values to the right of the equals sign of either rename
or description
keywords for any datasets in a translation playlist with your favorite text
editor. Be sure the description
text is enclosed between {{
and
}}
characters. Should you wish to remove a particular translation entirely,
just delete the lines containing include
, rename
, and description
for any
datasets you no longer want.
How to create translations for a new language:
Permalink to How to create translations for a new language:The easiest way to add another language for dataset translations is to start by
making a copy of the en_US.sos file, then renaming the copied file
to use the locale code to your new language. For example, if you wanted to add
Turkish, you would use a file named tr_TR.sos copied from
en_US.sos. In the new file, replace the English text values with
your new language translations to the right of equals sign for the rename
or
description
keywords. Be sure the description
text is enclosed between {{
and }}
characters.
How to add additional datasets to translations:
Permalink to How to add additional datasets to translations:If you have modified your kiosk configuration by including datasets not found
in the NOAA-defined default configuration, the include
paths for those
datasets will be set in your group playlists (see the section Group and
Dataset Configuration in the Public Kiosk Manual).
To add these to your translation playlists, just copy the include
lines and
add rename
and description
keywords for each one. Be sure the description
text is enclosed between {{
and }}
characters.
Deploying Your Translations
Permalink to Deploying Your TranslationsAfter finishing your translation changes, run media2kiosk, as
the sos
user, then transfer the resulting files to the kiosk machine using
the FTP tab in the Admin UI.
Group Name Translations
Permalink to Group Name TranslationsThe names for groups in the Public Kiosk are generated by the media2kiosk utility and are written to directories under /shared/sos/kiosk/groups, where they are used by the kiosk after being transferred there.
Here is a summary of where the group text display in the kiosk comes from:
- The default locale (en_US) names are the filename stems extracted from group playlist filenames. For example, the playlist /shared/sos/kiosk/playlists/groups/air.sos would have the group name “air”
- Playlists may also be used to define translations for group names. How to use these translation playlists is explained next
Translation playlists for groups reside on the SOS machine under the
/shared/sos/kiosk/playlists/locale/groups directory. This directory holds a
set of SOS playlists following the naming convention xx_YY.sos
, where “xx_YY”
is the locale code, as described earlier. All the group translations for a
given locale are placed together in the same playlist. You may notice that
there is an en_US.sos
playlist under the groups
sub directory. This does
not contain translations per se, but the file contains entries for all
the groups in the default kiosk configuration with slightly different text. For
example, the name for the group defined in air.sos
is “Air”. This was done to
make more attractive looking group labels for the general public and can be
thought of a way to override the filename stem text.
Groups are translated similarly to datasets, except that there is no description. Here is an example of a Traditional Chinese translation for the kiosk groups in /shared/sos/kiosk/playlists/locale/groups/zh_TW.sos:
After finishing your translation changes, run media2kiosk, then transfer the resulting files to the kiosk machine using the FTP tab in the Admin UI.
Admin UI Translations
Permalink to Admin UI TranslationsThe Administration User Interface (Admin UI) in the Public Kiosk may be localized to other languages. Translating the Admin UI is distinctly different than translating the Public UI, group names, and dataset names and descriptions. This activity is non-trivial, so please feel free to contact SOS Support for assistance if you need help beyond what is laid out here.
The Admin UI uses a third-party application called Qt Linguist to
assist you in translating from English to another language. You can also use
Linguist to modify any existing translations. As shown in Appendix A in the
Public Kiosk Manual, there are two translation
files for each locale under C:\shared\sos\kiosk\config\admin:
xx_YY.ts
and xx_YY.qm
, where “xx” = language, “YY” = country or region,
.ts = raw (ASCII) translation format, and .qm =
compiled (binary) translation format. You do not need to know details about
these formats to perform your translations.
Translating the Kiosk Admin UI for a New Language
Permalink to Translating the Kiosk Admin UI for a New Language- If it is running, close the kiosk application on the Windows machine
- Open Windows Explorer from the Start Menu, navigate to C:\shared\bin, and double click on linguist.exe. The Qt Linguist user interface will be displayed
-
From the menu bar, select FileOpen.... In the file browser that pops up, navigate to C:\shared\sos\kiosk\config\admin. Double click on en_US.ts to open the English language raw translations file and display the contents
- From the menu bar, select FileSave As.... In the file browser that pops up, enter the raw translation filename for locale you want. For example, for French in France, type fr_FR.ts. Click the Save button to create the new file
-
From the menu bar, select EditTranslation File Settings.... In the popup window, change the “Target Language” settings to match the language and country for your translation. For fr_FR, the settings will be “Language: French, Country/Region: France”
- Using the Linguist controls, go through each English text element by selecting first the “Context” item and then the first “Source text” item. Replace the English text in the French translation box with your translation. Then click the green Checkmark icon next to the item or in the toolbar to accept the translation. Note that you may also fill in the “French translator comments” box if you wish, but that text will not appear in the kiosk
-
After translating all the “Source text” elements for the first “Context” item, select the next “Context” item and translate all its “Source text” elements. Continue in this fashion through the last “Context” item
- From the menu bar, select FileSave to save your translations to the raw translations file
- From the menu bar, select FileRelease to write your translations to the compiled (binary) translations file
-
Test your translations in the kiosk. You will need to be sure your new locale
is included in the
locale_options
property list (see Properties Tab section of the Public Kiosk Manual) so you can select its button on the right side of the “Title Area”