-
Notifications
You must be signed in to change notification settings - Fork 1
Translating conventions
The translation strings to be used should be in British English. In the translation files for locale code en-GB the strings that are already correctly translated this way can be left undefined in the translation files.
The default is to use a capital letter for the first letter. Regardless of whether this is a word or a (partial) sentence.
Punctuation should be avoided for translation strings. When dealing with long sentences or multiple sentences that will require punctuation, use a translation key instead. Translation keys use full capital names and are short, like IMPORT_EXPLANATION_P1
.
Component views that are to be accessible to the cms
component as being page types or configuration pages, currently have the convention to be in full capital names as well. For instance SETTINGS_VIEW_TITLE
and SETTINGS_VIEW_DESCRIPTION
.
When a translation string does not reveal whether the singular or plural form was meant, only the singular form may be defined with the normal capitalization. The plural form is defined in full capital names and suffixed with _PLURAL
. For example the word fish has a singular form Fish
and a plural form FISH_PLURAL
.
When referring to a verb without adding the word 'to' before that, the verb is defined in full capital names and suffixed with _VERB
. For example import has the form Import
(as in: "I Import
apples.") and the reference to the verb IMPORT_VERB
(as in: "Q: What do you want to do? A: I want to IMPORT_VERB
").