Internationalization

The site generation done by the Site Plugin and the Project Info Reports Plugin is fully internationalized. This means that adapting them to another language, a process known as localization, is very easy. All that is needed is to download a couple of properties files and start translating the texts in them. If you want to provide a patch for an unsupported language, there are detailed instructions below.

There are currently three files that needs to be localized to support a new language. The following table summarizes the currently supported languages.

Note: The files linked to below are the files used in the latest development code. So the files may be newer than the ones included in the latest release.

Supported Languages

Languages available Site Plugin Project Info Reports Plugin Maven Doxia Tools
Brazilian Portuguese See See See
Catalan See N/A See
Chinese (China) See See See
Chinese (Taiwan) See See See
Czech See See See
Danish See N/A See
Dutch See See See
English (Default) See See See
French See See See
German See See See
Hungarian See See See
Italian See See See
Japanese See See See
Korean See See See
Norwegian See See See
Polish See See See
Portuguese See See See
Slovak See See See
Spanish See See See
Swedish See See See
Turkish See See See

To see the current level of localization support you can have a look at the L10n Status Report for each one of them:

Instructions for Translators

If you want to contribute a localization, follow these steps:

  1. Download each of the three properties files linked above as the base for your translation. Pick files from a language that you understand well, for instance English.
  2. Rename the files to the wanted locale. For example, site-plugin_de.properties for a new German translation for Maven Site Plugin.
  3. Translate the files contents using your preferred text editor. The files must use US-ASCII encoding. For characters that are not included in US-ASCII you must use Unicode escapes, like "\u8ff0". See the tools section below for examples of tools that can help you to convert your texts to use Unicode escapes.
  4. To test your localization
    • Checkout the latest source for Site Plugin, Project Info Reports Plugin and Maven Doxia Tools
    • Include your files in src/main/resources for each one
    • Run "mvn install" for each one
    • Configure a project to produce a site in several locales
    • Make sure that it is using the latest SNAPSHOT version of each of the above artifacts
    • Run "mvn site" on that project and test it
  5. When you are happy with it, create a new issue in JIRA and attach your files there.

References and Tools

Please refer to the Java Internationalization home page for an introduction to the topic.

Here you can find some useful tools to help you with charset questions and conversions:

You can also refer to this Sun FAQ: How Can I Determine the Encoding of a File?.