Texts in a properties file are simple value key pairs separated by an equal sign (=) or a comma (,). However, to enable proper translation for these texts, you have to classify the texts with additional information, at least with the text type. You must place the additional information in the line directly above the text element, beginning with the number sign (#).
The complete line must have one of the following patterns (text type is mandatory, maximum length and additional context information are optional):
-
#<TextType>
-
#<TextType>,<MaximumLength>
-
#<TextType>,<MaximumLength>:<AdditionalContextInformation>
-
#<TextType>:<AdditionalContextInformation>
Text Type (Mandatory)
We recommend that you assign a text type to each text. The text type indicates to which user interface element the text is related. You can use the following main text types:
-
For short texts (up to 120 characters) :
Text Type
Description
XACT
Accessibility
XBUT
Button
XCKL
Checkbox
XCOL
Column header
XFLD
Label
XGRP
Group title
XLNK
Hyperlink
XLOG
Log entry
XLST
List box item
XMIT
Menu item
XMSG
Message
XRBL
Radio button
XSEL
Selection
XTIT
Table title
XTOL
Tooltip
-
For long texts (more than 120 characters):
Text Type
Description
YINS
Instruction
-
For text elements that are not supposed to be translated, use the text type
NOTR
.
Maximum Length (Optional)
If necessary, you can provide the maximum text length for translation. It must be greater than the source text length and must never exceed 255.
To ensure that translators have enough space for the translated texts, set an appropriate maximum text length for translation according to the source text length:
Length of Source Text in Characters |
How Is the Maximum Text Length for Translation Calculated? |
---|---|
< 8 |
Multiply by 5; minimum 12 characters |
8 - 30 |
Multiply by 3 |
> 31 |
Multiply by 1.5 |
Additional Context Information (Optional)
You can also add a comment for the translator. This is recommended for all texts.