Skip to content

text-classification-582ce93.md

Latest commit

 

History

History
722 lines (472 loc) · 8.74 KB

text-classification-582ce93.md

File metadata and controls

722 lines (472 loc) · 8.74 KB

Text Classification

Texts in a properties file are simple value-key pairs separated by an equal sign (=). 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 hash 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)

You need to 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

    XALT

    Alternative text

    XBCB

    Breadcrumb step

    XBLI

    Bullet list item text

    XBUT

    Button text

    XCAP

    Caption

    XCEL

    Cell

    XCKL

    Checkbox

    XCOL

    Column header

    XCRD

    Tabstrip

    XDAT

    Data navigation text

    XFLD

    Label

    XFRM

    Frame

    XGLS

    Term

    XGRP

    Group title

    XHED

    Heading

    XLGD

    Legend text

    XLNK

    Hyperlink

    XLOG

    Log entry

    XLST

    List box item

    XMEN

    Menu header

    XMIT

    Menu item

    XMSG

    Message

    XRBL

    Radio button

    XRMP

    Roadmap step

    XROW

    Table Row Heading

    XSEL

    Selection

    XTBS

    Tab strip text

    XTIT

    Table title

    XTND

    Tree node text

    XTOL

    Quick info text

    XTXT

    General text

  • For long texts (more than 120 characters):

    Text Type

    Description

    YACT

    Accessibility (long)

    YBLI

    Bullet list item text

    YDEF

    Definition

    YDES

    Description

    YEXP

    Explanation

    YFAA

    FAQ answer

    YFAQ

    FAQ

    YGLS

    Glossary definition

    YINF

    Information

    YINS

    Instruction

    YLOG

    Log entry

    YMSE

    Error message

    YMSG

    Message text (long)

    YMSI

    Information message long

    YMSW

    Warning message

    YTEC

    Technical text

    YTIC

    Ticker / Marquee

    YTXT

    General text long

  • 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.