.PROPERTIES - Java Properties (Strings)

File Extensions	.properties
API Extension	properties
Import	Yes
Export	Yes
Plural forms support	No
Description support	Yes
Format options These options that can be specified when a file is uploaded and/or downloaded. Depending on the upload/download method (API, CLI, Repo sync etc.), they can be specified in query parameters `Upload`, `Download` or in the `phrase.yml` configuration file.	escape_single_quotes omit_separator_space crlf_line_terminators `escape_meta_chars`

Java Properties are standard config/localization files typically used by Java. This file format contains key-value pairs connected by a = sign. Apart from this, it does not have any other cascading element. Values in the file will always be parsed as a String type.

Duplicate keys (the file contains two or more identical keys) should not be problematic, but values loaded later in the process will overwrite previous data. When preparing a file for translation, check for duplicate keys by putting the properties files into a Java IDE (e.g. Eclipse, IntelliJ) to identify them.

Format Options

Identifier	escape_single_quotes
Type	boolean
Upload	Yes
Download	Yes
Default	true
Description	Escape single quotes with another single quote (e.g. I'm -> I''m ).

Identifier	omit_separator_space
Type	boolean
Upload	No
Download	Yes
Default	false
Description	Skip the space before and after the separator sign (= ).

Identifier	crlf_line_terminators
Type	boolean
Upload	No
Download	Yes
Default	false
Description	Use CRLF (Windows) line terminator chars.

Identifier	escape_meta_chars
Type	boolean
Upload	No
Download	Yes
Default	true
Description	Escape meta characters (`:=!#`) using a backslash

Code Sample

boolean_key = --- true\n
empty_string_translation = 
# This is the amazing description for this key!
key_with_description = Check it out\! This key has a description\! (At least in some formats)
key_with_line-break = This translations contains\na line-break.
nested.deeply.key = Wow, this key is nested even deeper.
nested.key = This key is nested inside a namespace.
null_translation = 
pluralized_key.one = Only one pluralization found.
pluralized_key.other = Wow, you have %s pluralizations\!
pluralized_key.zero = You have no pluralization.
sample_collection = ---\n- first item\n- second item\n- third item\n
simple_key = Just a simple key with a simple message.
unverified_key = This translation is not yet verified and waits for it. (In some formats we also export this status)