|
Packit |
1c1d7e |
This short howto explains how to add support for a new language to Doxygen:
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Just follow these steps:
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
1) Tell me which language you want to add support for. If no one else
|
|
Packit |
1c1d7e |
is already working on support for that language, you will be
|
|
Packit |
1c1d7e |
assigned as the maintainer for the language. I'll create a
|
|
Packit |
1c1d7e |
list on Doxygen's homepage, so everyone knows who is doing what.
|
|
Packit |
1c1d7e |
2) Create a copy of translator_en.h and name it
|
|
Packit |
1c1d7e |
translator_<your_2_letter_country_code>.h
|
|
Packit |
1c1d7e |
I'll use xx in the rest of this document.
|
|
Packit |
1c1d7e |
3) Edit language.cpp:
|
|
Packit |
1c1d7e |
- Add a #include<translator_xx.h>
|
|
Packit |
1c1d7e |
- In setTranslator() add
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
else if (L_EQUAL("your_language_name"))
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
theTranslator = new TranslatorYourLanguage;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
after the if { ... }
|
|
Packit |
1c1d7e |
4) Edit libdoxygen.pro.in and add translator_xx.h to the HEADERS line.
|
|
Packit |
1c1d7e |
5) Edit translator_xx.h:
|
|
Packit |
1c1d7e |
- Change TRANSLATOR_EN_H to TRANSLATOR_XX_H (in both the #include line and
|
|
Packit |
1c1d7e |
the #define line).
|
|
Packit |
1c1d7e |
- Change TranslatorEnglish to TranslatorYourLanguage
|
|
Packit |
1c1d7e |
- In the member idLanguage() change "english" into the name of your
|
|
Packit |
1c1d7e |
language (use lower case characters only). Depending on the language you
|
|
Packit |
1c1d7e |
may also wish to change the member functions latexLanguageSupportCommand()
|
|
Packit |
1c1d7e |
and idLanguageCharset().
|
|
Packit |
1c1d7e |
- Edit all the strings that are returned by the members that start
|
|
Packit |
1c1d7e |
with tr. Try to match punctuation and capitals!
|
|
Packit |
1c1d7e |
To enter special characters (with accents) you can:
|
|
Packit |
1c1d7e |
a) Enter them directly if your keyboard supports that and you are
|
|
Packit |
1c1d7e |
using a Latin-1 font.
|
|
Packit |
1c1d7e |
Doxygen will translate the characters to proper Latex and
|
|
Packit |
1c1d7e |
leave the Html and man output for what it is (which is fine, if
|
|
Packit |
1c1d7e |
idLanguageCharset() is set correctly).
|
|
Packit Service |
3495b5 |
b) Use html codes like ä for an a with an umlaut (i.e. รค).
|
|
Packit |
1c1d7e |
See the HTML specification for the codes.
|
|
Packit |
1c1d7e |
6) Run configure and make again from the root of the distribution,
|
|
Packit |
1c1d7e |
in order to regenerate the Makefiles.
|
|
Packit |
1c1d7e |
7) Now you can use OUTPUT_LANGUAGE = your_language_name
|
|
Packit |
1c1d7e |
in the config file to generate output in your language.
|
|
Packit |
1c1d7e |
8) Send translator_xx.h to me so I can add it to doxygen.
|
|
Packit |
1c1d7e |
Send also your name and e-mail address to be included in the
|
|
Packit |
1c1d7e |
maintainers.txt list.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Good luck, and let me know if there are problems.
|
|
Packit |
1c1d7e |
|