git-update.py: Check for mandatory fields
[aur.git] / TRANSLATING
blob27855f6b7938e41e112c9db306697776f4dfc03d
1 AUR Translation
2 ================
4 This document describes how to create and maintain AUR translations. It was
5 originally derived from https://wiki.archlinux.org/index.php/AUR_Translation
7 Creating an AUR translation requires a Transifex (http://www.transifex.com/)
8 account. You will need to register with a translation team on the AUR project
9 page (http://www.transifex.com/projects/p/aur/).
12 Creating a New Translation
13 ---------------------------
15 Before beginning, please sign up for an Transifex account and request the
16 addition of a new translation team for the AUR project. Also, please do not
17 translate if you are unwilling to maintain or find someone to maintain the
18 translation. This is due to the fact that the AUR is a rapidly evolving project
19 and there are constantly new strings to be translated. If the translations get
20 too out of sync with the released versions, there will be too many untranslated
21 strings for the translation to be usable, and it may have to be disabled.
23 1. Check out the AUR source using git:
25 $ git clone git://projects.archlinux.org/aur.git aur-git
27 2. Go into the "po/" directory in the AUR source and run msginit(1) to create a
28    initial translation file from our translation catalog:
30 $ cd aur-git
31 $ git checkout master
32 $ git pull
33 $ cd po
34 $ msginit -l <locale> -o <locale>.po -i aur.pot
36 3. Use some editor or a translation helper like poedit to add translations:
38 $ poedit <locale>.po
40 5. If you have a working AUR setup, add a line for the new translation in
41    "web/lib/config.inc.php.proto" and test if everything looks right.
43 6. Upload the newly created ".po" file to Transifex. If you don't like the web
44    interface, you can also use transifex-client to do that (see below).
47 Updating an Existing Translation
48 ---------------------------------
50 1. Download current translation files from Transifex. You can also do this
51    using transifex-client which is available through the AUR:
53 $ tx pull -a
55 2. Update the existing translation file using an editor or a tool like poedit:
57 $ poedit po/<locale>.po
59 3. Push the updated translation file back to Transifex. Using transifex-client,
60    this works as follows:
62 $ tx push -r aur.aurpot -t -l <locale>