aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/INSTALL-exim4.md2
-rw-r--r--doc/TRANSLATE.md24
2 files changed, 22 insertions, 4 deletions
diff --git a/doc/INSTALL-exim4.md b/doc/INSTALL-exim4.md
index c564fb70f..6a0e1247e 100644
--- a/doc/INSTALL-exim4.md
+++ b/doc/INSTALL-exim4.md
@@ -28,7 +28,7 @@ And, assuming you set `OPTION_INCOMING_EMAIL_PREFIX` in your config at
`config/general` to "foi+", create `config/aliases` with the following
content:
- ^foi+.*: |/path/to/alaveteli/software/script/mailin
+ ^foi\\+.*: |/path/to/alaveteli/software/script/mailin
Finally, make sure you have `dc_use_split_config='true'` in
`/etc/exim4/update-exim4.conf.conf`, and execute the command
diff --git a/doc/TRANSLATE.md b/doc/TRANSLATE.md
index 37ed4701b..be88dafa0 100644
--- a/doc/TRANSLATE.md
+++ b/doc/TRANSLATE.md
@@ -5,7 +5,19 @@ The Transifex project is at
https://www.transifex.net/projects/p/alaveteli/; you'll probably want
an account there (ask on the mailing list).
-# Finding new translatable strings
+# Summary
+
+1. Make some changes to the software with `_('translatable strings')`
+2. Run `./script/generate_pot.sh`
+3. This should just cause the file at `locale/app.pot` to change. Commit and push
+4. Send a message to the alaveteli-dev mailing list warning them that you're going to upload this file to transifex
+5. Wait a day or so
+6. Update the `app.pot` resource in Transifex
+7. When new translations are available, run `tx pull -a` and commit the results to the repository
+
+# Detail
+
+## Finding new translatable strings
To update the POT file with strings from the software source, run
`rake gettext:find` from the Alaveteli software. This will also
@@ -13,7 +25,14 @@ update all the PO files for all the languages, which you don't
actually want, because these are all handled in Transifex; so you'll
want to revert these files again using git.
-# Pulling translations from Transifex
+The script at `./script/generate_pot.sh` does these steps for you.
+
+When you've changed the POT file, and committed it, you should warn
+people on the mailing list before logging into Transifex and pressing
+the button to import it into that system. Otherwise, translators
+might lose some of their old but useful translations.
+
+## Pulling translations from Transifex
To update the local translation files using the Transifex command-line client, first install it:
@@ -24,4 +43,3 @@ Then you can run the following from the root of your Alaveteli install:
tx pull -a
Finally, commit these translations to github as usual.
-