summaryrefslogtreecommitdiff
path: root/doc/translations_po.txt
diff options
context:
space:
mode:
authorHolger Wansing <hwansing@mailbox.org>2019-12-21 20:38:40 +0100
committerHolger Wansing <hwansing@mailbox.org>2019-12-21 20:38:40 +0100
commit6da4a0356a8eabc4f601b9378800801f1a43b93c (patch)
tree55447ce2d16b89f48c9ce0ba76fc00dc924ae3dc /doc/translations_po.txt
parentf9361c2d8032534eb80eb19998760e20b32d3511 (diff)
downloadinstallation-guide-6da4a0356a8eabc4f601b9378800801f1a43b93c.zip
Update docs (things have changed in the meantime)
Diffstat (limited to 'doc/translations_po.txt')
-rw-r--r--doc/translations_po.txt108
1 files changed, 60 insertions, 48 deletions
diff --git a/doc/translations_po.txt b/doc/translations_po.txt
index b6de69bbf..25a8e4a0e 100644
--- a/doc/translations_po.txt
+++ b/doc/translations_po.txt
@@ -10,49 +10,6 @@ This is now officially supported and the recommended way.
Note: if you happen to modify this file, please don't forget to
update the trailing changelog
-Background information
-======================
-There are currently two toolsets that support translating XML files using .po
-files: KDE's poxml and po4a. We have chosen poxml as that gives better context
-(it does not split paragraphs) for translation.
-The downside of the poxml tools is that they require the .xml files to be
-"proper" XML. Because some of the individual files in the English
-original are not proper XML, we've had to "integrate" the files per chapter.
-
-This means that instead of translating about 160 small files, you will be
-translating about 16 large files.
-
-Requirements
-============
-The following packages need to be installed on your system:
-- gettext
-- poxml
-- gawk
-
-If you also want to be able to build the manual, you also need to install the
-build dependencies listed in build/README.
-
-Available tools
-===============
-You will not be using poxml itself, but rather some scripts that call the
-poxml tools.
-
-- ./scripts/merge_xml : merges the small .xml files into larger files
-- ./scripts/update_pot : creates (new) .pot templates based on integrated
- English .xml files
-- ./scripts/revert_pot : used to revert changes in POT files to avoid
- accidental commits
-- ./scripts/update_po : updates your .po files when there are changes in the
- English text (the .pot templates)
-- ./scripts/create_xml : creates translated .xml files from the merged English
- .xml files and the translated .po files
-- ./scripts/create_po : used to convert an existing .xml translation to
- using .po files
-- ./scripts/set_untranslated : used for the conversion of existing translations
-
-All scripts should be run from the ./installation-guide directory and take the language as
-parameter.
-
Starting a new translation
==========================
@@ -70,7 +27,7 @@ Example for a Dutch translation:
- cp ./po/pot/bookinfo.pot ./po/nl/bookinfo.po
- <po editor> ./po/nl/bookinfo.po
-Use your favorite PO file editor (like kbabel) to translate the .po file.
+Use your favorite PO file editor (like lokalize or poedit) to translate the .po file.
You don't need to copy all POT files straight away, just copy each one as you
start translating them.
@@ -82,12 +39,12 @@ The translation can be committed to d-i's git repository using:
2. git commit -m "<some comment describing the changes>"
2. git push
-Tip: use the command 'git diff -u' before you commit your changes (step 2),
+Tip: use the command 'git diff' before the git add command (step 1),
to check what you are committing.
-Updating your translation
-=========================
+Updating your translation from the english original
+===================================================
The PO files for your language and the templates for the manual are
updated regularly when there are changes in the original English XML
files. This is done during the "daily" builds (currently done by the i18n
@@ -144,12 +101,63 @@ out of your po files.
However, the update_pot and update_pot functions from above's step 1-3 are
performed in a temporary directory, so buildone_ng.sh cannot be used to update
your translation po files!
-For this, you need to still follow the chapter "Updating your translation".
+For this, you need to still follow the chapter "Updating your translation
+from the english original".
The intention of buildone_ng.sh is just, to provide an easy method for
translators, to build the manual for testing their translation.
+
+Background information
+======================
+There are currently two toolsets that support translating XML files using .po
+files: KDE's poxml and po4a. We have chosen poxml as that gives better context
+(it does not split paragraphs) for translation.
+The downside of the poxml tools is that they require the .xml files to be
+"proper" XML. Because some of the individual files in the English
+original are not proper XML, we've had to "integrate" the files per chapter.
+
+This means that instead of translating about 160 small files, you will be
+translating about 16 large files.
+
+Requirements
+============
+The following packages need to be installed on your system:
+- gettext
+- poxml
+- gawk
+
+If you also want to be able to build the manual, you also need to install the
+build dependencies listed in build/README.
+
+Available tools
+===============
+You will not be using poxml itself, but rather some scripts that call the
+poxml tools.
+
+- ./scripts/merge_xml : merges the small .xml files into larger files
+- ./scripts/update_pot : creates (new) .pot templates based on integrated
+ English .xml files
+- ./scripts/revert_pot : used to revert changes in POT files to avoid
+ accidental commits
+- ./scripts/update_po : updates your .po files when there are changes in the
+ English text (the .pot templates)
+- ./scripts/create_xml : creates translated .xml files from the merged English
+ .xml files and the translated .po files
+- ./scripts/create_po : used to convert an existing .xml translation to
+ using .po files
+- ./scripts/set_untranslated : used for the conversion of existing translations
+
+All scripts should be run from the ./installation-guide directory and take the language as
+parameter.
+
+
Converting an existing translation from .xml files to .po files
===============================================================
+
+!!! This paragraph only exists for historical reasons. There is no need for
+!!! this operations anymore, since all translations have been converted into
+!!! po files in the meantime.
+
It is possible to convert an existing translation of the manual (where the
individual XML files have been translated) to using PO files.
There are two important conditions:
@@ -291,6 +299,10 @@ If you find any errors in this file, please fix them.
--------------------------------------------------------------------------
Changelog:
+2019-12-21 Holger Wansing
+ - Update content (there are no xml-based translations anymore, po-based is
+ the default).
+
2018/06/03 Holger Wansing
Samuel Thibault
- Updating (most) content on git migration