Localization Language Feature (5.3)

Size: px

Start display at page:

Download "Localization Language Feature (5.3)"

Moris Cross
6 years ago
Views:

1 Localization Language Feature (5.3) Manufacturer: ELAN Model Number(s): HC Series Controllers Minimum Core Module Version: g! Comments: Document Revision Date: 11/17/2011 OVERVIEW AND SUPPORTED FEATURES ios g!mobile App version or newer required. Note: This document details the Language Feature for Core Module 5.3 or newer. For information on 5.2 Language features, please see that document. The Language feature will allow a dealer to translate common text in the Viewer into other languages, both with custom editing from the Configurator or from the import of pre-translated language files. Using the language feature, it should be possible to alter the text for any static text that is commonly displayed in the Viewer. Note that some text is pulled dynamically from outside sources such as the internet, metadata, or third party equipment and that any such dynamic data may not be translated. See the Common Resource Library for a full list of currently available pre-translated language files. Note the Configurator will always appear in English, and the dealer must be comfortable working with an English language based Configurator. Core Module 5.3 expands the Localization feature added in version 5.2, primarily to add support for Simplified Chinese, initial ios app support, and some digital media improvements. Important: The language XML file has been changed in core module 5.3 and contains more words and phrases. See the Importing Earlier Versions section below for special steps required for handling any situations where you may need to use files created in an earlier version. THE INTERNATIONALIZATION FEATURE SUPPORTS THE FOLLOWING FEATURES: Viewer Translation: Static Text present in the standard Viewer interface may be translated and/or customized from a Configurator based Language Editor. Note all Viewers will use the same translation. Import/Export of Language XML files: Customized and translated Language files may be imported or exported from Configurator. This allows the installer to import pre-translated language files from Elan (as available) when importing, or to export any custom changes/translations to a file for import on other systems. Note that while the bulk of the Viewer will be translated from the Language editor and can be saved/imported with the XML file, some text must be changed as the subsystem is added (such as source/zone names on the Media tab). Configurator Editor: The Configurator includes a Language editor which allows the customization of the static text fields in the Viewer, either from English or after importing a pre-translated XML file. Roman, Simplified Chinese and Cyrillic Based Alphabets: The Viewer supports fonts/character sets that support display and input of Roman, Simplified Chinese and Cyrillic based characters. ios App: The ios App supports translated interfaces. See minimum version in the document header. HR2, OSD, PC Viewer & Elan TS7/10/VL10 Touch Screens: Elan Touch Screens TS7/TS10/VL10, and PC Viewer software support translated interfaces using all supported alphabets. In addition, the HR2 Handheld interface and g! On Screen Display (OSD) support translated interfaces using all supported alphabets. 1 of 11

2 TS2 Interfaces using Roman and Cyrillic Alphabets: TS2 Interfaces support translations using Roman and Cyrillic Character Sets. Note: Chinese Character sets are not supported by the TS2. Sonance iport: The Sonance iport, when integrated as described in its g! Integration Note, will support the reading and display of meta-data using all supported character sets. Digital Music: The HC Internal Player may be used with MP3 files containing localized meta-data. THE INTERNATIONALIZATION FEATURE DOES NOT SUPPORT THE FOLLOWING FEATURES: Translated Configurator: There is no facility for translating the g! Configurator. The installer must be comfortable programming with an English language Configurator. Time/Date Format: Changing of the time format to 24 hour clock; or date format to one other than standard US calendar (Month/Date/Year) is not supported at this time. Non-Roman Simplified Chinese, & Cyrillic Character Sets: Certain character sets including but not limited to those used in Arabic, Hebrew, and Traditional Chinese are not supported at this time. Right-to-Left/Vertical Reading: The Viewer is only available in one configuration (left-to-right) and does not support right-to-left or vertical text at this time. Multiple Viewer Languages: The Viewer currently only supports one language mode at any time, and there is no support for having hot-swap viewer changes, or using a different language on certain touch screens. All Viewer interfaces will use the same language. Weather Data: Weather data is currently available for the US and provided in English only. TS2 Simplified Chinese Alphabet: The TS2 interface does not support Chinese character sets. Do not attach TS2 s to any system that will be used with Chinese language, as they will not function. Meta-Data and some text from third-party sources: Data read dynamically from other sources for features such as meta-data, weather, internet radio and so forth cannot be translated and will appear in whatever language the third party source presents it in. Dynamic Control of certain Zone Controllers: Certain zone controllers such as Niles, Nuvo, Speakercraft, and Russound are integrated using a dynamic method where information may be read from their network/keypads. Control of these devices and their sources when they are set to or utilizing Non- English characters is not supported. Digital Music/Media Servers/iPod Docks: Unless specifically noted as supported in this Integration Note, digital media sources provided by any zone controller, server or ipod dock etc. containing files with meta-data containing non-english characters are not supported and results may vary. In addition, changing the Server/iPod dock (etc.) into a menu mode using other languages may produce unpredictable results and is not supported. Digital Music in other formats (including itunes): Digital music containing localized meta-data in formats other than MP3 (including itunes and itunes XML) are not supported. Cover Art Lookup for Music using foreign characters: Cover art lookup for digital music using entirely non-english characters is unlikely to find accurate results. Digital music should have JPEG images saved in the folder as described in the HC Internal Player Integration Note for best results. Messaging/TTS Features: The Messaging Text to Speech engine is currently only available in English. On Screen Keyboard in Simplified Chinese: Certain sections in the g! Interface have an on-screen keyboard that may appear for typing (such as for the name of a playlist). This feature is not available in Simplified Chinese Legacy Touchscreens: Elan/HomeLogic touch screens not specifically stated as supported in this document may not be compatible with language features. Any feature not specifically noted as supported is not supported. 2 of 11

3 INSTALLATION OVERVIEW 1. Important Note: Importing a Language XML file should be the first thing done when starting to configure a system, as some items (Lighting Keypads, Media Interfaces, etc.) are translated as they are added to Configurator. Items added prior to importing a Language file may not automatically translate. 2. Open Configurator to the desired system. 3. Verify system meets minimum version requirements as outlined in the header of this document. 4. Import the desired Language XML file as described below in Using the Language Editor (see the Common Resource Library for available translations from Elan). 5. Configure the system as normal, taking note that some items may need to be manually labeled in your chosen language as you add them to the system, such as Security zones/partitions, Media Zones/Sources, and so on. 3 of 11

4 CONFIGURATOR LANGUAGE EDITOR OVERVIEW Navigate to the System tab, and then select Language in the System Tree. Language Feature Quick Reference Code Page Select the correct character font base for the Viewer and touch screens. Typically, this field will automatically select the correct setting following the import of a language file. Verify that the character set matches the language being used. For example, if you translate to Russian, the Code Page should read Cyrillic. Reset (English) button Import button Export button Sort Alphabetically button Sort by Context button Click to reset the translated text to English. Note that any changes to the Configurator that are not exported will be lost. Click to launch the file explorer program to locate a language XML file to import. Any changes to the Configurator that are not exported will be lost. Click to launch the file explorer program to export any changes to the Configurator as an XML file. Export the XML file to save any changes made to the language file. The exported file can be imported into any compatible g! system. Click to sort the columns alphabetically. The column sorts based on the English-language column. Click to sort the columns alphabetically by context. Language Editor Reference English (non-editable field) Context (non-editable field) Translated (editable field) The default English text shown in the Viewer and Configurator. The subsystem or area of the Viewer where the text occurs. The translated text shown in the Viewer and Configurator. The Translated column can be customized. Click the field to select the text and enter any changes. Note that special characters in this column are important and should not be edited. 4 of 11

5 Special Characters in the Language Editor Variable characters Some lines of text include special characters in the g! software. These characters are typically a percent symbol (%) followed by a single letter, and dynamic data such as a temperature reading will be inserted automatically in that location. In all cases, these variable characters and their spacing must be preserved for proper function. Example: %s KYBD Context Some touch screens will display a g! generated On Screen Keyboard when entering text in the viewer, such as for the name of a Radio Preset. The KYBD context specifies the lower case (LC) and upper case (UC) versions of each row that will display. This allows the customization of the keyboard to show characters in the desired language. For example, KYBD R2 LC 13 keys means: Keyboard, Row 2, Lowercase, and there are 13 keys on this line. The default English text is qwertyuiop[]\ Note this does not have any effect on a touch screens built in Windows On Screen Keyboard. New Line Certain text may have a new line shortcut or break inserted to move the text following this character to the next line. \n Remove or insert these characters in the editor as needed. Do not insert a space following the \n for proper function. Example: Actual\nTemp Viewer Display: Actual Temp IMPORTANT: Note that Language Edits or importing a Language file should be done as early as possible in the configuration process. Certain functions like custom tabs or lighting keypads are translated as they are added to Configurator, and will not be automatically translated if added prior to importing a language file. 5 of 11

USING THE LANGUAGE EDITOR To Import A Language File: 1. Click the Import button to open the file browser and locate the folder where Language XML files exist. 2.

6 USING THE LANGUAGE EDITOR To Import A Language File: 1. Click the Import button to open the file browser and locate the folder where Language XML files exist. 2. Select a language from the list of XML files as desired and click Open. 3. The text under the Translated column of the Configurator converts to the imported language after a moment. 4. Click Apply when done to save changes. IMPORTANT: Note that Language Edits or importing a Language file should be done as early as possible in the configuration process. Certain functions like custom tabs or lighting keypads are translated as they are added to Configurator, and will not be automatically translated if added prior to importing a language file. To Export A Language File: 1. Click the Export button to open the file browser and select the desired folder where Language XML files should be saved. 2. Type a name for the Language you are exporting, such as Spanish Customized May 2011.xml and click Save. 3. The XML file is exported, and may be imported later into a compatible g! system. 6 of 11

7 To Edit A Line Of Text: Select the line you want to edit, and revise the text by left-clicking under the Translated column. Note you may need to have enabled the appropriate Keyboards in your Windows installation to enter the correct characters. See Enabling Keyboards below. Note: you must click the APPLY button when done making changes to activate the changes in the Viewer. IMPORTANT: Note that Language Edits or importing a Language file should be done as early as possible in the configuration process. Certain functions like custom tabs or lighting keypads are translated as they are added to Configurator, and will not be automatically translated if added prior to importing a language file. 7 of 11

8 IMPORTING EARLIER VERSIONS Importing XML files from Earlier Core Modules: o There should not be any special steps required when importing XML files from earlier versions. The file importer will automatically import all translated fields present in the older file that match current translation fields. o Note that any new words/phrases added in Core Module 5.3 not present in the XML file will not be translated and will need to be changed in the Language Editor manually. o It is recommended that you export and save any changes you make to the file when finished so you may use the complete file on future jobs. Restoring backup from Earlier Core Modules: o Bear in mind that Configuration Backups are intended to be restored into the version they were created in, and best results will follow if you may restore the backup into a matching core module version and then update to the 5.3 release. o If you must restore a Configuration Backup created in an earlier Core Module there will be some additional steps to restore all fields to the Language Editor: 1. If you have not already, download the 5.3 Core Module Installer from the Elan dealer site: 2. Read in your Configuration Backup as normal. The system will reboot. 3. Wait for the system to restart. 4. Once the system is fully booted, enter Configurator and verify your backup has restored properly and the Configuration you expect is present. You may note that the Language Editor does not show all 5.3 translation fields and contains an earlier set of words and phrases. 5. Run the 5.3 Core Module Installer and re-update the system as normal. The system will reboot. 6. Following reboot, check Configurator all Language Editor fields normally present in 5.3 should be restored. 8 of 11

9 ENABLING ADDITIONAL KEYBOARDS FOR LANGUAGE ENTRY Below are some basic steps that may be needed to set up your computer for the entry of text in languages other than English. Note these steps may not be all inclusive or accurate for your version of Windows, and are provided for reference only. See Microsoft support documents for full details. ENABLING ADDITIONAL INPUT TYPES (NON-CHINESE) Typing Non-English characters into any software program requires special setup on the PC. This includes selecting a desired input method editor (IME). The following steps will prepare a Windows XP or Windows7 PC and are supported. Other methods may also work, but will not be tested or supported by Elan. These steps may include a restart of your computer. Save your work and close all open programs first. Start control panel Start Regional and Languages Click the Languages tab and then click the Details button at the top. This brings up the Text Services and Input Languages dialog: click Add at the right. This brings up the Add Input Language dialog: select the desired language/keyboard in the dropdown. Click OK to close the Add Input Language dialog and then click OK to close the Text Services and Input Languages dialog. On your task bar, you should now see EN (English) at the right. Left click EN, and then select the desired input keyboard. The EN changes to reflect the selected language. When you type, you ll be typing characters for the selected language. To adjust the properties, show the Language bar. You can make changes there and find the arrangement that works best for you You can switch back and forth between English and the selected language with an Alt-Shift on your keyboard. ENABLING ADDITIONAL INPUT TYPES (CHINESE) Chinese setup requires additional step(s) compared to adding support for other languages. See below for details. Typing Chinese characters into any software program requires special setup on the PC. This includes installing Far East language support and enabling the Simplified Chinese characters, and selecting a desired input method editor (IME). The following steps will prepare a Windows XP or Windows7 PC and are supported. Other methods may also work, but will not be tested or supported by Elan. These steps include a restart of your computer. Save your work and close all open programs first. Start control panel Start Regional and Languages Click the Languages tab 9 of 11

Check Install files for East Asian languages: click OK at the warning, then Apply. Wait you ll eventually get a restart dialog: click OK to restart your PC.

This brings up the Text Services and Input Languages dialog: click Add at the right.

10 Check Install files for East Asian languages: click OK at the warning, then Apply. Wait you ll eventually get a restart dialog: click OK to restart your PC. After your PC is up again, go back into the Regional and Languages dialog. Click the Languages tab again, and then click the Details button at the top. This brings up the Text Services and Input Languages dialog: click Add at the right. This brings up the Add Input Language dialog: select Chinese (PRC) in the drop-down. This should set the Keyboard layout / IME drop down to Chinese (Simplified) Microsoft Pinyin IME 3.0. If not, select this in the list. 10 of 11

11 Click OK to close the Add Input Language dialog and then click OK to close the Text Services and Input Languages dialog. On your task bar, you should now see EN (English) at the right. Left click EN, and then select Chinese. The EN now shows CH for Chinese. When you type, you ll be using the Chinese IME (Input Method Editor), and it will try to suggest the proper Chinese character for the letters you are typing. Note the properties include modes for either sentence or word translation types. To adjust the properties, show the Language bar. You can make changes there and find the arrangement that works best for you You can switch back and forth between English and Chinese with an Alt-Shift on your keyboard. 11 of 11

Integration Note. ELAN Home Systems Life Just Got Better. g!mobile ios App Version 5.3 BETA Manufacturer: OVERVIEW

Integration Note. ELAN Home Systems Life Just Got Better. g!mobile ios App Version 5.3 BETA Manufacturer: OVERVIEW ELAN Home Systems Life Just Got Better Integration Note g!mobile ios App Version 5.3 BETA Manufacturer: Apple Model Number(s): iphone, ipod Touch, ipad Comments: g! Core Module Version 5.0 or later Apple