Difference between revisions of "Update the Localisation Files"

From IMSMA Wiki
Jump to: navigation, search
 
(44 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<table cellspacing="5" cellpadding="0" style="float: right; clear: right; color: black; background: #f9f9f9; border: 1px solid #aaa; width: 22em; margin: 0 0 1.0em 1.0em; padding: 0.2em; border-spacing: 0.4em 0; text-align: center; line-height: 1.4em; font-size: 88%; background-color: #f5faff; font-size: 90%; width: auto; line-height: 1.6em; width:150px;;;" class="vertical-navbox nowraplinks">
+
{{Warning | The two original files IMessage.properties and ITerms.properties should '''not''' be edited. If you would like to '''change the English''' terms and messages then you have to create an '''English copy''' of the files. Be very careful with Search and Replace function while editing the files. The KEY names (value on the left of the '''<nowiki>=</nowiki>''' sign) should '''not''' be replaced.}}
<th style="padding: 0.2em 0.4em 0.2em; font-size: 145%; line-height: 1.2em; font-weight: bold; background-color: #9aa8b5; font-size: 125%" class="">Related Topics</th>
 
<tr>
 
<td style="padding-top: 0.2em; font-weight: bold; background-color: #cee0f2" class="">Sample Table</td>
 
</tr>
 
<tr>
 
<td style="padding-bottom: 0.2em; text-align: left">
 
[[HowTo: Update the Localisation Files | Update the Localisation Files]]<br />
 
[[IMessage.Properties]]<br />
 
[[ITerms Properties]]<br />
 
[[UIStrings.Properties]]<br />
 
[[HowTo:Translate CDFs and Custom Options Via a File | Translate CDFs and Custom Options Via a File]]<br />
 
</td>
 
</tr>
 
</table>
 
<td style="padding-top: 0.2em; font-weight: bold; background-color: #cee0f2" class="">Configuration Articles</td>
 
</tr>
 
<tr>
 
<td style="padding-bottom: 0.2em; text-align: left">
 
[[IMSMA Version]]<br />
 
[[Localisation]]<br />
 
[[HowTo:Change the Language]]<br />
 
</td>
 
</tr>
 
</table>
 
  
In order to support IMSMA languages other than English, several files are provided to allow you to translate the messages and terms used in IMSMA. If you would like to run IMSMA in a language other than English, you will need to enter translations into the following .properties files:
+
{{Note | To modify the localisation files, you '''should''' use Rosetta-J. Contact your [[Information Management Team | GICHD IM advisor]] who will provide guidance. You may download Rosetta-J from this '''[http://mwiki.gichd.org/mediawiki/images/0/00/Rosetta_J.zip link]'''.}}
::*IMessages.Properties
 
::*Iterms.Properties
 
::*UIStrings.Properties
 
  
 +
The three files that are used for localisation need to be created for each new language. Each language has a unique language code. IMSMA is using the Window's codes. See which code should be used in the Data Inventory Manager.
  
A copy of the files above is available for each language supported by IMSMA. The files specific to a language are suffixed with an identifier specific to the language. For example, to translate the ITerms.Properties file for Spanish, you should modify the ITerm_Es.Properties file.
+
# In the '''Customisation''' menu &rarr; '''Data Inventory Manager'''.
 +
# Click on the Translate button in the Data Category pane of the Data Inventory Manager window.
 +
# Find the desired language in the Language list and note the code e.g. km for Khmer.
  
 +
{{Note| If you are running {{IMSMANG}} in a client/server installation and modify the properties files, you will need to copy of IMessage and ITerms files to the ''C:\IMSMAng\client\resources\com\fgm\imsma\lexicon'' folder of each client computer. }}
  
[[File:Supported Languages.png|440px|''Table 55. Filename Suffixes for Supported Languages'']]
+
==IMessages.properties==__NOEDITSECTION__
 +
The IMessage.properties file contains the error messages and warning messages used by {{IMSMANG}}. The file is located in the ''C:\IMSMAng\client\resources\com\fgm\imsma\lexicon'' folder.
 +
# Copy the existing IMessage.properties to e.g. IMessage_km.properties or IMessage_en.properties for English.
 +
# Edit the IMessage.properties copy with Rosetta-J.
  
{| class="wikitable"
+
==ITerms.properties==__NOEDITSECTION__
|-
+
The ITerms.Properties file contains terms used in menus, tooltips and field names in {{IMSMANG}}. The file is located in the ''C:\IMSMAng\client\resources\com\fgm\imsma\lexicon'' folder.
| [[File:LightBulb.png|20px|<span title=""></span>]]  To modify the localisation files, it is recommended that you use Rosetta-J. For information on using Rosetta-J, refer to the Rosetta-J User Manual.  
+
# Copy the existing ITerms.properties to e.g. ITerms_km.properties or ITerms_en.properties for English.
|}
+
# Edit the ITerms.properties copy with Rosetta-J.
  
[[Category: Maintaining IMSMA]] [[Category: Considerations for Language and Translation]] [[Category: HowTo Update the Localisation Files]]
+
{{Warning | There are two terms that should '''not''' be translated and affects how dates are written in {{IMSMANG}}, see [[Two Terms Not to be Translated | '''more details here''']].}}
 +
 
 +
==trans.properties==__NOEDITSECTION__
 +
The third files contains Data Inventory categories, enumeration values, Custom Defined Fields' labels, etc. 
 +
# '''[[Export the Translations|export]]''' the English translations
 +
# rename the file (e.g. trans_km)
 +
# '''update''' the first row in the file to the new language code
 +
# create translations with Rosetta-J
 +
# '''[[Import the Translations|import]]''' the file into the database.
 +
 
 +
{{NavBox HowTo Languages and Translations}}
 +
 
 +
[[Category:NAA]]

Latest revision as of 19:07, 18 August 2021

Warning.jpg The two original files IMessage.properties and ITerms.properties should not be edited. If you would like to change the English terms and messages then you have to create an English copy of the files. Be very careful with Search and Replace function while editing the files. The KEY names (value on the left of the = sign) should not be replaced.
Note.jpg To modify the localisation files, you should use Rosetta-J. Contact your GICHD IM advisor who will provide guidance. You may download Rosetta-J from this link.

The three files that are used for localisation need to be created for each new language. Each language has a unique language code. IMSMA is using the Window's codes. See which code should be used in the Data Inventory Manager.

  1. In the Customisation menu → Data Inventory Manager.
  2. Click on the Translate button in the Data Category pane of the Data Inventory Manager window.
  3. Find the desired language in the Language list and note the code e.g. km for Khmer.
Note.jpg If you are running IMSMANG in a client/server installation and modify the properties files, you will need to copy of IMessage and ITerms files to the C:\IMSMAng\client\resources\com\fgm\imsma\lexicon folder of each client computer.

IMessages.properties

The IMessage.properties file contains the error messages and warning messages used by IMSMANG. The file is located in the C:\IMSMAng\client\resources\com\fgm\imsma\lexicon folder.

  1. Copy the existing IMessage.properties to e.g. IMessage_km.properties or IMessage_en.properties for English.
  2. Edit the IMessage.properties copy with Rosetta-J.

ITerms.properties

The ITerms.Properties file contains terms used in menus, tooltips and field names in IMSMANG. The file is located in the C:\IMSMAng\client\resources\com\fgm\imsma\lexicon folder.

  1. Copy the existing ITerms.properties to e.g. ITerms_km.properties or ITerms_en.properties for English.
  2. Edit the ITerms.properties copy with Rosetta-J.
Warning.jpg There are two terms that should not be translated and affects how dates are written in IMSMANG, see more details here.

trans.properties

The third files contains Data Inventory categories, enumeration values, Custom Defined Fields' labels, etc.

  1. export the English translations
  2. rename the file (e.g. trans_km)
  3. update the first row in the file to the new language code
  4. create translations with Rosetta-J
  5. import the file into the database.