Step by Step: The Translation of Documentation Files
Prev
Next

Step by Step: The Translation of Documentation Files

In the following we assume that you are somewhat familiar with the structure and syntax of DocBook files. For further information on this format please have a look at the pages of the documentation team.

Generally speaking, you should just install KBabel and translate the PO file as already explained in the GUI section of this HOWTO. (Additionally you need the current version of the directories l10n/templates/docmessages/, l10n/$LANGUAGE/docmessages/, l10n/$LANGUAGE/docs/ l10n/scripts/ and l10n/documentation/(PACKAGE)/doc/ from SVN):

Important

Since things keep changing (standards, formats, etc.) it is important to join the translators mailing list and to watch out for the announcements there.

If the documentation directory of the program contains screen shots you should produce a localized (e.g. with a translated GUI) version. KSnapshot is a useful tool for this purpose, but any application is fine as long as it can produce screen shots and save them as PNG file.

Important

You should follow the screenshots rules while creating a screenshot for the documentation.

Caution

It is important to save the localized picture under the same name as the original one in the translated DocBook directory corresponding to the applications English documentation DocBook directory (not the directory of the PO file).

For more information about PO files and their translation see the respective section in the GUI chapter.

Prev
Next
Home