[Doxygen-develop] (i18n) Notice for doxygen language maintainers

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Hi,

As new CVS version of doxygen was released by Dimitri (20010723),
I would like to remind all the language maintainers the changes of the
TranslatorXxxx classes design and what are the consequences
and advantages for you as for the language maintainers.

The primary purpose of the design changes was to make the maintenance
of languages less dependent on the doxygen core development.  Using
translator-adapter classes helps to introduce changes of the Translator
class interface used by the core.  (The translator adapter classed appeared
firstly in 1.2.6-xxxx CVS version and in the official release 1.2.7.)

The second goal was to make the language maintenance easier and
the status of the language support more visible.  The translator adapter
classes were designed so, that it is possible to extract the information
about when your language support was last updated (i.e. version of 
doxygen).

Please, try to update your language.  Users will be happy.  If you do not
have time to update it (everyone will understand that you may have
good reasons for not having time), let it know publicly and try to search
for another language maintainer.

You should read http://www.stack.nl/~dimitri/doxygen/langhowto.html
document which is now generated from sources and document templates.
It contains the table that shows the status (doxygen version) of your
language
support.  It also contains new information about "How to add new language
to doxygen" and "How to maintain a language".  The later is probably
more important for you.  It explains how things with translator adapter
classes
work and recommends what you should do to update your TranslatorXxxx class.

(Note, that you may get newer version of the documentation when you
generate the documentation from your own souces.  Dimitri may have reasons
not to update the on-line documentation for each CVS release ;-)

Notice: if your TranslatorXxxx class is very old (a lot of things changed), 
you may prefer to implement it from scratch (by copying the
TranslatorEnglish
and translating the texts again).  This could be the case of the language 
support last updated for doxygen 1.0.x or 1.1.x.

If in doubt what some of the methods should do, have a look at the
translator_en.h
which (by definition) is always up-to-date, and which contains fresh
comments.

The translator.pl was created to help you with maintenance.  It is called
automatically when the doxygen documentation is generated
(doxygen/doc/Makefile).
You can also run it manually (doxygen/doc/translator.pl).  The Windows users
may use the doxygen/doc/translator.bat for running the script. Perl of 5.005
or higher version is required.

The translator.pl basically helps to generate doxygen's documentation 
(the language.doc file). But, for the language maintainers, it generates
also 
the translator_report.txt ASCII file.

ATTENTION!

The doxygen/doc/translator_report.txt contains some information that cannot
be found on other places.  Being the language maintainer, you should not
stop to
read it as soon as you see that your translator is up-to-date.  The file may
still list
some details for your translator class below.

The most usual case is that the up-to-date translator still contains 
the implementation of methods that are not used by the doxygen core any
more.
They are marked as obsolete methods, and the code should be removed from
your translator_xx.h (it is never used).

Note, that the translator_report.txt is generated automatically from source.
If you find something wrong in it, please, let me know.

Here is the content of the translator_report.txt file -- generated from 
doxygen 1.2.8-20010723.

With regards,
  Petr

=============================================================
Doxygen supports the following (24) languages (sorted alphabetically):

  Brazilian
  Chinese
  Croatian
  Czech
  Danish
  Dutch
  English
  Finnish
  French
  German
  Hungarian
  Italian
  Japanese
  Korean
  Norwegian
  Polish
  Portuguese
  Romanian
  Russian
  Slovak
  Slovene
  Spanish
  Swedish
  Ukrainian

----------------------------------------------------------------------
The following translator classes are up-to-date (sorted alphabetically).
This means that they derive from the Translator class.  If the translator
derives from TranslatorAdapterCVS, it is considered to be almost up-to-date.
In other words, it is newer than the last official release.  Anyway, there
still may be some details listed even for the up-to-date translators.
Please, check the text below.

  TranslatorBrazilian
  TranslatorCroatian
  TranslatorCzech
  TranslatorDutch
  TranslatorEnglish
  TranslatorFrench
  TranslatorGerman
  TranslatorPortuguese
  TranslatorRussian
  TranslatorUkrainian

----------------------------------------------------------------------
The following translator classes are obsolete (sorted alphabetically).
This means that they derive from some of the adapter classes.

  TranslatorChinese     (TranslatorAdapter_1_2_1)
  TranslatorDanish      (TranslatorAdapter_1_2_7)
  TranslatorFinnish     (TranslatorAdapter_1_0_0)
  TranslatorHungarian   (TranslatorAdapter_1_2_1)
  TranslatorItalian     (TranslatorAdapter_1_2_7)
  TranslatorJapanese    (TranslatorAdapter_1_2_5)
  TranslatorKorean      (TranslatorAdapter_1_1_0)
  TranslatorNorwegian   (TranslatorAdapter_1_2_2)
  TranslatorPolish      (TranslatorAdapter_1_2_1)
  TranslatorRomanian    (TranslatorAdapter_1_2_1)
  TranslatorSlovak      (TranslatorAdapter_1_2_7)
  TranslatorSlovene     (TranslatorAdapter_1_1_5)
  TranslatorSpanish     (TranslatorAdapter_1_2_7)
  TranslatorSwedish     (TranslatorAdapter_1_0_0)

----------------------------------------------------------------------
Localized translators are expected to implement the following methods
(prototypes sorted aplhabetically):

QCString idLanguage()
QCString idLanguageCharset()
QCString latexLanguageSupportCommand()
QCString trAlphabeticalList()
QCString trAttention()
QCString trAuthor(bool first_capital, bool singular)
QCString trBug()
QCString trBugList()
QCString trBugsAndLimitations()
QCString trClass(bool first_capital, bool singular)
QCString trClassDiagram(const char *clName)
QCString trClassDocumentation()
QCString trClassHierarchy()
QCString trClassHierarchyDescription()
QCString trClasses()
QCString trCode()
QCString trCollaborationDiagram(const char *clName)
QCString trCompoundIndex()
QCString trCompoundList()
QCString trCompoundListDescription()
QCString trCompoundMembers()
QCString trCompoundMembersDescription(bool extractAll)
QCString trCompoundReference(const char *clName, ClassDef::CompoundType
compType, bool isTemplate)
QCString trCompounds()
QCString trConstructorDocumentation()
QCString trDCOPMethods()
QCString trDate()
QCString trDefineDocumentation()
QCString trDefineValue()
QCString trDefinedAtLineInSourceFile()
QCString trDefinedIn()
QCString trDefinedInSourceFile()
QCString trDefines()
QCString trDeprecated()
QCString trDetailedDescription()
QCString trDocumentation()
QCString trEnumName()
QCString trEnumValue()
QCString trEnumerationTypeDocumentation()
QCString trEnumerationValueDocumentation()
QCString trEnumerationValues()
QCString trEnumerations()
QCString trExampleDocumentation()
QCString trExamples()
QCString trExamplesDescription()
QCString trExceptions()
QCString trField(bool first_capital, bool singular)
QCString trFile(bool first_capital, bool singular)
QCString trFileDocumentation()
QCString trFileIndex()
QCString trFileList()
QCString trFileListDescription(bool extractAll)
QCString trFileMembers()
QCString trFileMembersDescription(bool extractAll)
QCString trFileReference(const char *fileName)
QCString trForInternalUseOnly()
QCString trFriends()
QCString trFuncProtos()
QCString trFunctionDocumentation()
QCString trFunctionPrototypeDocumentation()
QCString trFunctions()
QCString trGeneratedAt(const char *date,const char *projName)
QCString trGeneratedAutomatically(const char *s)
QCString trGeneratedBy()
QCString trGeneratedFromFiles(ClassDef::CompoundType compType, bool single)
QCString trGlobal(bool first_capital, bool singular)
QCString trGotoDocumentation()
QCString trGotoGraphicalHierarchy()
QCString trGotoSourceCode()
QCString trGotoTextualHierarchy()
QCString trGraphicalHierarchy()
QCString trGroup(bool first_capital, bool singular)
QCString trHeaderFiles()
QCString trHeaderFilesDescription()
QCString trHierarchicalIndex()
QCString trInclByDepGraph()
QCString trInclDepGraph(const char *fName)
QCString trIncludingInheritedMembers()
QCString trInheritedByList(int numEntries)
QCString trInheritsList(int numEntries)
QCString trInitialValue()
QCString trInterfaces()
QCString trInvariant()
QCString trLegend()
QCString trLegendDocs()
QCString trLegendTitle()
QCString trListOfAllMembers()
QCString trMainPage()
QCString trMember(bool first_capital, bool singular)
QCString trMemberDataDocumentation()
QCString trMemberEnumerationDocumentation()
QCString trMemberFunctionDocumentation()
QCString trMemberList()
QCString trMemberTypedefDocumentation()
QCString trModuleDocumentation()
QCString trModuleIndex()
QCString trModules()
QCString trModulesDescription()
QCString trMore()
QCString trNamespace(bool first_capital, bool singular)
QCString trNamespaceDocumentation()
QCString trNamespaceIndex()
QCString trNamespaceList()
QCString trNamespaceListDescription(bool extractAll)
QCString trNamespaceMemberDescription(bool extractAll)
QCString trNamespaceMembers()
QCString trNamespaceReference(const char *namespaceName)
QCString trNamespaces()
QCString trNoDescriptionAvailable()
QCString trNote()
QCString trPackage(const char *name)
QCString trPackageDocumentation()
QCString trPackageList()
QCString trPackageListDescription()
QCString trPackages()
QCString trPage(bool first_capital, bool singular)
QCString trPageAbbreviation()
QCString trPageDocumentation()
QCString trPageIndex()
QCString trParameters()
QCString trPostcondition()
QCString trPrecondition()
QCString trPrivateAttribs()
QCString trPrivateMembers()
QCString trPrivateSlots()
QCString trPrivateTypes()
QCString trProperties()
QCString trPropertyDocumentation()
QCString trProtectedAttribs()
QCString trProtectedMembers()
QCString trProtectedSlots()
QCString trProtectedTypes()
QCString trPublicAttribs()
QCString trPublicMembers()
QCString trPublicSlots()
QCString trPublicTypes()
QCString trRTFCharSet()
QCString trRTFGeneralIndex()
QCString trRTFansicp()
QCString trReferenceManual()
QCString trReferencedBy()
QCString trReimplementedForInternalReasons()
QCString trReimplementedFromList(int numEntries)
QCString trReimplementedInList(int numEntries)
QCString trRelatedFunctionDocumentation()
QCString trRelatedFunctions()
QCString trRelatedPages()
QCString trRelatedPagesDescription()
QCString trRelatedSubscript()
QCString trRemarks()
QCString trReturnValues()
QCString trReturns()
QCString trSearch()
QCString trSeeAlso()
QCString trSignals()
QCString trSince()
QCString trSources()
QCString trStaticPrivateAttribs()
QCString trStaticPrivateMembers()
QCString trStaticProtectedAttribs()
QCString trStaticProtectedMembers()
QCString trStaticPublicAttribs()
QCString trStaticPublicMembers()
QCString trTest()
QCString trTestList()
QCString trThisIsTheListOfAllMembers()
QCString trTodo()
QCString trTodoList()
QCString trTypedefDocumentation()
QCString trTypedefs()
QCString trVariableDocumentation()
QCString trVariables()
QCString trVersion()
QCString trWarning()
QCString trWriteList(int numEntries)
QCString trWrittenBy()

======================================================================
Details related to specific translator classes follow.

TranslatorBrazilian (Translator)
-------------------