PanicInitiative / panicbutton.io

Website
http://panicbutton.io
7 stars 8 forks source link

Transifex JSON KV file contains non-translatable HTML, Markdown, and templating elements #25

Open naturalshine opened 8 years ago

naturalshine commented 8 years ago

The JSON Key-Value pairs generated for Transifex contain un-filtered YAML and Markdown content, which includes (a) HTML Elements (b) Markdown formatting and (c) Templating elements (i.e. {{ BASE_PATH }}).

This will represent an issue in the translation process, as translators must be careful not to disturb these elements. If they are changed, the content will display differently (and possibly fail) when rendered back into markdown/yaml after translation.

It is possible to imagine a technical solution, in which elements are filtered out during the JSON conversion process, replaced by a simple hash (i.e. ***), and integrated back into the translated files. However, it has yet to be implemented.

This issue links into translation discussions happening here: iilab/contentascode#2 and here: iilab/contentascode#3 .