CMake.git - CMake is a cross-platform, open-source build system generator.

diff options

Diffstat (limited to 'Help/guide/tutorial/Step3/TutorialConfig.h.in')

0 files changed, 0 insertions, 0 deletions

/****************************************************************************** * Do not edit this file. It was generated by the translator.py script. * * Copyright (C) 1997-2011 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 <h3>Support for multiple languages</h3> 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.8.1.2), 39 languages are supported (sorted alphabetically): Afrikaans, Arabic, Armenian, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Finnish, French, German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean (+En), Lithuanian, Macedonian, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese.. 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 <table align="center" cellspacing="0" cellpadding="0" border="0"> <tr bgcolor="#000000"> <td> <table cellspacing="1" cellpadding="2" border="0"> <tr bgcolor="#4040c0"> <td > Language </td> <td > Maintainer </td> <td > Contact address (replace the at and dot)</td> <td > Status </td> </tr>  <tr bgcolor="#ffffff"> <td>Afrikaans</td> <td>Johan Prinsloo</td> <td>johan at zippysnoek dot com</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>Arabic</td> <td>Moaz Reyad -- searching for the maintainer --</td> <td>[resigned] [Please, try to help to find someone.]</td> <td>1.4.6</td> </tr> <tr bgcolor="#ffffff"> <td>Armenian</td> <td>Armen Tangamyan</td> <td>armen dot tangamyan at anu dot edu dot au</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>Brazilian Portuguese</td> <td>Fabio "FJTC" Jun Takada Chino</td> <td>jun-chino at uol dot com dot br</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>Catalan</td> <td>Maximiliano Pin Albert Mora</td> <td>max dot pin at bitroit dot com [unreachable]</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>Chinese</td> <td>Lian Yang Li Daobing Wei Liu</td> <td>lian dot yang dot cn at gmail dot com lidaobing at gmail dot com liuwei at asiainfo dot com</td> <td>1.8.2</td> </tr> <tr bgcolor="#ffffff"> <td>Chinese Traditional</td> <td>Daniel YC Lin Gary Lee</td> <td>dlin dot tw at gmail dot com garywlee at gmail dot com</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>Croatian</td> <td>Boris Bralo</td> <td>boris dot bralo at gmail dot com</td> <td>1.8.2</td> </tr> <tr bgcolor="#ffffff"> <td>Czech</td> <td>Petr Přikryl</td> <td>prikryl at atlas dot cz</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Danish</td> <td>Poul-Erik Hansen Erik Søe Sørensen</td> <td>pouhan at gnotometrics dot dk eriksoe+doxygen at daimi dot au dot dk</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>Dutch</td> <td>Dimitri van Heesch</td> <td>dimitri at stack dot nl</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>English</td> <td>Dimitri van Heesch</td> <td>dimitri at stack dot nl</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Esperanto</td> <td>Ander Martínez</td> <td>ander dot basaundi at gmail dot com</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Finnish</td> <td>Antti Laine</td> <td>antti dot a dot laine at tut dot fi</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>French</td> <td>David Martinet Xavier Outhier</td> <td>contact at e-concept-applications dot fr xouthier at yahoo dot fr</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>German</td> <td>Peter Grotrian Jens Seidel</td> <td>Peter dot Grotrian at pdv-FS dot de jensseidel at users dot sf dot net</td> <td>1.8.2</td> </tr> <tr bgcolor="#ffffff"> <td>Greek</td> <td>Paul Gessos</td> <td>gessos dot paul at yahoo dot gr</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Hungarian</td> <td>Ákos Kiss Földvári György</td> <td>akiss at users dot sourceforge dot net [unreachable]</td> <td>1.4.6</td> </tr> <tr bgcolor="#ffffff"> <td>Indonesian</td> <td>Hendy Irawan</td> <td>ceefour at gauldong dot net</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>Italian</td> <td>Alessandro Falappa Ahmed Aldo Faisal</td> <td>alessandro at falappa dot net aaf23 at cam dot ac dot uk</td> <td>1.8.2</td> </tr> <tr bgcolor="#ffffff"> <td>Japanese</td> <td>Hiroki Iseri Ryunosuke Satoh Kenji Nagamatsu Iwasa Kazmi</td> <td>goyoki at gmail dot com sun594 at hotmail dot com naga at joyful dot club dot ne dot jp [unreachable]</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>JapaneseEn</td> <td>see the Japanese language</td> <td> </td> <td>English based</td> </tr> <tr bgcolor="#ffffff"> <td>Korean</td> <td>Kim Taedong SooYoung Jung Richard Kim</td> <td>fly1004 at gmail dot com jung5000 at gmail dot com [unreachable]</td> <td>1.8.02</td> </tr> <tr bgcolor="#ffffff"> <td>KoreanEn</td> <td>see the Korean language</td> <td> </td> <td>English based</td> </tr> <tr bgcolor="#ffffff"> <td>Lithuanian</td> <td>Tomas Simonaitis Mindaugas Radzius Aidas Berukstis -- searching for the maintainer --</td> <td>[unreachable] [unreachable] [unreachable] [Please, try to help to find someone.]</td> <td>1.4.6</td> </tr> <tr bgcolor="#ffffff"> <td>Macedonian</td> <td>Slave Jovanovski</td> <td>slavejovanovski at yahoo dot com</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>Norwegian</td> <td>Lars Erik Jordet</td> <td>lejordet at gmail dot com</td> <td>1.4.6</td> </tr> <tr bgcolor="#ffffff"> <td>Persian</td> <td>Ali Nadalizadeh</td> <td>nadalizadeh at gmail dot com</td> <td>1.7.5</td> </tr> <tr bgcolor="#ffffff"> <td>Polish</td> <td>Piotr Kaminski Grzegorz Kowal Krzysztof Kral</td> <td>[unreachable] [unreachable] krzysztof dot kral at gmail dot com</td> <td>1.8.2</td> </tr> <tr bgcolor="#ffffff"> <td>Portuguese</td> <td>Rui Godinho Lopes Fabio "FJTC" Jun Takada Chino</td> <td>[resigned] jun-chino at uol dot com dot br</td> <td>1.8.0</td> </tr> <tr bgcolor="#ffffff"> <td>Romanian</td> <td>Ionut Dumitrascu Alexandru Iosup</td> <td>reddumy at yahoo dot com aiosup at yahoo dot com</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>Russian</td> <td>Alexandr Chelpanov</td> <td>cav at cryptopro dot ru</td> <td>1.7.5</td> </tr> <tr bgcolor="#ffffff"> <td>Serbian</td> <td>Dejan Milosavljevic</td> <td>[unreachable]</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>SerbianCyrilic</td> <td>Nedeljko Stefanovic</td> <td>stenedjo at yahoo dot com</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>Slovak</td> <td>Kali+Laco Švec Petr Přikryl</td> <td>[the Slovak language advisors] prikryl at atlas dot cz</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Slovene</td> <td>Matjaž Ostroveršnik</td> <td>matjaz dot ostroversnik at ostri dot org</td> <td>1.4.6</td> </tr> <tr bgcolor="#ffffff"> <td>Spanish</td> <td>Bartomeu Francisco Oltra Thennet David Vaquero</td> <td>bartomeu at loteria3cornella dot com [unreachable] david at grupoikusnet dot com</td> <td>up-to-date</td> </tr> <tr bgcolor="#ffffff"> <td>Swedish</td> <td>Mikael Hallin</td> <td>mikaelhallin at yahoo dot se</td> <td>1.6.0</td> </tr> <tr bgcolor="#ffffff"> <td>Turkish</td> <td>Emin Ilker Cetinbas</td> <td>niw3 at yahoo dot com</td> <td>1.7.5</td> </tr> <tr bgcolor="#ffffff"> <td>Ukrainian</td> <td>Olexij Tkatchenko -- searching for the maintainer --</td> <td>[resigned] [Please, try to help to find someone.]</td> <td>1.4.1</td> </tr> <tr bgcolor="#ffffff"> <td>Vietnamese</td> <td>Dang Minh Tuan</td> <td>tuanvietkey at gmail dot com</td> <td>1.6.0</td> </tr>  </table> </td> </tr> </table> \endhtmlonly \latexonly \footnotesize \begin{longtable}{|l|l|l|l|} \hline {\bf Language} & {\bf Maintainer} & {\bf Contact address} & {\bf Status} \\ \hline \hline Afrikaans & Johan Prinsloo & {\tt\tiny johan at zippysnoek dot com} & 1.6.0 \\ \hline Arabic & Moaz Reyad & {\tt\tiny [resigned] moazreyad at yahoo dot com} & 1.4.6 \\ ~ & -- searching for the maintainer -- & {\tt\tiny [Please, try to help to find someone.]} & ~ \\ \hline Armenian & Armen Tangamyan & {\tt\tiny armen dot tangamyan at anu dot edu dot au} & 1.8.0 \\ \hline Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino at uol dot com dot br} & 1.8.0 \\ \hline Catalan & Maximiliano Pin & {\tt\tiny max dot pin at bitroit dot com} & 1.8.0 \\ ~ & Albert Mora & {\tt\tiny [unreachable] amora at iua dot upf dot es} & ~ \\ \hline Chinese & Lian Yang & {\tt\tiny lian dot yang dot cn at gmail dot com} & 1.8.2 \\ ~ & Li Daobing & {\tt\tiny lidaobing at gmail dot com} & ~ \\ ~ & Wei Liu & {\tt\tiny liuwei at asiainfo dot com} & ~ \\ \hline Chinese Traditional & Daniel YC Lin & {\tt\tiny dlin dot tw at gmail dot com} & 1.8.0 \\ ~ & Gary Lee & {\tt\tiny garywlee at gmail dot com} & ~ \\ \hline Croatian & Boris Bralo & {\tt\tiny boris dot bralo at gmail dot com} & 1.8.2 \\ \hline Czech & Petr Přikryl & {\tt\tiny prikryl at atlas dot cz} & up-to-date \\ \hline Danish & Poul-Erik Hansen & {\tt\tiny pouhan at gnotometrics dot dk} & 1.8.0 \\ ~ & Erik Søe Sørensen & {\tt\tiny eriksoe+doxygen at daimi dot au dot dk} & ~ \\ \hline Dutch & Dimitri van Heesch & {\tt\tiny dimitri at stack dot nl} & up-to-date \\ \hline English & Dimitri van Heesch & {\tt\tiny dimitri at stack dot nl} & up-to-date \\ \hline Esperanto & Ander Martínez & {\tt\tiny ander dot basaundi at gmail dot com} & up-to-date \\ \hline Finnish & Antti Laine & {\tt\tiny antti dot a dot laine at tut dot fi} & 1.6.0 \\ \hline French & David Martinet & {\tt\tiny contact at e-concept-applications dot fr} & 1.8.0 \\ ~ & Xavier Outhier & {\tt\tiny xouthier at yahoo dot fr} & ~ \\ \hline German & Peter Grotrian & {\tt\tiny Peter dot Grotrian at pdv-FS dot de} & 1.8.2 \\ ~ & Jens Seidel & {\tt\tiny jensseidel at users dot sf dot net} & ~ \\ \hline Greek & Paul Gessos & {\tt\tiny gessos dot paul at yahoo dot gr} & up-to-date \\ \hline Hungarian & Ákos Kiss & {\tt\tiny akiss at users dot sourceforge dot net} & 1.4.6 \\ ~ & Földvári György & {\tt\tiny [unreachable] foldvari lost at cyberspace} & ~ \\ \hline Indonesian & Hendy Irawan & {\tt\tiny ceefour at gauldong dot net} & 1.8.0 \\ \hline Italian & Alessandro Falappa & {\tt\tiny alessandro at falappa dot net} & 1.8.2 \\ ~ & Ahmed Aldo Faisal & {\tt\tiny aaf23 at cam dot ac dot uk} & ~ \\ \hline Japanese & Hiroki Iseri & {\tt\tiny goyoki at gmail dot com} & 1.6.0 \\ ~ & Ryunosuke Satoh & {\tt\tiny sun594 at hotmail dot com} & ~ \\ ~ & Kenji Nagamatsu & {\tt\tiny naga at joyful dot club dot ne dot jp} & ~ \\ ~ & Iwasa Kazmi & {\tt\tiny [unreachable] iwasa at cosmo-system dot jp} & ~ \\ \hline JapaneseEn & see the Japanese language & {\tt\tiny ~} & English based \\ \hline Korean & Kim Taedong & {\tt\tiny fly1004 at gmail dot com} & 1.8.02 \\ ~ & SooYoung Jung & {\tt\tiny jung5000 at gmail dot com} & ~ \\ ~ & Richard Kim & {\tt\tiny [unreachable] ryk at dspwiz dot com} & ~ \\ \hline KoreanEn & see the Korean language & {\tt\tiny ~} & English based \\ \hline Lithuanian & Tomas Simonaitis & {\tt\tiny [unreachable] haden at homelan dot lt} & 1.4.6 \\ ~ & Mindaugas Radzius & {\tt\tiny [unreachable] mindaugasradzius at takas dot lt} & ~ \\ ~ & Aidas Berukstis & {\tt\tiny [unreachable] aidasber at takas dot lt} & ~ \\ ~ & -- searching for the maintainer -- & {\tt\tiny [Please, try to help to find someone.]} & ~ \\ \hline Macedonian & Slave Jovanovski & {\tt\tiny slavejovanovski at yahoo dot com} & 1.6.0 \\ \hline Norwegian & Lars Erik Jordet & {\tt\tiny lejordet at gmail dot com} & 1.4.6 \\ \hline Persian & Ali Nadalizadeh & {\tt\tiny nadalizadeh at gmail dot com} & 1.7.5 \\ \hline Polish & Piotr Kaminski & {\tt\tiny [unreachable] Piotr dot Kaminski at ctm dot gdynia dot pl} & 1.8.2 \\ ~ & Grzegorz Kowal & {\tt\tiny [unreachable] g\_kowal at poczta dot onet dot pl} & ~ \\ ~ & Krzysztof Kral & {\tt\tiny krzysztof dot kral at gmail dot com} & ~ \\ \hline Portuguese & Rui Godinho Lopes & {\tt\tiny [resigned] rgl at ruilopes dot com} & 1.8.0 \\ ~ & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino at uol dot com dot br} & ~ \\ \hline Romanian & Ionut Dumitrascu & {\tt\tiny reddumy at yahoo dot com} & 1.6.0 \\ ~ & Alexandru Iosup & {\tt\tiny aiosup at yahoo dot com} & ~ \\ \hline Russian & Alexandr Chelpanov & {\tt\tiny cav at cryptopro dot ru} & 1.7.5 \\ \hline Serbian & Dejan Milosavljevic & {\tt\tiny [unreachable] dmilos at email dot com} & 1.6.0 \\ \hline SerbianCyrilic & Nedeljko Stefanovic & {\tt\tiny stenedjo at yahoo dot com} & 1.6.0 \\ \hline Slovak & Kali+Laco Švec & {\tt\tiny [the Slovak language advisors]} & up-to-date \\ ~ & Petr Přikryl & {\tt\tiny prikryl at atlas dot cz} & ~ \\ \hline Slovene & Matjaž Ostroveršnik & {\tt\tiny matjaz dot ostroversnik at ostri dot org} & 1.4.6 \\ \hline Spanish & Bartomeu & {\tt\tiny bartomeu at loteria3cornella dot com} & up-to-date \\ ~ & Francisco Oltra Thennet & {\tt\tiny [unreachable] foltra at puc dot cl} & ~ \\ ~ & David Vaquero & {\tt\tiny david at grupoikusnet dot com} & ~ \\ \hline Swedish & Mikael Hallin & {\tt\tiny mikaelhallin at yahoo dot se} & 1.6.0 \\ \hline Turkish & Emin Ilker Cetinbas & {\tt\tiny niw3 at yahoo dot com} & 1.7.5 \\ \hline Ukrainian & Olexij Tkatchenko & {\tt\tiny [resigned] olexij at tkatchenko dot com} & 1.4.1 \\ ~ & -- searching for the maintainer -- & {\tt\tiny [Please, try to help to find someone.]} & ~ \\ \hline Vietnamese & Dang Minh Tuan & {\tt\tiny tuanvietkey at gmail dot com} & 1.6.0 \\ \hline \end{longtable} \normalsize \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. <h3>Adding a new language to doxygen</h3> This short HOWTO explains how to add support for the new language to Doxygen: Just follow these steps: <ol> <li>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. <li>Create a copy of translator_en.h and name it translator_\<your_2_letter_country_code\>.h I'll use xx in the rest of this document. <li>Add definition of the symbol for your language in the configure at two places in the script: <ol> <li>After the <code>f_langs=</code> is statement, in lower case. <li>In the string that following <code>\@allowed=</code> in upper case. </ol> The rerun the configure script such that is generates src/lang_cfg.h. This file should now contain a \#define for your language code. <li>Edit language.cpp: Add a \verbatim #ifdef LANG_xx #include<translator_xx.h> #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 <code>setTranslator()</code> add \verbatim #ifdef LANG_xx else if (L_EQUAL("your_language_name")) { theTranslator = new TranslatorYourLanguage; } #endif \endverbatim after the <code>if { ... }</code>. I.e., it must be placed after the code for creating the English translator at the beginning, and before the <code>else { ... }</code> part that creates the translator for the default language (English again). <li>Edit libdoxygen.pro.in and add \c translator_xx.h to the \c HEADERS line. <li>Edit <code>translator_xx.h</code>: <ul> <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at the beginning of the file). <li>Rename TranslatorEnglish to TranslatorYourLanguage <li>In the member <code>idLanguage()</code> change "english" into the name of your language (use lower case characters only). Depending on the language you may also wish to change the member functions latexLanguageSupportCommand(), idLanguageCharset() and others (you will recognize them when you start the work). <li>Edit all the strings that are returned by the member functions that start with tr. Try to match punctuation and capitals! To enter special characters (with accents) you can: <ul> <li> Enter them directly if your keyboard supports that and you are using a Latin-1 font. Doxygen will translate the characters to proper \f$\mbox{\LaTeX}\f$ and leave the HTML and man output for what it is (which is fine, if idLanguageCharset() is set correctly). <li> Use html codes like \ä for an a with an umlaut (i.e. ä). See the HTML specification for the codes. </ul> </ul> <li>Run configure and make again from the root of the distribution, in order to regenerated the Makefiles. <li>Now you can use <code>OUTPUT_LANGUAGE = your_language_name</code> in the config file to generate output in your language. <li>Send <code>translator_xx.h</code> 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. </ol> <h3>Maintaining a language</h3> 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 <code>trFile(true, false)</code> 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 <a href="../doc/translator_report.txt" ><code>doxygen/doc/translator_report.txt</code></a> 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 manually 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 <code>=0;</code>). 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 source 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 <code>new since 1.2.4</code> 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 <code>new since 1.2.4</code>. When you implement them, your class should use newer translator adapter. Run the \c translator.py script occasionally 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. */


context:
space:
mode: