diff --git a/README.md b/README.md index 2fd6153e..adf78c35 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Translations ------------ Translations are welcome via our Transifex project at -https://www.transifex.com/lfleischer/aurweb; see `doc/i18n.txt` for details. +https://www.transifex.com/lfleischer/aurweb; see [doc/i18n.md](./doc/i18n.md) for details. ![Transifex](https://www.transifex.com/projects/p/aurweb/chart/image_png) diff --git a/doc/i18n.txt b/doc/i18n.md similarity index 69% rename from doc/i18n.txt rename to doc/i18n.md index 44fb0f1f..d81c467d 100644 --- a/doc/i18n.txt +++ b/doc/i18n.md @@ -3,9 +3,9 @@ aurweb Translation This document describes how to create and maintain aurweb translations. -Creating an aurweb translation requires a Transifex (http://www.transifex.com/) +Creating an aurweb translation requires a Transifex (https://app.transifex.com/) account. You will need to register with a translation team on the aurweb -project page (http://www.transifex.com/projects/p/aurweb/). +project page (https://app.transifex.com/lfleischer/aurweb/). Creating a New Translation @@ -21,23 +21,23 @@ strings for the translation to be usable, and it may have to be disabled. 1. Check out the aurweb source using git: -$ git clone https://gitlab.archlinux.org/archlinux/aurweb.git aurweb-git + $ git clone https://gitlab.archlinux.org/archlinux/aurweb.git aurweb-git -2. Go into the "po/" directory in the aurweb source and run msginit(1) to +2. Go into the "po/" directory in the aurweb source and run [msginit(1)][msginit] to create a initial translation file from our translation catalog: -$ cd aurweb-git -$ git checkout master -$ git pull -$ cd po -$ msginit -l -o .po -i aurweb.pot + $ cd aurweb-git + $ git checkout master + $ git pull + $ cd po + $ msginit -l -o .po -i aurweb.pot 3. Use some editor or a translation helper like poedit to add translations: -$ poedit .po + $ poedit .po 5. If you have a working aurweb setup, add a line for the new translation in - "web/lib/config.inc.php.proto" and test if everything looks right. + "po/Makefile" and test if everything looks right. 6. Upload the newly created ".po" file to Transifex. If you don't like the web interface, you can also use transifex-client to do that (see below). @@ -49,13 +49,15 @@ Updating an Existing Translation 1. Download current translation files from Transifex. You can also do this using transifex-client which is available through the AUR: -$ tx pull -a + $ tx pull -a 2. Update the existing translation file using an editor or a tool like poedit: -$ poedit po/.po + $ poedit po/.po 3. Push the updated translation file back to Transifex. Using transifex-client, this works as follows: -$ tx push -r aurweb.aurwebpot -t -l + $ tx push -r aurweb.aurwebpot -t -l + +[msginit]: https://man.archlinux.org/man/msginit.1