/****************************************************************************** * Do not edit this file. It was generated by the translator.py script. * * Copyright (C) 1997-2004 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * * $Id$ */ /*! \page langhowto Internationalization

Support for multiple languages

Doxygen has built-in support for multiple languages. This means that the text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). Currently (version 1.3.7), 29 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, Greek, Hungarian, Italian, Japanese (+En), Korean (+En), Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak,. The table of information related to the supported languages follows. It is sorted by language alphabetically. The Status column was generated from sources and shows approximately the last version when the translator was updated. \htmlonly
Language Maintainer Contact address (remove the NOSPAM.) Status
Brazilian Portuguese Fabio "FJTC" Jun Takada Chino chino@NOSPAM.icmc.sc.usp.br 1.3.8
Catalan Albert Mora amora@NOSPAM.iua.upf.es 1.2.17
Chinese Wei Liu
Wang Weihan
liuwei@NOSPAM.asiainfo.com
wangweihan@NOSPAM.capinfo.com.cn
1.2.13
Chinese Traditional Daniel YC Lin
Gary Lee
daniel@NOSPAM.twpda.com
garylee@NOSPAM.ecosine.com.tw
1.3.8
Croatian Boris Bralo boris.bralo@NOSPAM.zg.tel.hr 1.3.8
Czech Petr Přikryl prikrylp@NOSPAM.skil.cz 1.3.8
Danish Erik Søe Sørensen erik@NOSPAM.mail.nu 1.3.8
Dutch Dimitri van Heesch dimitri@NOSPAM.stack.nl 1.3.8
English Dimitri van Heesch dimitri@NOSPAM.stack.nl up-to-date
Finnish Olli Korhonen Olli.Korhonen@NOSPAM.ccc.fi obsolete
French Xavier Outhier xouthier@NOSPAM.yahoo.fr 1.3.8
German Jens Seidel jensseidel@NOSPAM.users.sf.net 1.3.8
Greek Harry Kalogirou harkal@NOSPAM.rainbow.cs.unipi.gr 1.2.11
Hungarian Földvári György
Ákos Kiss
foldvari@NOSPAM.diatronltd.com
akiss@NOSPAM.users.sourceforge.net
1.3.8
Italian Alessandro Falappa
Ahmed Aldo Faisal
alessandro@NOSPAM.falappa.net
aaf23@NOSPAM.cam.ac.uk
1.3.8
Japanese Ryunosuke Satoh
Kenji Nagamatsu
sun594@NOSPAM.hotmail.com
naga@NOSPAM.joyful.club.ne.jp
1.3.3
JapaneseEn see the Japanese language   English based
Korean Richard Kim ryk@NOSPAM.dspwiz.com 1.3.8
KoreanEn see the Korean language   English based
Lithuanian Tomas Simonaitis
Mindaugas Radzius
Aidas Berukstis
haden@NOSPAM.homelan.lt
mindaugasradzius@NOSPAM.takas.lt
aidasber@NOSPAM.takas.lt
1.3.8
Norwegian Lars Erik Jordet lej@NOSPAM.circuitry.no 1.2.2
Polish Piotr Kaminski
Grzegorz Kowal
Piotr.Kaminski@NOSPAM.ctm.gdynia.pl
g_kowal@NOSPAM.poczta.onet.pl
1.3
Portuguese Rui Godinho Lopes ruiglopes@NOSPAM.yahoo.com 1.3.3
Romanian Alexandru Iosup aiosup@NOSPAM.yahoo.com 1.2.16
Russian Alexandr Chelpanov cav@NOSPAM.cryptopro.ru up-to-date
Serbian Dejan Milosavljevic dmilos@NOSPAM.email.com 1.3.8
Slovak Stanislav Kudláč skudlac@NOSPAM.pobox.sk 1.2.18
Slovene Matjaz Ostroversnik matjaz.ostroversnik@NOSPAM.zrs-tk.si 1.2.16
Spanish Francisco Oltra Thennet foltra@NOSPAM.puc.cl 1.3.08
Swedish Mikael Hallin mikaelhallin@NOSPAM.yahoo.se 1.3.3
Ukrainian Olexij Tkatchenko olexij.tkatchenko@NOSPAM.gmx.de 1.2.11
\endhtmlonly \latexonly \begin{tabular}{|l|l|l|l|} \hline {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline \hline Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny chino@icmc.sc.usp.br} & 1.3.8 \\ \hline Catalan & Albert Mora & {\tt\tiny amora@iua.upf.es} & 1.2.17 \\ \hline Chinese & Wei Liu & {\tt\tiny liuwei@asiainfo.com} & 1.2.13 \\ ~ & Wang Weihan & {\tt\tiny wangweihan@capinfo.com.cn} & ~ \\ \hline Chinese Traditional & Daniel YC Lin & {\tt\tiny daniel@twpda.com} & 1.3.8 \\ ~ & Gary Lee & {\tt\tiny garylee@ecosine.com.tw} & ~ \\ \hline Croatian & Boris Bralo & {\tt\tiny boris.bralo@zg.tel.hr} & 1.3.8 \\ \hline Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & 1.3.8 \\ \hline Danish & Erik S\o{}e S\o{}rensen & {\tt\tiny erik@mail.nu} & 1.3.8 \\ \hline Dutch & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & 1.3.8 \\ \hline English & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\ \hline Finnish & Olli Korhonen & {\tt\tiny Olli.Korhonen@ccc.fi} & obsolete \\ \hline French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & 1.3.8 \\ \hline German & Jens Seidel & {\tt\tiny jensseidel@users.sf.net} & 1.3.8 \\ \hline Greek & Harry Kalogirou & {\tt\tiny harkal@rainbow.cs.unipi.gr} & 1.2.11 \\ \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt\tiny foldvari@diatronltd.com} & 1.3.8 \\ ~ & \'{A}kos Kiss & {\tt\tiny akiss@users.sourceforge.net} & ~ \\ \hline Italian & Alessandro Falappa & {\tt\tiny alessandro@falappa.net} & 1.3.8 \\ ~ & Ahmed Aldo Faisal & {\tt\tiny aaf23@cam.ac.uk} & ~ \\ \hline Japanese & Ryunosuke Satoh & {\tt\tiny sun594@hotmail.com} & 1.3.3 \\ ~ & Kenji Nagamatsu & {\tt\tiny naga@joyful.club.ne.jp} & ~ \\ \hline JapaneseEn & see the Japanese language & {\tt\tiny ~} & English based \\ \hline Korean & Richard Kim & {\tt\tiny ryk@dspwiz.com} & 1.3.8 \\ \hline KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\ \hline Lithuanian & Tomas Simonaitis & {\tt\tiny haden@homelan.lt} & 1.3.8 \\ ~ & Mindaugas Radzius & {\tt\tiny mindaugasradzius@takas.lt} & ~ \\ ~ & Aidas Berukstis & {\tt\tiny aidasber@takas.lt} & ~ \\ \hline Norwegian & Lars Erik Jordet & {\tt\tiny lej@circuitry.no} & 1.2.2 \\ \hline Polish & Piotr Kaminski & {\tt\tiny Piotr.Kaminski@ctm.gdynia.pl} & 1.3 \\ ~ & Grzegorz Kowal & {\tt\tiny g\_kowal@poczta.onet.pl} & ~ \\ \hline Portuguese & Rui Godinho Lopes & {\tt\tiny ruiglopes@yahoo.com} & 1.3.3 \\ \hline Romanian & Alexandru Iosup & {\tt\tiny aiosup@yahoo.com} & 1.2.16 \\ \hline Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & up-to-date \\ \hline Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & 1.3.8 \\ \hline Slovak & Stanislav Kudl\'{a}\v{c} & {\tt\tiny skudlac@pobox.sk} & 1.2.18 \\ \hline Slovene & Matjaz Ostroversnik & {\tt\tiny matjaz.ostroversnik@zrs-tk.si} & 1.2.16 \\ \hline Spanish & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & 1.3.08 \\ \hline Swedish & Mikael Hallin & {\tt\tiny mikaelhallin@yahoo.se} & 1.3.3 \\ \hline Ukrainian & Olexij Tkatchenko & {\tt\tiny olexij.tkatchenko@gmx.de} & 1.2.11 \\ \hline \end{tabular} \endlatexonly Most people on the list have indicated that they were also busy doing other things, so if you want to help to speed things up please let them (or me) know. If you want to add support for a language that is not yet listed please read the next section.

Adding a new language to doxygen

This short HOWTO explains how to add support for the new language to Doxygen: Just follow these steps:
  1. Tell me for which language you want to add support. If no one else is already working on support for that language, you will be assigned as the maintainer for the language.
  2. Create a copy of translator_en.h and name it translator_\.h I'll use xx in the rest of this document.
  3. Add definition of the symbol for your language into lang_cfg.h: \verbatim #define LANG_xx \endverbatim Use capital letters for your \c xx (to be consistent). The \c lang_cfg.h defines which language translators will be compiled into doxygen executable. It is a kind of configuration file. If you are sure that you do not need some of the languages, you can remove (comment out) definitions of symbols for the languages, or you can say \c \#undef instead of \c \#define for them.
  4. Edit language.cpp: Add a \verbatim #ifdef LANG_xx #include #endif \endverbatim Remember to use the same symbol LANG_xx that you added to \c lang_cfg.h. I.e., the \c xx should be capital letters that identify your language. On the other hand, the \c xx inside your \c translator_xx.h should use lower case.

    Now, in setTranslator() add \verbatim #ifdef LANG_xx else if (L_EQUAL("your_language_name")) { theTranslator = new TranslatorYourLanguage; } #endif \endverbatim after the if { ... }. I.e., it must be placed after the code for creating the English translator at the beginning, and before the else { ... } part that creates the translator for the default language (English again).

  5. Edit libdoxygen.pro.in and add \c translator_xx.h to the \c HEADERS line.
  6. Edit translator_xx.h:
  7. Run configure and make again from the root of the distribution, in order to regenerated the Makefiles.
  8. Now you can use OUTPUT_LANGUAGE = your_language_name in the config file to generate output in your language.
  9. Send translator_xx.h to me so I can add it to doxygen. Send also your name and e-mail address to be included in the \c maintainers.txt list.

Maintaining a language

New versions of doxygen may use new translated sentences. In such situation, the \c Translator class requires implementation of new methods -- its interface changes. Of course, the English sentences need to be translated to the other languages. At least, new methods have to be implemented by the language-related translator class; otherwise, doxygen wouldn't even compile. Waiting until all language maintainers have translated the new sentences and sent the results would not be very practical. The following text describes the usage of translator adapters to solve the problem. The role of Translator Adapters. Whenever the \c Translator class interface changes in the new release, the new class \c TranslatorAdapter_x_y_z is added to the \c translator_adapter.h file (here x, y, and z are numbers that correspond to the current official version of doxygen). All translators that previously derived from the \c Translator class now derive from this adapter class. The \c TranslatorAdapter_x_y_z class implements the new, required methods. If the new method replaces some similar but obsolete method(s) (e.g. if the number of arguments changed and/or the functionality of the older method was changed or enriched), the \c TranslatorAdapter_x_y_z class may use the obsolete method to get the result which is as close as possible to the older result in the target language. If it is not possible, the result (the default translation) is obtained using the English translator, which is (by definition) always up-to-date. For example, when the new \c trFile() method with parameters (to determine the capitalization of the first letter and the singular/plural form) was introduced to replace the older method \c trFiles() without arguments, the following code appeared in one of the translator adapter classes: \verbatim /*! This is the default implementation of the obsolete method * used in the documentation of a group before the list of * links to documented files. This is possibly localized. */ virtual QCString trFiles() { return "Files"; } /*! This is the localized implementation of newer equivalent * using the obsolete method trFiles(). */ virtual QCString trFile(bool first_capital, bool singular) { if (first_capital && !singular) return trFiles(); // possibly localized, obsolete method else return english.trFile(first_capital, singular); } \endverbatim The \c trFiles() is not present in the \c TranslatorEnglish class, because it was removed as obsolete. However, it was used until now and its call was replaced by \verbatim trFile(true, false) \endverbatim in the doxygen source files. Probably, many language translators implemented the obsolete method, so it perfectly makes sense to use the same language dependent result in those cases. The \c TranslatorEnglish does not implement the old method. It derives from the abstract \c Translator class. On the other hand, the old translator for a different language does not implement the new \c trFile() method. Because of that it is derived from another base class -- \c TranslatorAdapter_x_y_z. The \c TranslatorAdapter_x_y_z class have to implement the new, required \c trFile() method. However, the translator adapter would not be compiled if the \c trFiles() method was not implemented. This is the reason for implementing the old method in the translator adapter class (using the same code, that was removed from the TranslatorEnglish). The simplest way would be to pass the arguments to the English translator and to return its result. Instead, the adapter uses the old \c trFiles() in one special case -- when the new trFile(true, false) is called. This is the mostly used case at the time of introducing the new method -- see above. While this may look too complicated, the technique allows the developers of the core sources to change the Translator interface, while the users may not even notice the change. Of course, when the new \c trFile() is used with different arguments, the English result is returned and it will be noticed by non English users. Here the maintainer of the language translator should implement at least that one particular method. What says the base class of a language translator? If the language translator class inherits from any adapter class the maintenance is needed. In such case, the language translator is not considered up-to-date. On the other hand, if the language translator derives directly from the abstract class \c Translator, the language translator is up-to-date. The translator adapter classes are chained so that the older translator adapter class uses the one-step-newer translator adapter as the base class. The newer adapter does less \e adapting work than the older one. The oldest adapter class derives (indirectly) from all of the adapter classes. The name of the adapter class is chosen so that its suffix is derived from the previous official version of doxygen that did not need the adapter. This way, one can say approximately, when the language translator class was last updated -- see details below. The newest translator adapter derives from the abstract \c TranslatorAdapterBase class that derives directly from the abstract \c Translator class. It adds only the private English-translator member for easy implementation of the default translation inside the adapter classes, and it also enforces implementation of one method for noticing the user that the language translation is not up-to-date (because of that some sentences in the generated files may appear in English). Once the oldest adapter class is not used by any of the language translators, it can be removed from the doxygen project. The maintainers should try to reach the state with the minimal number of translator adapter classes. To simplify the maintenance of the language translator classes for the supported languages, the \c translator.py Python script was developed (located in \c doxygen/doc directory). It extracts the important information about obsolete and new methods from the source files for each of the languages. The information is stored in the translator report ASCII file (translator_report.txt). \htmlonly If you compiled this documentation from sources and if you have also doxygen sources available the link doxygen/doc/translator_report.txt should be valid.\endhtmlonly Looking at the base class of the language translator, the script guesses also the status of the translator -- see the last column of the table with languages above. The \c translator.py is called automatically when the doxygen documentation is generated. You can also run the script manualy whenever you feel that it can help you. Of course, you are not forced to use the results of the script. You can find the same information by looking at the adapter class and its base classes. How should I update my language translator? Firstly, you should be the language maintainer, or you should let him/her know about the changes. The following text was written for the language maintainers as the primary audience. There are several approaches to be taken when updating your language. If you are not extremely busy, you should always chose the most radical one. When the update takes much more time than you expected, you can always decide use some suitable translator adapter to finish the changes later and still make your translator working. The most radical way of updating the language translator is to make your translator class derive directly from the abstract class \c Translator and provide translations for the methods that are required to be implemented -- the compiler will tell you if you forgot to implement some of them. If you are in doubt, have a look at the \c TranslatorEnglish class to recognize the purpose of the implemented method. Looking at the previously used adapter class may help you sometimes, but it can also be misleading because the adapter classes do implement also the obsolete methods (see the previous \c trFiles() example). In other words, the up-to-date language translators do not need the \c TranslatorAdapter_x_y_z classes at all, and you do not need to implement anything else than the methods required by the Translator class (i.e. the pure virtual methods of the \c Translator -- they end with =0;). If everything compiles fine, try to run \c translator.py, and have a look at the translator report (ASCII file) at the \c doxygen/doc directory. Even if your translator is marked as up-to-date, there still may be some remarks related to your souce code. Namely, the obsolete methods--that are not used at all--may be listed in the section for your language. Simply, remove their code (and run the \c translator.py again). Also, you will be informed when you forgot to change the base class of your translator class to some newer adapter class or directly to the Translator class. If you do not have time to finish all the updates you should still start with the most radical approach as described above. You can always change the base class to the translator adapter class that implements all of the not-yet-implemented methods. If you prefer to update your translator gradually, have a look at \c TranslatorEnglish (the \c translator_en.h file). Inside, you will find the comments like new since 1.2.4 that separate always a number of methods that were implemented in the stated version. Do implement the group of methods that are placed below the comment that uses the same version numbers as your translator adapter class. (For example, your translator class have to use the \c TranslatorAdapter_1_2_4, if it does not implement the methods below the comment new since 1.2.4. When you implement them, your class should use newer translator adapter. Run the \c translator.py script occasionaly and give it your \c xx identification (from \c translator_xx.h) to create the translator report shorter (also produced faster) -- it will contain only the information related to your translator. Once you reach the state when the base class should be changed to some newer adapter, you will see the note in the translator report. Warning: Don't forget to compile Doxygen to discover, whether it is compilable. The \c translator.py does not check if everything is correct with respect to the compiler. Because of that, it may lie sometimes about the necessary base class. The most obsolete language translators would lead to implementation of too complicated adapters. Because of that, doxygen developers may decide to derive such translators from the \c TranslatorEnglish class, which is by definition always up-to-date. When doing so, all the missing methods will be replaced by the English translation. This means that not-implemented methods will always return the English result. Such translators are marked using word \c obsolete. You should read it really obsolete. No guess about the last update can be done. Often, it is possible to construct better result from the obsolete methods. Because of that, the translator adapter classes should be used if possible. On the other hand, implementation of adapters for really obsolete translators brings too much maintenance and run-time overhead. */