UI Customization and Translation
Total Page:16
File Type:pdf, Size:1020Kb
LISTSERV Maestro Admin Tech Doc 17 UI Customization and Translation January 24, 2020 | © L-Soft Sweden AB lsoft.com This document is a LISTSERV Maestro Admin Tech Doc. Each admin tech doc documents a certain facet of the LISTERV Maestro administration on a technical level. This document is number 17 of the collection of admin tech docs and explains the topic “UI Customization and Translation”. Last updated for LISTSERV Maestro 9.0-1 on January 24, 2020. The information in this document also applies to later LISTSERV Maestro versions, unless a newer version of the document supersedes it. Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. L-Soft Sweden AB does not endorse or approve the use of any of the product names or trademarks appearing in this document. Permission is granted to copy this document, at no charge and in its entirety, provided that the copies are not used for commercial advantage, that the source is cited, and that the present copyright notice is included in all copies so that the recipients of such copies are equally bound to abide by the present conditions. Prior written permission is required for any commercial use of this document, in whole or in part, and for any partial reproduction of the contents of this document exceeding 50 lines of up to 80 characters, or equivalent. The title page, table of contents and index, if any, are not considered part of the document for the purposes of this copyright notice, and can be freely removed if present. Copyright 2003-2014, L-Soft Sweden AB All Rights Reserved Worldwide. LISTSERV is a registered trademark licensed to L-Soft international, Inc. L-SOFT and LMail are trademarks of L-Soft international, Inc. CataList and EASE are service marks of L-Soft international, Inc. All other trademarks, both marked and not marked, are the property of their respective owners. Some portions licensed from IBM are available at http://oss.software.ibm.com/icu4j/ This product includes code licensed from RSA Security, Inc. This product includes software developed by the Apache Software Foundation (http://www.apache.org/). All of L-Soft's manuals for LISTSERV are available in ASCII-text format via LISTSERV and in popular word-processing formats via ftp.lsoft.com. They are also available on the World Wide Web at the following URL: URL: http://www.lsoft.com/manuals.html L-Soft invites comment on its manuals. Please feel free to send your comments by e-mail to: [email protected] Table of Contents 1 Requirements for a Translation ................................................................... 1 2 Installing the Resource Translation Tool ...................................................... 1 2.1 Starting the Resource Translation Tool on Windows ....................................................... 2 2.2 Starting the Resource Translation Tool on Linux or Solaris .............................................. 2 3 Translation Kits ........................................................................................... 2 4 Translating .................................................................................................. 2 4.1 Importing Translations from Previous Versions of LISTERV Maestro ............................... 3 4.2 Navigating in the Resources Tree ..................................................................................... 3 4.2.1 Quick Navigation With Keyboard Shortcuts ............................................................................ 3 4.2.2 Finding a Node in The Resources Tree .................................................................................... 4 4.2.3 Keyboard Shortcut Summary .................................................................................................. 4 5 Installing a Translated Language .................................................................. 4 5.1 Installing a Translation for the Administration Hub or the LUI Main Application ............ 4 5.2 Installing a Translation for the Maestro User Interface Subscriber Pages ....................... 5 6 Using a Translated Language ....................................................................... 5 6.1 Languages for the Administration Hub and the Maestro User Interface Main Application .............................................................................................................................. 5 6.2 Languages for the Maestro User Interface Subscriber Pages ........................................... 6 7 General Concepts ........................................................................................ 6 7.1 Key/Value Entries .............................................................................................................. 6 7.2 HTML Code ........................................................................................................................ 7 7.2.1 HTML Escape Sequences ......................................................................................................... 7 7.2.2 HTML Whitespace and Linebreaks .......................................................................................... 8 7.2.3 HTML Formatting in Text Resources ....................................................................................... 8 7.2.4 Non-HTML Exceptions ............................................................................................................. 9 7.3 Word Replacement ......................................................................................................... 10 7.3.1 Standard Numbered Placeholders ........................................................................................ 10 7.3.2 Named Placeholders on the LISTSERV Maestro User Interface Subscriber Pages................ 11 7.3.3 Placeholder Validation .......................................................................................................... 12 7.4 Miscellaneous ................................................................................................................. 12 7.4.1 Date and Time Formats ......................................................................................................... 12 iii This document gives an overview of how to translate the texts of the LISTSERV Maestro user interface to another language (or how to customize the English language texts), using the L-Soft Resource Translation Tool. It assumes a good acquaintance with computers in general and how to work with files in the file system. The description in this section was last updated for version 1.0-4 of the Resource Translation Tool. 1 Requirements for a Translation To be able to translate the LISTSERV Maestro user interface, the following basic requirements must be met: You need to have access to a server with an installation of LISTSERV Maestro. You need to have an installation of the L-Soft Resource Translation Tool. You need to have a translation kit that matches the LISTSERV Maestro version that you have installed. You need a good understanding of editing HTML code (and the meaning of the various HTML tags and how to escape reserved HTML characters). 2 Installing the Resource Translation Tool The Resource Translation Tool is available for download in the form of a ZIP file. Unpack the file to a suitable location on your disk. In the following, this target folder is called “installation folder”. When unpacking, make sure to preserve the folder names that are used in the ZIP file. Note for Linux and Unix users: Also preserve file permissions when unpacking the downloaded file to make sure that the shell script mentioned below is executable. Otherwise, use chmod to modify the shell script file attributes manually to make it executable. Unpacking the tool ZIP file creates several subfolders in the installation folder: lib: Contains the actual JAR file with the Java classes of the tool and additional JAR files from L-Soft and other sources. Unix / Windows: These subfolders contain additional files that are needed to start the translation tool on the supported operating systems. work: The translation kit(s) and translated JAR files will be placed here. Note: To upgrade an existing an installation of a previous version of the Resource Translation Tool, unpack the downloaded file to the installation folder of the previous version, overwriting existing files. This way, previous translations that were created with the previous version are automatically available as import source when working on a new translation. The resource translation tool is a graphical Java application and is deployed without an embedded Java Runtime Environment (JRE), to save download bandwidth. The tool was developed for Java 7 and checks upon startup if a compatible JRE is available on your computer. A compatible JRE can be downloaded from http://www.oracle.com. Alternatively, if you are starting the tool on a computer that has an existing installation of LISTSERV Maestro 5.0 or later, you can safely use the Java installation that comes with this version of LISTSERV Maestro. Do so by adjusting the startup command file to use the full path to the “java” subfolder of the installation folder as location for Java (see the comments in the command file for details). LISTSERV Maestro Admin Tech Doc 17 1 UI Customization and Translation 2.1 Starting the Resource Translation Tool on Windows Navigate to the “Windows” subfolder of the installation folder and double-click the command file “TranslationTool.cmd”.