Parallels Welder 2.3 User's Manual
Contents
1. gif images used in online help for illustrating GUI elements dhtml search js java script implementing the mechanism of search through the guide Translational tips For editing the files that build Plesk Expand online help system we recommend using a WYSIWYG HTML editor which supports working with files in UTF 8 Using such editor makes the process of translation more comfortable because it lets you concentrate on modifying the help content without the necessity of separating it from the HTML syntax prevents you from modifying anything besides the help content which guarantees that the files will not be corrupted somehow Important Do not change the files encoding It must be UTF 8 Otherwise the texts you translated may be displayed incorrectly Creating LP 15 Compiling LP After translation is complete you need to compile your source files into LP The compiling is performed with Plesk Expand 1ocale maker utility gt To install locale maker utility 1 Download the locale maker packet expand locale maker 1 0 0 3 1586 rpm from the Parallels Technology Network http swdn swsoft com or take the packet downloaded with this Localization Kit 2 Install locale maker using the following command rpm Uhv expand locale maker 1 0 0 3 i586 rpm Note The locale maker utility requires PHP Xerces C v 2 5 0 6 and later Unzip and rpmbuild utility The locale maker utility is installed to the usr local expan2. Preface In this section About THIS QUIE 4 Who Should Read This Guide r ee a 4 Typographical Conventions x ea a ade yes 5 Feedback nee aka 5 About This Guide This document is a guide to translating Plesk Expand interface and online help to languages other than those released by Parallels Section Localization Overview on page 6 gives an idea of localizing a software product explains such terms used in the document as locale and language pack focuses on the localization capabilities of Plesk Expand and describes Plesk Expand locale components and Plesk Expand language pack structure in detail Section Creating LP on page 9 provides guidelines instructions and recommendations on creating a Plesk Expand language pack Section Installing LP on page 16 describes how to install Plesk Expand language packs The Appendix A on page 17 contains full description of the Locale maker tool that is used for compiling language packs and a list of the tool advanced options The Appindix B on page 18 lists names of the locales supported by Plesk Expand Who Should Read This Guide This guide is intended for those willing to create custom language packs e to translate Plesk Expand interface and online help to languages other than officially supported by Parallels Typographical Conventions Preface The following kinds of formatting in the text identify special information Formatting convention Spec
3. PROD NAME lt phrase gt lt comment gt lt entry gt The corresponding message in Plesk Expand GUI looks as follows Click to register a new Plesk server in Plesk Expand Important While translating the text in the context help keys Ormessages keys sections put these placeholders at any place in the text but do not change anything within the placeholder code neither do edit any text within curly brackets nor delete the curly brackets Variables Variable is a substring like Svariable names that is substituted with its value in GUI Let us assume that the domain name is sample com and locale xml file contains the following entry lt entry gt lt keyword gt plesk error domain unknown lt keyword gt lt phrase gt Domain domain cannot be found lt phrase gt lt comment gt lt entry gt The corresponding message in Plesk Expand GUI looks as follows Domain sample com cannot be found While translating messages that contain variables observe the following rules Puta variable at any place of your translation text Neither do change any text between percent signs nor remove the percent signs Use all the variables of the original message from the default locale provided by Parallels in your translated message Do not skip any message variables in translated messages it will make your text less informative than the original one Do not use any variables for translated message which were not us
4. Parallels Plesk Expand Localization Guide Plesk Expand Language Packs Plesk Expand 2 3 Revision 1 0 Parallels Copyright Notice ISBN N A Parallels 660 SW 39 Street Suite 205 Renton Washington 98057 USA Phone 1 425 282 6400 Fax 1 425 282 6444 Copyright 1999 2008 Parallels Inc All rights reserved Distribution of this work or derivative of this work in any form is prohibited unless prior written permission is obtained from the copyright holder Patented technology protected by U S Patents 7 328 225 7 325 017 7 293 033 7 099 948 7 076 633 Patents pending in the U S Product and service names mentioned herein are the trademarks of their respective owners Contents Preface 4 About This GUI een 4 Who Should Read This Guide ooooncoconicccnncconnccnnncccconccccornnononnnann cnn nc 4 Typographical Conventions ica a ae 5 A A an nee 5 Localization Overview 6 bocals Components Aaa iaa 7 Language Pack Content si crrisciiiihinioniii iihi cnn rca 7 Creating LP 9 Obtaining Detault bP cnica 9 Translating LP Eiles 4 tava beeassicadidandbeeeastiedyvastdatea T edie aoieassdiaed 11 Translating GUI and Contextual Help Messages 00s440snsnsnnnnnnnnnnennnnnnnnnennnn 11 Translating Online Help n nee seen 14 GompilingiEP 2u 2 2 ee reelle 15 Installing LP 16 Appendix A Using locale maker Utility 17 Appendix B Locale Codes 18 4 Preface
5. al Help A set of context dependent tips shown at the bottom of navigation pane Contextual help messages say in brief either what the current Plesk Expand page is designed for or if a mouse pointer is placed over a GUI control button icon list heading etc what the meaning of the control is Online Help A Plesk Expand user s guide which opens upon clicking Help in navigation pane and displays the content relevant to the current Plesk Expand page The locale components are defined by a particular file or set of files within a language pack Language Pack Content All LP source files and folder are specifically structured within a particular directory This directory is used by Plesk Expand locale maker utility for compiling LP LP source files and folder are structured as shown below a lt source files directory gt Directory containing all LP source files B license html File containing the text of Parallels End User License Agreement shown to Plesk Expand Administrator at his first login to the control panel B locale xml File containing entries for Plesk Expand interface messages and contextual help elements Er heie Directory containing help specific files B help zip Archive containing files which compose online help excluding the index php file The files must be in archive root PHP file used to generate online help pages 8 Localization Overview The locale that is shipped by default with Plesk Exp
6. alician Georgian Georgian Georgia German Austria en ioe CS ence sm E n spanien Pueno ico won m CINC e re CN e ego Language Country Region German Germany German Liechtenstein German Luxembourg German Switzerland Greek Greece Gujarati India Hebrew Israel Hindi India Hungarian Hungary Appendix B Locale Codes 21 Code Language Country Region code CS o E CA Tin CC CH rr CO
7. and is named default locale You can use default locale for creating your LP Source files of the default locale have the following locations on the server where Plesk Expand is installed license html location usr local expand frontend htdocs locale lt xx XX gt license html n ocale xml location usr local expand share locale lt xx XX gt locale xml help folder location usr local expand frontend htdocs help where lt xx XX gt substitutes the locale code of the default locale usually en US Creating LP 9 Creating LP Creating a language pack involves the following steps 1 Obtaining the default en US language pack sources 2 Translating the source files content to a required language 3 Compiling your resulting files to a new language pack The next sections explain how to perform each step In this section Obiaining Default Pesos 9 Translating ER RES seca oa lc 10 Compiling Boton iio ocio 15 Obtaining Default LP There are two ways to obtain default Plesk Expand LP source files Taking the files downloaded with this Localization Kit current version of Plesk Expand The files are available at the src directory of the unpacked Localization Kit Taking LP source files from a particular Plesk Expand instance for which you want to create an LP Generally speaking you have two options when creating your language pack Creating a partial LP that localizes only the GUI part of the Plesk Expand u
8. d locale maker directory Before compiling an LP make sure that your directory with sources contains all necessary elements For complete LP Jicense html locale xml help help zip help index php For partial LP license html locale xml 16 Installing LP gt To build an LP Run locale maker with the following options usr local expand locale maker sbin locale maker locale path lt source files directory gt locale id lt xx XX gt title lt locale name gt expand version lt expand version gt Where lt source files directory gt is your directory with source files lt xx XX gt is a locale code in the RFC 1766 standard lt title gt is a title of a locale that will be shown to Plesk Expand users after installing the locale to Plesk Expand lt expand version gt is a Plesk Expand version for which a locale is created By default the created LP expand 1ocale lt xx XX gt lt expand version gt lt YYMMDD gt noarch rpm is located in the current directory You can specify the directory for created LP locale release version architecture of Plesk Expand instance for which a locale is built using additional 1locale maker utility options For details on these options refer to the Appendix A Using locale maker Utility on page 17 Installing LP To install the locale to the system execute the following command rpm Uhv lt lp name gt rpm whe
9. e to your locale source files directory lt path to my locale gt lt xx XX gt where lt xx XX gt is the code of the locale for which you create an LP cp share locale en US locale xml lt path to my locale gt lt xx XX gt locale xml 3 Copy frontend htdocs locale en US license html file to your locale source files directory lt path to my locale gt lt xx XX gt cp frontend htdocs locale en US license html lt path to my locale gt lt xx XX gt license html gt To obtain source files from a Plesk Expand instance for a complete LP mb Repeat steps 1 3 of the previous instruction 2 Copy the frontend htdocs help en US directory to your locale source files directory lt path to my locale gt lt xx XX gt cp r frontend htdocs help en US lt path to my locale gt lt xx XX gt help Creating LP 11 Translating LP Files Once you obtained LP sources the next step is to actually modify interface and contextual help messages and online help texts For editing LP files use text editor that supports editing text in UTF 8 and edit all the files in this encoding Otherwise the messages you translated may be displayed incorrectly We recommend using text editor which also supports highlighting syntax Using such editors makes the document structure easy to see and helps you avoid common mistakes The following sub sections explain how the LP source files are organized and provide recommenda
10. ed in the original message from the default locale provided by Parallels Countries Names While editing the Locale xm1 file you might see entries like lt entry gt lt keyword gt plesk client state filled error lt keyword gt lt phrase gt Please specify a state for the USA selected lt phrase gt lt comment gt lt entry gt 14 Creating LP Do not replace USA with your country name For example if you translate into Portuguese replacing USA with Portugal will be wrong You should use the word abbreviation meaning USA in your language Date and Time Presentation Format For setting up date and time presentation used in your country 1 Find the entries responsible for country specific date and time presentation in the messages variables section 2 Modify these entries in accordance with the format described at http www php net manual en function date php http www php net manual en function date php Translating Online Help To translate an online help system you should modify the following files numerous htn files lt nn nn nn gt htm e g 01 01 03 htm and lt number gt htm e g 2563 htm pages containing the online help contents displayed in the main content frame of the online help window toc htm toc lt number gt htm e g toc246135 htm pages containing different states of the Contents tree displayed in the left frame of the online help window x gif files
11. ial Bold Italics Monospace Preformatted Preformatted Bold CAPITALS KEY KEY Feedback Type of Information Items you must select such as menu options command buttons or items in a list Titles of chapters sections and subsections Used to emphasize the importance of a point to introduce a term or to designate a command line placeholder which is to be replaced with a real name or value The names of commands files and directories On screen computer output in your command line sessions source code in XML C or other programming languages What you type contrasted with on screen computer output Names of keys on the keyboard Key combinations for which the user must press and hold down one key and then press another Example Go to the QoS tab Read the Basic Administration chapter The system supports the so called wildcard character search The license file is located in the httpdocs common licenses directory ls al files total 14470 cd root rpms php SHIFT CTRL ALT CTRL P ALT F4 If you have found a mistake in this guide or if you have suggestions or ideas on how to improve this guide please send your feedback using the online form at http www parallels com en support usersdoc Please include in your report the guide s title chapter and section titles and the fragment of text in which you have found an error 5 6 Localization Overvie
12. ic Kuwait Kannada India Language Country Region Arabic Morocco Arabic Oman Arabic Qatar Arabic Saudi Arabia Arabic Syria Arabic Tunisia Arabic United Arab Emirates Arabic Yemen Armenian Armenia Azeri Azeri Azerbaijan Basque Basque Basque Belarusian Belarusian Belarus Bulgarian Bulgarian Bulgaria Catalan Catalan Spain Chinese Chinese Hong Kong SAR Chinese Macao SAR Chinese China Simplified Chinese Chinese Taiwan Traditional Chinese Croatian Croatian Croatia Czech Czech Czech Republic Danish Denmark Dutch Dutch Belgium Appendix B Locale Codes 19 ama Kom w i Republic of Macedonia a may CEN CI ja Norwegian Bokmal Norway Norwegian Nynorsk Norway Polish Poland pl PL p nb NO nn NO cc a sez run Gr Jans nee oem 20 Appendix B Locale Codes Language Country Region Dutch The Netherlands English Australia English Belize English Canada English Caribbean English Ireland English Jamaica English New Zealand English Philippines English South Africa English Trinidad and Tobago English United Kingdom English United States English Zimbabwe Estonian Estonian Estonia Faroese Faroese Faroe Islands Farsi Iran Finnish Finland French Belgium French Canada French France French Luxembourg French Monaco French Switzerland Galician G
13. lders for messages of the context help keys section messages keys section contains localization for interface messages messages variables section defines message variables and placeholders for messages of the messages keys section To translate a locale entry substitute the original phrase with a corresponding phrase in your language The keyword and the comment may help you understand where this entry is used in the GUI Important Do not translate any of the keywords Plesk Expand uses keywords to link a particular GUI item with the corresponding phrase so if you change a keyword in the locale xml file the original phrase will be displayed in Plesk Expand instead of the translated phrase Translation Tips There is a number of recommendations that might be useful when translating 1ocale xm1 file particularly for localizing placeholders variables countries names date and time format Placeholders Placeholder is a constant substring like SEXP_ PROD NAME or PROD_NAME thatis substituted with its value in GUI The table below represents placeholders and corresponding values Placeholder Default value EXP_PROD_NAME Plesk Expand product name Plesk Expand PROD_ NAME Plesk product name Creating LP 13 Let us assume that the locale xm1 contains the following entry lt entry gt lt keyword gt plesk register server lt keyword gt lt phrase gt Click to register a new Plesk server in SEXP
14. ocale names supported by Plesk Expand refer to the Appendix B Locale Codes on page 18 By default Plesk Expand is shipped with only U S English language pack Parallels also releases LPs for 7additional languages which are German de DE French fr FR Spanish es ES Russian ru RU Japanese ja JP Simplified Chinese zh CN Traditional Chinese zh TW These additional language packs are available at the Language Support http www parallels com en products plesk expand lp page of the Parallels official web site This Plesk Expand Localization Kit is designed to allow third party developers to create their own localizations for Plesk Expand The developers are free to share their translation with other Plesk Expand users Also they can contribute the translation to Parallels where it will be repacked to the standard Plesk Expand language pack form and then published on the Parallels official web site Localization Overview 7 In this section Locale Components dia 7 Language Pack CONE catalina did 7 Locale Components We distinguish the following three components in Plesk Expand locale Interface Messages Include the following All textual elements of graphical user interface except for the contextual help tips namely names of the buttons icons links checkboxes lists options list items and so on All alert warning error progress and operation result messages Contextu
15. pecifies the directory where LP will be created The current directory is used by default Optional native title The locale native title If the native title is set it will replace the locale title Optional The following options are used in Plesk Expand LP build process and they are set automatically All of them are optional locale release Specifies the locale release version The YYMMDD format where YY current year MM month DD day of month is used by default 18 Appendix B Locale Codes xmlchecker path Specifies the path to xmlchecker which validate locale xml file The usr local expand locale maker path is used by default Specifies the path to locale engine The usr local expand locale maker locale engine path is used by default spec file Specifies the location of the locale spec file which contains LP description The usr local expand locale maker share spec locale spec location is used by default make file Specifies the location of the locale Makefile file The usr local expand locale maker share Makefile location is used by default locale arch Specifies the architecture for which the locale is built Br problem report Specifies the error log file ET rr PPP Displays help on the use of the locale maker utility Appendix B Locale Codes Language Country Region Code Language Country Region Code CO A o Irina fega ones ones eo CI CA EEE Arab
16. re lt p name gt rpm is the Language Pack name After you receive from the system the message about the LP successful installation the LP can be used in Plesk Expand it appears automatically in the list of installed language packs Server gt Preferences gt Default Locale and becomes available for choosing in Plesk Expand administrator and resellers Interface Settings forms and on the Plesk Expand login screen Appendix A Using locale maker Utility 17 Appendix A Using locale maker Utility The locale maker utility is used to build Plesk Expand Language Packs For instructions on how it can be installed refer to the Compiling LP on page 15 section Usage usr local expand locale maker sbin locale maker locale path lt source files directory gt locale id lt xx XX gt title lt locale title gt expand version lt expand version gt options Example The following command builds the French LP usr local expand locale maker sbin locale maker locale path fr FR locale id fr FR title French expand version 2 2 0 Options locale path Specifies the directory where the LP source files are located en ee locale id Specifies the locale code in the RFC 1766 standard a title Specifies the locale title that will be shown to Plesk Expand users after installing the locale to the Plesk Expand expand version Specifies the Plesk Expand version for which the locale is build AA output path S
17. ser s environment which excludes online help system The partial LP includes locale xml and license htnl files Creating a complete LP that localizes the whole Plesk Expand user s environment which includes online help system The complete LP includes locale xml and license htm1 files and help folder 10 Creating LP gt To obtain source files from the Localization Kit for a partial LP 1 Copy src en Us folder downloaded with this Localization Kit to your locale source files directory lt path to my locale gt lt xx XX gt where lt xx XX gt is the code of the locale for which you create an LP cp r lt path to unpacked localization kit gt src en US lt path to my locale gt lt xx XX gt 2 Remove help directory from your locale source files directory rm r lt path to my locale gt lt xx XX gt lt help gt gt To obtain source files from the Localization Kit for a complete LP Copy src en US folder downloaded with this Localization Kit to your locale source files directory lt path to my locale gt lt xx XX gt where lt xx XX gt is the code of the locale for which you create an LP cp r lt path to unpacked localization kit gt src en US lt path to my locale gt lt xx XX gt gt To obtain source files from a Plesk Expand instance for a partial LP 1 Make the usr local expand your working directory cd usr local expand 2 Copy share locale en US locale xml fil
18. tions that can be useful when translating the files In this section Translating GUI and Contextual Help Messages oooocccccccccccnccaoccccccnnccnananann nono 11 Transiating OnlINS el ee 14 Translating GUI and Contextual Help Messages File Structure All interface and contextual help messages for the Plesk Expand GUI are located in the locale xml1 file In this file for a single GUI item exists a single entry keyword phrase comment triplet which specifies the GUI item localization Keyword contains unique identifier of a Plesk Expand GUI item Phrase contains a text on a human language which describes a particular Plesk Expand GUI item appearing as either an interface message or a contextual help text A phrase may contain placeholders or message variables For information on translating messages which contain placeholders or variables refer to the Translation Tips on page 12 section Comment contains translational notes concerning the entry and does not affect the Plesk Expand GUI A typical entry looks as follows lt entry gt lt keyword gt exp login exists lt keyword gt lt phrase gt A reseller with such login already exists in Plesk Expand lt phrase gt lt comment gt lt entry gt 12 Creating LP The entries are grouped into four sections context help keys section contains localization for contextual help context help variables section defines message variables and placeho
19. w Localization Overview Since Plesk Expand is a web application a single instance may simultaneously target an international multi language audience owing to the possibility of localization Localization means a process of adapting software for a particular country or region which is generally speaking translating Plesk Expand user s environment to a language spoken in the country or region A subset of Plesk Expand user s environment adjusted to a particular language and culture is called locale On the implementation level a particular locale is represented by the corresponding language pack LP Language pack is an installable file containing all the resource files and processing instructions necessary for installing a particular locale to an existing Plesk Expand instance In other words LP is a packed set of files containing all the language related data that define the appearance of a particular user environment component For details on creating and installing language packs refer to the Creating LP on page 9 and Installing LP on page 16 sections Plesk Expand locale and language pack names follow the RFC 1766 standard in the format lt languagecode2 gt lt country regioncode2 gt where lt languagecode2 gt is a lower case two letter code derived from ISO 639 1 and lt country regioncode2 gt is an upper case two letter code derived from ISO 3166 For example U S English locale is named en US To see a list of l
Download Pdf Manuals
Related Search