docs: document the language-string workflow (#1070) (#1071)

Refresh the Translation process 
 * rename DOCUMENTS/LANGUAGE.txt to DOCUMENTS/Translations.md, attempt to format.
 * Removes the dead SVN / SourceForge references, points at GitHub.
 * Add a **"for developers"** section etc

Thanks @knofte
This commit is contained in:
Kent Riboe authored and GitHub committed 2026-07-07 20:37:59 +01:00
1 parent 0328f02ec9
commit c51d00cefb
2 files changed
+49 -17

No files matched your search

-17
View File
@@ -1,17 +0,0 @@
#
# Postfix Admin
# by Mischa Peters <mischa at high5 dot net>
# Copyright (c) 2002 - 2005 High5!
# Licensed under GPL for more info check GPL-LICENSE.TXT
#
If you want to contribute a translation, please follow these easy steps:
- download your language file from SVN
http://postfixadmin.svn.sourceforge.net/viewvc/postfixadmin/trunk/languages/
- search for lines with '# XXX' comments and
- translate the line
- remove the '# XXX'
Note: The file is utf-8 encoded. You can also use htmlentities.
- post your translation to the Sourceforge tracker
http://sourceforge.net/tracker/?group_id=191583&atid=937966
+49
View File
@@ -0,0 +1,49 @@
# Translating PostfixAdmin
PostfixAdmin is translated into multiple languages. The translation files can be found in `languages/*.lang` with one
file per language.
`languages/en.lang` is the canonical (English) source.
Each file is a PHP file (so MUST start with `<?php`, containing a list of :
```PHP
$PALANG['key'] = 'text';
```
statements. They are UTF-8 encoded (htmlentities may also be used).
## Translating
To contribute or update a translation:
- Edit the file for your language, e.g. languages/de.lang.
- Untranslated strings are marked with a trailing `# XXX` comment - they still
contain the English text. For each such line:
- translate the text, then
- remove the "# XXX" marker.
- Note: If you're running Postfixadmin locally, refreshing the relevant page should show changes straight away (there is
no caching/compilation required). If you refresh a web browser using that translation, you should see your changes
straight away
- Generate a patch file with your changes and attach it to a new issue at : https://github.com/postfixadmin/postfixadmin, or (ideally) open a new pull request.
## Adding or changing strings (for developers)
Only edit languages/en.lang when you add a new `$PALANG[...]` string or change an
existing one. Then propagate it to every other language file:
```shell
$ cd languages
$ ./language-update.sh --patch
```
This copies the new (or changed) keys into each language file, marked with a
trailing "# XXX" comment so translators can find the strings that still need
translating. Commit the updated languages/*.lang files together with your
en.lang change.
Please do not hand-translate strings in a feature pull request - just leave the
English "# XXX" placeholders and let the translation teams handle them.
Run `./language-update.sh --help` for its other modes (listing missing keys,
renaming or removing a key across all language files, etc.).