Sorry, this chapter is still to be written... At the moment the source code is nearly completely documented with tags suitable with the KDE documentation tools. We currently prefer using doxygen. Maybe some day we will spend some time for writing a tool that converts the doxygen output into something we can include into the docbook source (the source this page has been built of).
If you want to write a plugin, contribute something to this project (or maybe write the converter mentioned above), please feel free to contact one of the authors directly and / or subscribe to the Kwave mailing list. Help is always welcome!
make system:
Edit the toplevel
CMakeLists.txtand add a new entry to the list of languages. Look for the variableKWAVE_LINGUASand add a line for the new language. Each entry consists of a pair with a language code and language name, like this:<code>:<name>. Example:fr:FrancaisThe language code is a 2-letter code which is used for directories and filenames, as it is also used in KDE. The language name is used internally for the docbook online documentation and the online help only. For a list of available language codes and names, please refer to the documentation of the international standard ISO 639.2.
user interface:
Go to the source directory of Kwave (not the build directory), change into the subdirectory
poand copy the filekwave.potto the corresponding.pofile of the language you want to add:". After that you can translate the file using your favorite tool, like<code>.po"Lokalize. Example:%cd$HOME/src/kwave%cdpo%cpkwave.potfr.po%lokalizefr.poonline help:
This is similar to the procedure for the user interface, but requires some extra steps because the master file is in
docbookformat and the.pottemplate is a generated file. Go to the source directory of Kwave (not the build directory), change into the subdirectorydocand create an empty.pofile:%cd$HOME/src/kwave%cddoc%touchhelp_fr.poThen change your build directory (e.g. somewhere in
/tmp), prepare for building and then generate the.pottemplate (you can safely ignore the error messages that come out at this stage). This themplate has to be copied to the.pofile in the source directory of the online help. Example:%mkdir/tmp/kwave-build%cd/tmp/kwave-build%cmake$HOME/src/kwave%make doc%cpdoc/help_en.pot$HOME/src/kwave/doc/help_fr.poNow you can translate the
.pofile, like above:%cd$HOME/src/kwave%cddoc%lokalizehelp_fr.poscreenshots:
For the online documentation you also need screenshots that use the translated messages. This requires a built and installed Kwave package, so you should follow the steps mentioned in the section about Manual Compilation and installation. Of course you must not pass the build option
WITH_DOC=noor any other build option that removes functionality, otherwise you would not be able to get screenshots of components that you have disabled.For a list of screenshots you can look into one of the existing directories in the source tree, for example in
$HOME/doc/de. All screenshots are in.pngand should follow the KDE Documentation Screenshots Requirements. Here in short:Window decoration: Oxygen
Widget style: Oxygen
Colors: Oxygen
Background: Flat color - Color must be white
Run X11 in 72dpi mode
Save the files in 8bpp
Try to keep the size of each file below 20kB
desktop file:
Add a Comment line for the new language to the file
kwave/kwave.desktop.in. Please note that this file is UTF-8 encoded! Example:Comment[fr]=Un éditeur de sons pour KDE
Useful links:
RFC 3066 Tags for the Identification of Languages
KDE Localization contains a lot of useful links for KDE translators.
Lokalize is the standard tool that helps you translating
.pofiles.