This object are translations for language overrides on the base information for an event. These would be added to the event packet in an array keyed with the correct locale code.
{
"title" : "Translated Title",
"description" : "Translated list description for event.#BREAK#Can include breaks as normal",
"content" : "Translated main copy for event.#BREAK#Can include breaks as normal",
"highlightText" : "Translated Tag",
"prices": "Translated Prices#BREAK#With Breaks",
"timeText" : "10am - 4pm",
"linksHeading" : "More Info Translation",
"links" : [
"Translated Title 1",
"Translated Title 2"
]
}Type : Rich Text / Multiline String - Optional
Translated list description with can include breaks
Type : Markdown Text / Multiline String - Optional
Translated main copy with can include breaks and some basic markdown
Type : String - Optional
Optional translated highlight text - Only relevant if highlight text is set to a custom value
Type : Rich Text / Multiline String - Optional
Optional translated prices information with can include breaks
Type : String - Optional
Only required if the event is marked as all day, and has an custom all day time text. If english version is blank then a translated version of 'All Day' will be used anyway
Type : String - Optional
Only required if links heading if any have been set in the main record. Optional translation for the downloads / links heading. If english version is blank then a translated version of 'More information' will be used
Type : Array of String - Optional
A list of translation for the link buttons. Note this array should match up in order and size to the main record version. If not then the translations could be mismatched to the buttons. If there are more translations, the last entries will be discarded. If there are less translations, then the original language will be retained on the last entries.
Acts the same as a Rich Text / Multiline String (including using #BREAK# for new lines) however this text can include a limited set of MarkDown to allow rich formatting.
This includes :
*italic text* : Italic Text
**bold text** : Bold Text
***bold and italic text*** : Bold and Italic Text
• Bullet 1
- List of bullet points with hyphans or bullet character
1. Number Item 1
2. Numbered list of items with number and full stop
{
"copy": "This paragraph will now have two line breaks, and then a list of bullets#BREAK##BREAK#• Bullet 1#BREAK#• Bullet 2#BREAK#• Bullet 3",
"copyMarkdown": "This paragraph will now have two line breaks but with bits in **bold** and *italic*, and then a list of bullets#BREAK##BREAK#- Bullet 1#BREAK#- Bullet 2#BREAK#...and a numbered list...#BREAK#1. Number Item 1#BREAK#2. Number Item 2"
}Acts the same as the standard String type, however If text is assumed to include line breaks then we use a place holder of #BREAK#. These will then be replaced by the relevant line breaks depending on the language, and device that is rendering the text. This is commonly used in entity copy, and addresses. Rich text should not include HTML or other markup. There should always be a contextual consideration as well - for example if you copy includes a html anchor link to 'Read More' - then simply removing the markup will then leave the text 'Read More' which will be a redundant, none clickable piece of text within the app surfaces.
{
"textWithBullets": "This paragraph will now have two line breaks, and then a list of bullets#BREAK##BREAK#• Bullet 1#BREAK#• Bullet 2#BREAK#• Bullet 3",
"address": "Holidaymaker App Ltd#BREAK#Stowey House#BREAK#Bridport Road#BREAK#Dorchester#BREAK#DT12SB"
}Standard JSON String - Often will have certain characters escaped depending what system is writing the JSON packet, however our parser only requires to have double quotes (") escaped. UTF-8 encoding is our standard, but others may be accepted if required. If line breaks are required in the text then the Rich Text / Multiline String type is used instead.
{
"key1": "A string value",
"key2": "Another string with an some \"quotes\" that need escaping",
"arrayOfStrings": [
"Item one as a string",
"Item two as a string",
"Item three as a string",
]
}