Internationalization Vincent Siveton

This plugin could produce internationalised Maven1 documentation.

XDoc plugin uses Java to produce internationalised documentation. Please refer to:

The XDoc plugin will generate this following structure:

|-- en\ |-- user_dir\ |-- index.html |-- ... (mail-lists.html, maven-reports.html...) |-- fr\ |-- user_dir\ |-- index.html |-- ... (mail-lists.html, maven-reports.html...) |-- OTHER_LANGUAGE\ |-- user_dir\ |-- index.html |-- ... (mail-lists.html, maven-reports.html...) |-- images\ |-- style\ |-- user_dir\ |-- index.html |-- ... (mail-lists.html, maven-reports.html...)

You should define a default locale and all supported locales. For example, you want to produce Maven documentation by default in English, and also in French and in German. Just add these properties in your project.properties file: 

maven.xdoc.locale.default=en
maven.xdoc.locale.supported=fr, de

You should define your own bundles called ${maven.xdoc.bundle}.properties in the ${maven.xdoc.bundle.src} directory. In our example, you should have: 

|-- ${maven.xdoc.bundle.src}\
        |-- user_dir\
        |-- ${maven.xdoc.bundle}.properties
        |-- ${maven.xdoc.bundle}_fr.properties
        |-- ${maven.xdoc.bundle}_de.properties

You should create your own XDoc files which supports i18n. For navigation.xml :

]]>

For myxdoc.xml :

My i18n link]]>

NOTE: XDoc plugin always uses key if defined. For instance, this line of code:

blabla]]>

will produce the key value and not "blabla".

If you have lots of languages defined, you can beautify the display with a select form. Just add this following property: 

maven.xdoc.ui.localeList.asSelect=true

Actually, only English, French and German are currently fully supported by Maven. Contributions are welcome!

All generated reports by other plugins are not supported by the XDoc plugin. Each Maven1 plugin should be translated by their authors.

Actually, PDF and HTML2XDOC plugins do not support the internationalization.