home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / doxg1211.zip / doxygen.zip / LANGUAGE.HOWTO < prev    next >
Text File  |  2001-07-25  |  2KB  |  50 lines
  1. This short howto explains how to add support for a new language to Doxygen:
  2.  
  3. Just follow these steps:
  4.  
  5. 1) Tell me for which language you want to add support. If no one else
  6.    is already working on support for that language, you will be 
  7.    assigned as the maintainer for the language. I'll create a 
  8.    list on Doxygen's homepage, so everyone knows who is doing what.
  9. 2) Create a copy of translator_en.h and name it 
  10.    translator_<your_2_letter_counter_code>.h
  11.    I'll use xx in the rest of this document.
  12. 3) Edit language.cpp:
  13.    - Add a #include<translator_xx.h> 
  14.    - In setTranslator() add
  15.      
  16.      else if (L_EQUAL("your_language_name"))
  17.      {
  18.        theTranslator = new TranslatorYourLanguage;
  19.      }
  20.    
  21.      after the if { ... }
  22. 4) Edit libdoxygen.pro.in and add translator_xx.h to the HEADERS line.
  23. 5) Edit translator_xx.h:
  24.    - Rename TRANSLATOR_EN_H to TRANSLATOR_XX_H twice.
  25.    - Rename TranslatorEnglish to TranslatorYourLanguage 
  26.    - In the member idLanguage() change "english" into the name of your
  27.      language (use lower case characters only). Depending on the language you
  28.      may also wish to change the member functions latexLanguageSupportCommand()
  29.      and idLanguageCharset().
  30.    - Edit all the strings that are returned by the members that start
  31.      with tr. Try to match punctuation and capitals!
  32.      To enter special characters (with accents) you can:
  33.         a) Enter them directly if your keyboard supports that and you are 
  34.            using a Latin-1 font.
  35.            Doxygen will translate the characters to proper Latex and
  36.            leave the Html and man output for what it is (which is fine, if
  37.            idLanguageCharset() is set correctly).
  38.         b) Use html codes like ä for an a with an umlaut (i.e. Σ).
  39.            See the HTML specification for the codes.
  40. 6) Run configure and make again from the root of the distribution, 
  41.    in order to regenerate the Makefiles.
  42. 7) Now you can use OUTPUT_LANGUAGE = your_language_name 
  43.    in the config file to generate output in your language.
  44. 8) Send translator_xx.h to me so I can add it to doxygen.
  45.    Send also your name and e-mail address to be included in the
  46.    maintainers.txt list.
  47.  
  48. Good luck, and let me know if there are problems.
  49.  
  50.