Internationalized Websites

I am totally agree with you. The internationalization support is an highly issue for some reasons like law constraint (Canada has two official languages - English and French)

This issue was already discussed in the past with the release manager of XDOC plugin. He suggested me to share here my proposal (as an alpha version) and to explain quickly my implementation.

Here is a generated structure (in totally agreement with the release manager) for an english/french web site:

Thus, we have a default version, an english version and a french one. You can easily switch language from the left navigation bar (see screenshot)

My implementation choice is:

• Bundle properties to generate documents from Xdoc templates (allow translation for the actual XDOC plugin):
  maven-xdoc-plugin-1.9-SNAPSHOT\plugin-resources\templates\templates.properties
• User can define his own bundle. By default, the bundle is in the $ {maven.docs.src} xdoc folder and its name is ${maven.xdoc.bundle}:
  ${maven.docs.src}

  \$

  {maven.xdoc.bundle}

  .properties
  LIMITATION: actually, the plugin should copy this bundle to maven-xdoc-plugin-1.9-SNAPSHOT\plugin-resources\temp\ directory to provide keys access.

• Added message tag to translate easily message. Example:
  <message key="mykey"/> ==> it s a shortcut to the user bundle (more quickly to write!)
  <message key="mykey" bundle="myBundle"/> ==> Key in the defined bundle from the XDOC path ie bundle="plugin-resources\temp\myBundle")
  About key and text, I choose this rule: define a key is more important that the text message itself.
  For instance, <title key="myKey">blabla</title> will become the myKey value and NOT blabla text.
• Update some already defined tags to allow key and bundle management

To try my proposal, unzip attachments:

• maven-xdoc-plugin-1_9-SNAPSHOT.zip to unzip into $ {user.home}

  \.maven\cache\

• a dummy example based on genapp plugin. Just call in a command line "maven site" or "maven app:default"

To create your own internationalize web site, just add this keys in your project.properties:
maven.xdoc.locale.list=en, fr
maven.xdoc.bundle=xdocs
and add xdocs.properties and xdocs_(fr | en).properties files in your xdocs folder
And, write or update your Xdocs to allow keys and bundle;o)

Known problem:
If you are using a big site or a multiproject site, its highly recommanded to increase the memory to prevent outofmemory failure
MAVEN_OPTS=-Xms512m -Xmx1024m

Future direction:
I think that every project should have a default language and available languages. The language should become a part of the POM definition. Thus, all plugins should provide internationalization ways.

Feel free to contact me to other questions or if you have some problems with this updated plugin.

Best regards,

Vincent

My xdoc contribution

A dummy example

Hello

Your xdocs suggestion described in

http://jira.codehaus.org/browse/MPXDOC-128

with the new taglib: fmt works fine for me on Windows 2000.

Thank you very much ! ! !

For what reason ever, my remote sysadmin working on Linux complains that
xdocs cannot resolve the keys .... I will travel tomorrow
5 hours to my sysadmin and then "eyeball" his installation - but at the
moment I cannot imagine what the problem could be ....

Perhaps you might have an idea...

Thanks if you pay attention to this comment

Valerie Nyre

Hello Vincent,

Thank for your great work! Good job! Now I would like to test it.

I have tried to install the maven-xdoc-plugin-1.9 snapshot using maven 1.0.2. I deleted the old plugin in the plugins directory within maven installation directory. Running maven site, everything works fine so far:

plugin maven-xdoc-plugin-1.8 is cached (dynatag dep) but no longer present
Cache invalidated due to out of date plugins

But then I get the following error:

Attempting to download commons-jelly-1.0-beta-4.jar.
159K downloaded
Attempting to download maven-model-1.1.jar.
WARNING: Failed to download maven-model-1.1.jar.
Attempting to download commons-jelly-tags-fmt-1.0.jar.
21K downloaded

BUILD FAILED
File...... C:\Dokumente und Einstellungen\Daniel Frey\.maven\cache\maven-site-plugin-1.5.2\plugin.jelly
Element... attainGoal
Line...... 40
Column.... 42
The build cannot continue because of the following unsatisfied dependency:

maven-model-1.1.jar

It seems that this 1.9-SNAPSHOT is relying on a maven-model release not available. How can I resolve this issue?

Thanks,
Daniel Frey

Hello Vincent,

When installing the plugin I have come across a small problem I just want to feedback here. The snapshot zip contains a directory with the plugin, which in turn has to be jared to be deployed correctly. It would be perfect to have a jar/zip with the plugin structure inside (no folder).

Thanks,
Daniel Frey

Ok, a simple adaptation resolved the issue with the model. Adapting project.xml of the plugin and replace

<dependency>
<groupId>maven</groupId>
<artifactId>maven-model</artifactId>
<version>1.1</version>
<type>jar</type>
</dependency>

with

<dependency>
<groupId>maven</groupId>
<artifactId>maven-model</artifactId>
<version>1.1-SNAPSHOT</version>
<type>jar</type>
</dependency>

works fine.

Daniel Frey

Hello Folks

I am back here again - a simple Maven User -

Two questions:

1.
Will Maven 2 follow an approach to I18N - will MPXDOC-128 be the solution ?

2.
Can you provide a clean snapshot hat can be used as Jump-Start into using it ? With an example that works on Linux - one which we can just INSTALL and RUN THE XDOCS-GENERATE-SITE ?

Thanks for you suggestions above - However...My SysAdmin also changed with the project.xml to point to the correct model. He downloaded the Model, but this is not the problem we are having.

It might be of interest to you to know that we still cannot get the solution to work on Linux:

Maven can BUILD the project, but it seems that the text variables (property files) cannot be found. Unresolved variables are displayed as "variable name" -

We followed the user instructions, we named the property files correctly, we have them both in the /temp/ of xdocs and in the root of our /docs/ directory. We could not even get your sample to work.

Well, I am a bit ashamed to admit: I made a quick-and-dirty installation of the snapshot in my Windows system (without the project.xml, build.properties and the like... which I assumed only important to build the snapshot... ) and it works.

I tried to convince my Sysadmin to do the same, but .... I am also having communication problem now - My sysadmin wants to follow a clean official procedure and wants to install the complete snapshot.

(See above: Question 2)

My respect and thanks

Valerie

I would like to update the german translation of the xdocs terms as they look after being revised by others.

Thanks for your god work again!

diff from http://antarticadream.no-ip.org/xdoc/svndiff.txt sent to me by Vincent Siveton

New diff file without the tab characters

jelly part of the patch from Vincent

tag from Vincent

from Vincent

missing files from Vincent

committed. I need to review a couple of things:

• try moving the tags out of jelly tags, get it working with m1
• getting an NPE in 1.1 running plugin tests (probably unrelated bug in 1.1)

I made some changes to i18n.xml (removed the large images, adjusted final section text)

In progress in MPXDOC-128