OTRS How To Series. Localization of OTRS Language Files. OTRS Help Desk, OTRS ITSM and Extensions

Transcription

1 OTRS How To Series Localization of OTRS Language Files OTRS Help Desk, OTRS ITSM and Extensions Version 1.3 June, 2011

2 Content 1 ABOUT THIS GUIDE WHAT KIND OF TRANSLATION FILES EXIST STEP 1: DOWNLOAD THE TRANSLATION FILE OF YOUR CHOICE STEP 2: HOW TO COMPLETE OR CREATE A TRANSLATION FILE STEP 3: WHERE TO SEND TRANSLATED FILES

3 1 About This Guide The availability of OTRS Help Desk, ITIL V3 compatible OTRS ITSM and all the additional extensions in your local language will boost the opportunities to increase your customers user acceptance and therefore will help to make the solutions the tools of their choice. To assist you in completing an existing language file or add a new one please follow the instructions of this short guideline. 2 What Kind of Translation Files Exist There are three different translation file types that are used in the below mentioned order. Once a term is redefined within these files, the latest translation will be used. All types of language files can be found in your local OTRS' installation path or in the link repository: When providing a translation please make sure to select the option "HEAD" from the 'Sticky Tag' select box. That will guarantee that you translate the latest version of each language file that is currently available. 1. OTRS Framework Translation File: The OTRS Framework Translation File includes the basic translation for the OTRS Help Desk Core that is the most important in the context of this guide. To browse through the existing language files follow this link: 2. Extension Translation File: The Extension Translation File is assigned to a specific OTRS extension, e.g. the knowledge base (FAQ) or the OTRS ITSM extensions. If you plan to add or update a specific translation for any extension you would use this kind of translation file type. In order to find the existing translation files of an extension please make sure to always follow the extensions name and then drill down to /Kernel/Language. To browse through the existing language files follow these links: OTRS ITSM - ITIL V3 compatible IT Service Management FAQ - Knowledge Base Survey Time Accounting 3. Custom Translation File: The Custom Translation File is dominating all other translations, i.e. once there is a translation of a term defined in the $Language_Custom.pm file all other translations of that term will be ignored. You'd choose to use this translation file in all cases that require a customized terminology. 3

4 3 Step 1: Download the Translation File of Your Choice The following description is based on the example of translating or creating an OTRS Framework Translation File, but it also applies the same way to the translation or creation of all other extensions named in paragraph Download an Existing Translation File Once you have decided to translate and complete a yet incomplete language file, browse to the appropriate directory folder shown under paragraph 2.1 if it is a framework file that you want to translate or paragraph 2.2 if it is an extension. Make sure that the option "HEAD" from the 'Sticky Tag' select box is set and then please click on the language file of your choice. Example: downloading the Russian framework file. When clicking on the Russian translation file you will be routed to the change log of that language version. Keep in mind, "HEAD" is the option you should use whenever you translate a file. The option will be part of the URL which will allow you to double check if you selected that option: To Download the file to your hard disk click on 'download' (marked red) and then save the file by choosing the "Save as" link in your browsers menu. The file will be saved as (example) "ru.pm.txt". Then proceed with paragraph Create a New Translation File If there is no translation yet for a language you are looking for follow the steps described below. The original language is English. When creating a new translation file we recommend to use the German translation file (i.e. de.pm) as source which will provide the current German translation of the original English language file. It's not about challenging your German language skills - you will overwrite the translation anyway - but to guarantee that the latest English version has been used. Example: using the German translation to create a new Zulu (zul) language file (language spoken by approximately 11 Mio. people that to 95% live in South Africa). When clicking on the German translation file you will be routed to the change log of that language version. Keep in mind, "HEAD" is the option you should use whenever you translate a file. The option will be part of the URL which will allow you to double check if you selected that option: 4

5 Before downloading, rename the file using the ISO standard for language classification. Browsing for Zulu - our example language here in this guide - should result in the abbreviation ' zul '. ISO standard for language classification To Download the file to your hard disk click on 'download' (marked red) and then save the file by choosing the appropriate "Save as" link in your browsers menu. In our example the file should be saved as "zul.pm.txt". Then proceed with paragraph 4. 4 Step 2: How to Complete or Create a Translation File The following example is tied to the case of creating a new translation file from the German translation file (de.pm) that you have renamed according to the steps in paragraph 3.2. But the same rules apply to the completion of an existing translation file. And for sure the rules also apply to the completion or creation of an extension file. 1. To translate the files content to your language of choice please open the file that you downloaded with a text-editor of your choice. 2. Make sure to replace all terms and translations that relate to the German version by the corresponding terms of your language of choice. (See example extract from file: de.pm.txt that we should have renamed to zul.pm.txt following the example in paragraph 3.2.) # Kernel/Language/de.pm - provides German language translation # Copyright (C) OTRS AG, # Copyright (C) 2010 Thomas Kaltenbrunner <tkaltenbrunner at opc.de> # $Id: de.pm,v /02/28 09:41:23 bes Exp $ # This software comes with ABSOLUTELY NO WARRANTY. For details, see # the enclosed file COPYING for license information (AGPL). If you # did not receive this file, see package Kernel::Language::de; use strict; 5

6 use warnings; use vars qw($version); $VERSION = qw($revision: $) [1]; sub Data { my $Self = shift; # $$START$$ # Last translation file sync: :08:54 # possible charsets $Self->{Charset} = ['iso ', 'iso ', ]; # date formats (%A=WeekDay;%B=LongMonth;%T=Time;%D=Day;%M=Month;%Y=Year;) $Self->{DateFormat} = '%D.%M.%Y %T'; $Self->{DateFormatLong} = '%T - %D.%M.%Y'; $Self->{DateFormatShort} = '%D.%M.%Y'; $Self->{DateInputFormat} = '%D.%M.%Y'; $Self->{DateInputFormatLong} = '%D.%M.%Y - %T'; # csv separator $Self->{Separator} = ';'; $Self->{Translation} = { # Template: AAABase 'Yes' => 'Ja', 'No' => 'Nein', 'yes' => 'ja', 'no' => 'nein', 'Off' => ' ', 'off' => 'aus', [...] 3. Keep in mind, the file must provide a valid Perl syntax. Examples: 'Hours' => 'abcd', 'Hours' => 'abcd' 'Hours' => 'abcd, 'Hours' => 'abcd Syntax is perfect The closing comma at the lines end is missing The closing apostrophe ' at the translated terms end is missing Both, closing comma and apostrophe ' are missing If the syntax is faulty it can't be read properly by OTRS. Therefore the syntax must be validated. You can check the quality using the command line by typing in: perl -cw zul.pm (the file name zul.pm follows our example, please instead use the file name that you are currently working on). The resulting report should be 'Syntax OK'. 4. Please also make sure to translate as much terms as possible. If there are missing translations in the German version that you used, shown, e.g. 'Off' => ' ', put the right translation between the apostrophes. 5. Please use the charset utf-8 while working on a translation file. 6. After you have completed the translation save the file. 5 Step 3: Where to Send Translated Files Well done! Once you have completed a translation, regardless if it is a new one or the completion of an existing one, a framework or extension file please send the translated file to: i18n@otrs.org which is the mailing list that relates to translations. To use this list please subscribe first. Mailing list subscription page: Thank you all for your contributions to the OTRS project! Your OTRS Team 6