Project

General

Profile

Edit History

Wiki » Developer Guide »

Localization » History » Version 3

Tobias Wich, 10/27/2012 06:10 PM

1 1 Detlef Hühnlein 
h1. Localization Guide
2 





    3
    3
    Tobias Wich
    
h2. Localization Files





    4
    1
    Detlef Hühnlein
    





    5
    3
    Tobias Wich
    
All translation files must be located below the folder @openecard_i18n@ plus a component name. The special file Messages.properties is used to provide translated key value pairs. Completely translated files can have any other name. All files must be encoded as UTF-8.





    6
    
    
    





    7
    
    
    
All translation files follow the same scheme to identify their language. The language is written in the form of "BCP 47":https://tools.ietf.org/html/bcp47 language tags. However instead of -, _ is used as a separator, which is the common practice. This implementation only supports a subset of the BCP 47 specification, meaning only language and country codes are allowed. The default language, which is English is described by C. The name of the file and its language is separated by _. The file ending is optional for arbitrary files.





    8
    
    
    





    9
    
    
    
The following examples illustrate the scheme.





    10
    
    
    
<pre>Messages_C.properties





    11
    
    
    
Messages_de.properties





    12
    
    
    
Messages_de_DE.properties





    13
    
    
    
anyotherfile_C





    14
    
    
    
anyotherfile_C.html</pre>





    15
    
    
    





    16
    
    
    
The implementation tries to find the key in the requested language, then the default language and if nothing is specified at all, a special string in the form of &lt;No translation for key &lt;requested.key&gt;&gt; is returned. The most specific translation is used first as the following list shows.





    17
    
    
    
<pre>openecard_i18n/gui/about_de_DE.html





    18
    
    
    
openecard_i18n/gui/about_de.html





    19
    
    
    
openecard_i18n/gui/about_C.html</pre>





    20
    
    
    





    21
    
    
    





    22
    
    
    
h2. Issues with Editors





    23
    
    
    





    24
    
    
    
The Netbeans property editor does not write UTF-8 encoded files, but instead ASCII files with Unicode escape sequences. Until a workaround is provided or the issue is fixed, please use another UTF-8 capable editor. In practice that means any editor except Netbeans.





    25
    
    
    





    26
    
    
    





    27
    
    
    
h2. Translator Instructions





    28
    
    
    





    29
    
    
    
TODO: Describe what to do as a translator





    30
    
    
    





    31
    
    
    





    32
    
    
    
h2. Visual Occurrences





    33
    
    
    





    34
    
    
    
The present Localization Guide shows the relation between the different property-values and the visible screens.





    35
    
    
    





    36
    
    
    





    37
    
    
    





    38
    1
    Detlef Hühnlein
    
h1. Existing Localizations





    39
    3
    Tobias Wich
    





    40
    
    
    
The current available localization files are provided as a zip file at the end of this page.