From c6b4cad199e211cf0a1c11870d9e38b0cc14a2dc Mon Sep 17 00:00:00 2001 From: nytpu Date: Tue, 11 May 2021 18:30:44 -0600 Subject: [PATCH] rework description in translating.md --- doc/translating.en.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/doc/translating.en.md b/doc/translating.en.md index 44604df..98ba598 100644 --- a/doc/translating.en.md +++ b/doc/translating.en.md @@ -36,19 +36,30 @@ 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 +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 administrator adding feeds and such rather than to the end reader. Obviously full translations are preferred though. You also don't need to translate comments in any of the files. +Finally, you don't need to directly translate everything, rather adapt them in +a way that makes sense. For things like the subtitles in `subscriptions.gmi`, +the lines can be completely changed altogether if necessary. + +A few things to keep in mind: + +* Lines that contain colons are surrounded by single quotes (`key: 'line: + to translate'`), leave those in place unless you remove the colon in + your translation. +* Lines that begin with a replacement (`key: '{{.replace}} rest of line'`) must + be surrounded by single quotes, leave those in place unless you move the + position of the replacement. +* If a line is surrounded by single quotes, then any single quotes within that + line must be doubled. For instance `doesn't` would be changed to `doesn''t'`. +* Double quotes must be backslash-escaped. For instance, `a "quote"` would be + changed to `a \"quote\"`. + There we go, you translate all the lines in `files.yaml` (and possibly `help.yaml` and `errors.yaml`) and that's it! You just translated comitium! Email the YAML files to me at [alex [at] nytpu.com](mailto:alex@nytpu.com) and