aboutsummaryrefslogtreecommitdiffstats
path: root/doc/TRANSLATE.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/TRANSLATE.md')
-rw-r--r--doc/TRANSLATE.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/TRANSLATE.md b/doc/TRANSLATE.md
index f8b4adbcb..2a8b0269e 100644
--- a/doc/TRANSLATE.md
+++ b/doc/TRANSLATE.md
@@ -46,6 +46,10 @@ application developers about the context in which the text appears in the
application - these comments will appear under the 'Details' tab for the
text in Transifex.
+Some texts will have placeholders in them to indicate that another bit of text generated by Alaveteli will be inserted into them when they're displayed. They will look like `some text with a {{placeholder}}`. For these texts, don't translate the placeholder. It needs to stay exactly the same for the text to be inserted properly.
+
+Similarly, some texts will have some code in angle brackets in them to turn bits of the text into links, and other small bits of HTML formatting. e.g. `please <a href=\"{{url}}\">send it to us</a>`. Again, don't edit the bits in angle brackets, preserve them in your translation, just edit the text around them.
+
Some bits of text are in the form of two bits of text separated by a `|`
character e.g. `IncomingMessage|Subject`. These represent attribute names, so
`IncomingMessage|Subject` is the subject attribute of an incoming message on