joeac/comitium
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clarify sections of translating.md and add mention of new help.yaml and errors.yaml files

Browse Source
This commit is contained in:
nytpu
2021-05-11 14:10:29 -06:00
parent 92fa3015b5
commit 6e1fc209cc
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/translating.en.md
+18 -9
View File
@@ -10,9 +10,10 @@ Translations for literally any language not listed above are welcome.
Translating comitium is really easy! You have to translate like twenty words
and that's it.
To start, download the YAML file with all the strings:
[files.yaml](/comitium/tree/localizations_src/en-US/files.yaml) (if you'd prefer
to start with a language other than English, see other languages
To start, download the [YAML files with all the
strings](/comitium/tree/localizations_src/en-US/), you need all three:
`files.yaml`, `help.yaml`, and `errors.yaml`. If you'd prefer to start with a
language other than English, see other languages
[here](/comitium/tree/localizations_src/)).
The file will be a series of key-value pairs and comments, it'll be laid out
@@ -34,12 +35,20 @@ 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.
There we go, you translate all the lines in that file (you don't need to do
comments) and that's it! You just translated comitium! Email the YAML file to
me at [alex [at] nytpu.com](mailto:alex@nytpu.com) and I'll take care of the
rest.
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
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.
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
I'll take care of the rest.
If you want to be extra helpful, you could also translate [the
quickstart](/comitium/tree/doc/quickstart.en.md) and [this
quickstart](/comitium/tree/doc/quickstart.en.md) and [this translating
document](/comitium/tree/doc/translating.en.md), but you shouldn't feel
obligated to do so.
obligated to do so. Note that due to logistical and deployment issues, the man
page (`comitium.1.scd`) is not being translated at this time.