
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.txt and add
a new entry to the list of languages. Look for the variable
KWAVE_LINGUAS and 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:Francais
The 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 po and copy the
file kwave.pot to the corresponding .po file of
the language you want to add: ".
After that you can translate the file using your favorite tool, like
<code>.po"kbabel.
Example:
%cd$HOME/src/kwave%cdpo%cpkwave.potfr.po%kbabelfr.po
online help:
This is similar to the procedure for the user interface, but requires
some extra steps because the master file is in docbook
format and the .pot template is a generated
file.
Go to the source directory of Kwave (not the build directory),
change into the subdirectory doc and create
an empty .po file:
Then change your build directory (e.g. somewhere in%cd$HOME/src/kwave%cddoc%touchhelp_fr.po
/tmp),
prepare for building and then generate the .pot template (you
can safely ignore the error messages that come out at this stage).
This themplate has to be copied to the .po file in the source
directory of the online help.
Example:
Now you can translate the%mkdir/tmp/kwave-build%cd/tmp/kwave-build%cmake$HOME/src/kwave%make doc%cpdoc/help_en.pot$HOME/src/kwave/doc/help_fr.po
.po file, like above:
%cd$HOME/src/kwave%cddoc%kbabelhelp_fr.po
screenshots:
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=no or 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 .png and
should follow the
KDE
Documentation Screenshots Requirements.
Here in short:
Window decoration: Plastik
Widget style: Plastik
Colors: KDE Default
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
Useful links:
RFC 3066 Tags for the Identification of Languages
KDE Localization contains a lot of useful links for KDE translators.
KBabel is
the standard tool that helps you
translating .po files.
Would you like to make a comment or contribute an update to this page?
Send feedback to the KDE Docs Team