Dev guideslines for making translation easier

[gerhard (Gerhard Schlager)]

@Benjol

Avoid ‘walls of text’. tos_topic.body is totally unwieldy, for example. And that’s if you just have to translate it the once. But every time there is a modification, you have to scroll up/down to find the differences.

As a translator I feel your pain. Fortunately there are only a handful of very long texts. There is already a topic where we discussed possible solutions: https://meta.discourse.org/t/maintaining-huge-translated-strings-in-transifex/27413

@Benjol

Try to avoid ambiguity (i.e. does “User Modified” mean “modified by the user” or “the user has been modified”?). You don’t necessarily need to make the distinction in the text, using the key to disambiguate is a good idea too.

As an alternative, it’s also possible to add comments within the YAML files. They show up in Transifex.

https://github.com/discourse/discourse/blob/master/config/locales/client.en.yml#L19-L24