From b92e638f8796e40ec28316fd26f060f70ba28fe5 Mon Sep 17 00:00:00 2001 From: nytpu Date: Tue, 11 May 2021 15:20:15 -0600 Subject: [PATCH] clarify escape chars in translate.md --- doc/translating.en.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/translating.en.md b/doc/translating.en.md index d4bbe0d..ffc8cff 100644 --- a/doc/translating.en.md +++ b/doc/translating.en.md @@ -35,6 +35,12 @@ feed_subscriptions_link: Currently aggregating {{.num}} capsules, gopherholes, a You'd just translate the string `Currently aggregating[...]capsules, gopherholes, and websites.` and leave the `feed_subscriptions_link: ` and `{{.num}}` as-is. +Some lines that contain colons may be surrounded by single quotes (`key: 'line: +to translate'`), please leave those in place unless you remove the colon in your +translation. Some lines may have escaped characters (`key: Please \"quote\" +me`), please be sure that those characters are also escaped in your +translation. + At minimum you need to do `files.yaml` (it's the shortest one) to translate the text that's outputted into `feed.gmi` and `subscriptions.gmi`. It's okay not to do the other two YAML files, as those are messages displayed to the