MM8000 MP4.
Data and design subject to change without notice. / Supply subject to availability. © 2008 Copyright by Siemens Switzerland Ltd We reserve all rights in this document and in the subject thereof.
1 Introduction .............................................................................................6 1.1 1.2 What is new in MP4.15 .............................................................................6 Documentation corrections in this edition .................................................6 2 2.1 2.2 2.3 2.4 MM8000 localisation overview...............................................................7 Localisation activity ..............................................................
Introduction About This Document Purpose of this Document This guide provides a technical guide for localising the MM8000 software application. Individuals performing these operations are expected to have prior expertise in the field of security, at least a moderate level of familiarity with the Siemens Building Technologies product line, and experience with the installation and configuration of security management systems. Scope This document applies to the MM8000 Management Station, version 3.20.
Introduction Modification index Versions Date Notes MP4.15 06.2008 Corresponds to version 4.15 of MM8000 Management Station Software MP4.10 06.2007 Corresponds to version 4.10 of MM8000 Management Station Software MP3.20 06.2006 Corresponds to version 3.20 of MM8000 Management Station Software MP3.15 09.2005 Corresponds to version 3.15 of MM8000 Management Station Software MP3.12 06.2005 Corresponds to version 3.12 of MM8000 Management Station Software MP3.10-01 03.
Introduction 1 Introduction This is a guide to the localisation procedures for the MM8000 Management Station. It provides the following information: • General overview of the MM8000 localisation process (Section 2 at p. 7). • Guide for the localisation activities using Alchemy Catalyst (Section 3 at p. 12). • Details on localising XML-DB texts using XML editor (Section 4 at p.18). • Guide for localising and customising the MM8000 default project (Section 5 at p.28).
MM8000 localisation overview 2 MM8000 localisation overview The following is a general overview of the MM8000 localisation process. 2.1 Localisation activity What is localisation? MM8000 is distributed by SBT FS DMS with English texts. The activity required to translate the English texts and to customise the default settings is called localisation. The MM8000 localisation process includes: • Translation of MM8000 system texts used by the MM8000 user interface.
MM8000 localisation overview 2.2 File formats MM8000 software environment contains localised texts in various types of files. These include: • DLL files, which are extensions of the program files (.EXE). The MM8000 text DLLs have been merged into two database files that can be handled by the Alchemy Catalyst application (see below). − MM8000 MP 4.15 ENG.ttk (system texts); − MM8000 MP 4.15 - Subsystem Tools ENG.ttk (configuration tool models).
MM8000 localisation overview 2.3 Localisation toolkit The MM8000 localisation is supported by a toolkit that is provided upon request. The toolkit is distributed in the MM8000 CD and includes the files illustrated below: Fig. 2 Toolkit files MM8000 Localisation toolkit files Contents A
Default Project Subfolder containing the MM8000 Composer project used to start a new configuration. B MM8000 Subfolder containing the SMS and Pager character set files. Namely: ‘\Server\mappingUcs2Gsm.MM8000 localisation overview tem Tools ENG.ttk J MM8000 MP 4.15 ENG.ttk Catalyst data files for MM8000 system texts. K MM8000 - XML Editor.exe XML editor application. It is used to localise the XML-DB. Tab.1. 2.4 Localisation Toolkit files Localisation process checklist Items needed − A PC running Windows 2000 or XP and supporting the language you want to translate to. On the PC, check the locale setting in: ’Start Æ Control Panel Æ Regional options Æ General tab/Windows locale’.
MM8000 localisation overview 20.Download the project. 21.Run the localised MM8000. 22.Test the localised software and possibly repeat the steps 6 to 21 above for refining the localisation. 23.Send to FS DMS support the final localised toolkit. 24.The LANG-xxx.ZIP file can be added to the MM8000 setup CD for installing the localised texts along with software in the program installation. 11 Building Technologies Fire Safety & Security Products 019_DMS_MM8000_Localisation_ Eng_Guide_ MP4.15_A6V10062459_a_en.
Localising texts using Catalyst 3 Localising texts using Catalyst This section is a guide for the localisation activities using Alchemy Catalyst. 3.1 Catalyst overview Alchemy Catalyst Catalyst is an integrated translation environment by Alchemy Software (http://www.alchemysoftware.ie/). This application can extract (import) the texts from EXE and DLL files, and create a database file (TTK) that can be used for a comfortable translation, assisted by a guided interface and management tools.
Localising texts using Catalyst Training on Catalyst Using Catalyst software is quite simple. Before using it extensively however, we recommend that you run some training sessions (Web-based lessons). These are available on the Internet at: http://www.alchemysoftware.ie/tutorials/index.html. 3.2 Localising MM8000 texts with Catalyst Catalyst Text Translation Kits (TTK) The MM8000 localisation items (texts, graphic symbols, and so on) are organised in the following TTK files: − MM8000 MP 4.15 xxx.
Localising texts using Catalyst Set target language If you are running the Licensed Catalyst edition, then select your target language: (see Fig. 4). This is not required in the Quickship edition. Fig. 4 Target language setting Navigation tree Open the navigation tree as indicated in Fig. 5. Editing field Fig. 5 Open the navigation tree This results in a tree view being displayed on the left hand side (see Fig. 6), showing a number of resource groups.
Localising texts using Catalyst Fig. 6 Tree view in Catalyst Translating text strings Select the group in the tree, and translate the individual text strings that display on the right hand side of the screen (see Fig. 7 below). Fig. 7 Translating text strings How to use the spelling checker 1. Choose Tools → Options → the General tab from the Catalyst menu. 2. Select your language under the Dictionary dropdown.
Localising texts using Catalyst Note: You should also select ‘Perform auto checking’ and ‘Hotkey aware’, as these options will notify you if you misspell a word while you are working, and will ignore ampersands (&) when spellchecking. 3. Select ‘OK’. → To quickly correct any misspellings while translating, click Edit → QuickSpell, or press F3 to display a list of suggested corrections. Doubleclick a correction to replace the misspelling with the selected correction.
Localising texts using Catalyst 3.2.2 Updating texts from previous MM8000 release Use the Leverage Expert to update the texts. Note that you will need the licensed edition of Catalyst. Proceed as follows: 1. Start Catalyst. 2. Open the new 4.15 TTK in English. 3. Start the Leverage Expert command. 4. Select the previous TTK database in your own language. 5. Catalyst imports the older texts, leaving the new ones in English. 3.2.
Localising point properties using XML Editor 4 Localising point properties using XML Editor This section deals with the localisation of the MM8000 point properties, contained in the XML database (XML-DB). 4.1 XML-DB The XML-DB database is made up of several files that contain the models of the point representation of each control unit. 4.2 XML Editor With the XML Editor, you can open the entire set of files and modify the text and icon information. 4.2.
Localising point properties using XML Editor The command list in the XML Editor menu includes: Selection … File Æ Toolbar Open Open XML-DB Save Save information into XML-DB Import old XML - New localised language Edit Æ Command Import the localised XML-DB from a previous MM8000 release. That will be automatically updated to latest release. Copy the original XML-DB into a new database, thus creating a new language.
Localising point properties using XML Editor Fig. 10 XML Editor: MM8000 project tab and project tree Information on the screen is split up in four active columns, shown in white background, which contains the following: Title Contents Name For both Virtual and Physical Properties, this column lists the properties and, for each of them, its conditions and commands. Instead, in the Data Points tab, the subsystem list is given. Each subsystem includes the affiliated data points.
Localising point properties using XML Editor confirm (see Fig. 11). 2) Sequentially: select the line (first mouse click) and then click on the editing field just below the menu and the toolbar (see Fig. 12). At that point, you can replace or modify the field and then press Enter to confirm. The program automatically moves to the next line and select the text field for editing. Localised value is shown in green colour instead of black.
Localising point properties using XML Editor 4.2.3 Creating a new language When starting a new localisation, you first have to copy the original XML-DB into a new database. Use the ‘New localised language’ command and, when prompted, confirm it. This command results in the ‘Localised (current version)’ column being populated by texts, which are initially the same as the original English. Also, all items are marked with the ‘not-translated-yet’ sign ( ). See Fig. 13. Fig. 13 4.2.
Localising point properties using XML Editor 2. Expand the sub-tree to show condition texts. 3. Select the first condition clicking on the line. 4. Press F2 or click the text in the ‘Localised (current version)’ column (individual editing, Fig. 11) -- or -click the editing field (sequential editing, Fig. 12). 5. Translate the text and confirm with Enter (Fig. 14). 6. Translate all conditions, repeating steps 3 to 5 for the other conditions. 7.
Localising point properties using XML Editor The Extended Replace command This command allows for selected replacing based on various criteria: • Object type: Text or SymbollD (the latter only for icons) • Find What/Replace With: searching and replace texts or values • Scope includes various options: − Subsystem and Data Point: these fields allow you to limit the replacement action to a Subsystem type or to a Data Point type of a subsystem − Virtual / Physical / Transaction Properties: these fields allow y
Localising point properties using XML Editor 4.2.5 Localising Data Point Icons The Symbol ID items do not contain any text to translate and might even be ignored during the first steps of localisation. However, later on, it may turn out to be useful for modifying the icon associated to the data point. Although the icons may be customised for each project in Composer, the possibility to change some of them here allows defining general icons that will then apply to all the subsequent projects.
Localising point properties using XML Editor 4.2.6 Importing XML-DB from previous MM8000 release XML files from previous versions can be restored into latest XML editor and then integrated with the translation of new texts. Use the editor command File Æ Import old XML-DB, then browse in the file system and select the folder containing the previous XML-DB (the folder must include the 3.x files CPS.xml, LPS.xml, NodeTypes.xml, and TPS.xml). See Fig. 18 and Fig. 19. Fig. 18 Starting import procedure Fig.
Localising point properties using XML Editor also copied in the ‘Localised (current version)’ as much as possible. New texts that are missing in the previous release are taken from the original database in English. 4.2.7 Save localised XML-DB and leave editor You can close the XML editor by selecting File Æ Exit. There is no risk you can lose the data you just entered: upon terminating the program, a window displays like the one shown in Fig. 20.
Default project 5 Default project This section tells you how to localise your default project, which is used as starting point for any new MM8000 project. 5.1 Localisation of MM8000 default project Default project file The file Default.bak contains the project structure that is presented whenever a new project is created (see Fig. 1, at p. 8). In order to simplify the creation of a new MM8000 system, the default project already includes a number of standard objects.
Default project domain (as MM8000 security domain) and user name (as MM8000 administrator) when it will be opened. 6. Translate texts of the MM8000 objects. Note: Under the Security – Users - Domain node, the default User Groups should not be removed. 7. Customise the project adding folders, standard maps, users and so on. 8. Backup the project and close Composer. 9. Copy the project backup (the BAK file you just saved) in the ‘Default Project’ folder of the localisation took kit.
Further customisation activities 6 Further customisation activities 6.1 GSM and Pager character set GSM and Pager devices usually handle an 8-bit character set that can create difficulties in relation with some national characters. In order to address this problem, the MM8000 localisation kit includes two simple MS-Access files: Ucs2Gsm.mdb and Ucs2Pager.
On-line help files 7 On-line help files This section tells you how to localise the on-line help files, a set of compiled HTML files (CHM) that contain the texts provided to the MM8000 operators when they ask for help in the main menu or by pressing F1. Note that no integrated tool is provided for the localisation of help texts and the procedure requires technical skills adequate to handle HTML file editing and conversion, as illustrated here below. 7.
On-line help files Decompiling CHM files You can use the free utility ‘KeyTools’, which can be downloaded at: http://www.keyworks.net/keytools.htm. Start the program and follow the guided menu selecting the Decompile option. Editing HTML HTML files can be modified using an editor that can modify texts without affecting the tag structures. We recommend the use of RoboHelp HTML (Office edition, charged), see: http://www.macromedia.com/software/robohelp/.
Siemens Switzerland Ltd Building Technologies Group International Headquarters Fire Safety & Security Products Gubelstrasse 22 CH-6301 Zug Tel +41 41 724 24 24 Fax +41 41 724 35 22 www.sbt.siemens.com Document no. A6V10062459_a_en Edition 06.