You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2005/05/21 17:10:42 UTC
svn commit: r171222 [4/4] - in /maven/maven-1/plugins/trunk/xdoc: ./
src/main/org/apache/maven/xdoc/ src/main/org/apache/maven/xdoc/util/
src/plugin-resources/ src/plugin-resources/templates/
src/plugin-resources/templates/scm/ src/plugin-test/
src/plugin-test/test01/xdocs/ src/plugin-test/test03/
src/plugin-test/test03/xdocs/ src/plugin-test/test03/xdocs/images/
src/plugin-test/test03/xdocs/subdir/
src/plugin-test/test03/xdocs/subdir/subdir2/ src/plugin-test/test04/
src/plugin-test/test04/xdocs/ src/plugin-test/test04/xdocs/images/
src/plugin-test/test04/xdocs/subdir/
src/plugin-test/test04/xdocs/subdir/subdir2/
src/plugin-test/testDependenciesComment/ src/test/org/apache/maven/xdoc/
src/test/org/apache/maven/xdoc/util/ xdocs/
Added: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/myfile_i18n.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/myfile_i18n.xml?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/myfile_i18n.xml (added)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/myfile_i18n.xml Sat May 21 08:10:41 2005
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright 2001-2004 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ -->
+
+<document>
+ <properties>
+ <author email="vincent.siveton@gmail.com">Vincent Siveton</author>
+ <title key="myfile_i18n.title"/>
+ </properties>
+
+ <body>
+ <section key="myfile_i18n.section1.title">
+ <p>
+ <message key="myfile_i18n.section1.description1"/>
+ </p>
+ <p>
+ <message key="myfile_i18n.section1.description2"/>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/myfile_i18n.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/myfile_i18n.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/navigation.xml?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/navigation.xml (added)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/navigation.xml Sat May 21 08:10:41 2005
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+/*
+ * Copyright 2001-2004 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ -->
+
+<project name="MPXDOC-128"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:noNamespaceSchemaLocation="MAVEN_HOME/maven-navigation-1.0.xsd">
+
+ <title key="navigation.title"/>
+
+ <body>
+ <links>
+<!--
+ <item name="PDF Documentation" href="app.pdf"
+ img="images/pdf.gif"/>
+-->
+ </links>
+
+ <!-- project overview -->
+ <menu key="navigation.menu1.title">
+ <item key="navigation.menu1.item1"
+ href="/myfile_i18n.html" />
+ <item key="navigation.menu1.item2"
+ href="/subdir/testjsltosite.html" />
+ <item key="navigation.menu1.item3"
+ href="/subdir/subdir2/testjsltosite2.html" />
+ </menu>
+ </body>
+</project>
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/navigation.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/subdir2/testjsltosite2.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/subdir2/testjsltosite2.xml?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/subdir2/testjsltosite2.xml (added)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/subdir2/testjsltosite2.xml Sat May 21 08:10:41 2005
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright 2001-2004 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ -->
+
+<document>
+ <properties>
+ <author email="vincent.siveton@gmail.com">Vincent Siveton</author>
+ <title key="testjstltosite.title"/>
+ </properties>
+
+ <body>
+ <section key="testjstltosite.section1.title">
+ <p>
+ <message key="testjstltosite.section1.description1"/>
+ </p>
+ <p>
+ <message key="testjstltosite.section1.description2"/>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/subdir2/testjsltosite2.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/subdir2/testjsltosite2.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/testjsltosite.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/testjsltosite.xml?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/testjsltosite.xml (added)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/testjsltosite.xml Sat May 21 08:10:41 2005
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright 2001-2004 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ -->
+
+<document>
+ <properties>
+ <author email="vincent.siveton@gmail.com">Vincent Siveton</author>
+ <title key="testjstltosite.title"/>
+ </properties>
+
+ <body>
+ <section key="testjstltosite.section1.title">
+ <p>
+ <message key="testjstltosite.section1.description1"/>
+ </p>
+ <p>
+ <message key="testjstltosite.section1.description2"/>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/testjsltosite.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/subdir/testjsltosite.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs.properties
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs.properties?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs.properties (added)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs.properties Sat May 21 08:10:41 2005
@@ -0,0 +1,18 @@
+# From navigation.xml
+navigation.title=MPXDOC-128
+navigation.menu1.title=General Project Information
+navigation.menu1.item1=myfile_i18n
+navigation.menu1.item2=testjsltosite
+navigation.menu1.item3=testjsltosite2
+
+# From myfile_i18n.xml
+myfile_i18n.title=Xdoc test Document
+myfile_i18n.section1.title=Title 1
+myfile_i18n.section1.description1=empty document
+myfile_i18n.section1.description2=This document is generated separately from other xdoc documents but should retain the site stylesheet and navigation.
+
+# From testjstltosite.xml
+testjstltosite.title=test jslToSite tag
+testjstltosite.section1.title=Title 1
+testjstltosite.section1.description1=empty document
+testjstltosite.section1.description2=This document is generated separately from other xdoc documents but should retain the site stylesheet and navigation.
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs.properties
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs.properties
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs_fr.properties
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs_fr.properties?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs_fr.properties (added)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs_fr.properties Sat May 21 08:10:41 2005
@@ -0,0 +1,18 @@
+# From navigation.xml
+navigation.title=MPXDOC-128
+navigation.menu1.title=Information générale sur le projet
+navigation.menu1.item1=myfile_i18n
+navigation.menu1.item2=testjsltosite
+navigation.menu1.item3=testjsltosite2
+
+# From myfile_i18n.xml
+myfile_i18n.title=Document Xdoc test
+myfile_i18n.section1.title=Titre 1
+myfile_i18n.section1.description1=document vide
+myfile_i18n.section1.description2=Ce document est produit séparément des autres documents XDOC mais devrait maintenir le stylesheet et la navigation d'emplacement.
+
+# From testjstltosite.xml
+testjstltosite.title=test jslToSite tag
+testjstltosite.section1.title=Title 1
+testjstltosite.section1.description1=document vide
+testjstltosite.section1.description2=Ce document est produit séparément des autres documents XDOC mais devrait maintenir le stylesheet et la navigation d'emplacement.
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs_fr.properties
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test04/xdocs/xdocs_fr.properties
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/maven-1/plugins/trunk/xdoc/src/plugin-test/testDependenciesComment/maven.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/testDependenciesComment/maven.xml?rev=171222&r1=171221&r2=171222&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-test/testDependenciesComment/maven.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-test/testDependenciesComment/maven.xml Sat May 21 08:10:41 2005
@@ -29,6 +29,7 @@
<assert:assertFileExists file="${depXmlPath}"/>
<util:file var="depXmlFile" name="${depXmlPath}"/>
<x:parse var="depXmlDom" xml="${depXmlFile}"/>
+<!--
<x:set var="headerComment" select="string($depXmlDom/document/body/section[@name='Dependencies']/table/thead/tr/th[5])"/>
<assert:assertEquals expected="Comment" value="${headerComment}"/>
<x:forEach var="tr" select="$depXmlDom/document/body/section[@name='Dependencies']/table/tbody/*">
@@ -47,7 +48,7 @@
<assert:assertEquals expected="" value="${comment.trim()}"/>
</j:if>
</x:forEach>
-
+-->
</goal>
</project>
Added: maven/maven-1/plugins/trunk/xdoc/src/test/org/apache/maven/xdoc/util/LocaleUtilTest.java
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/test/org/apache/maven/xdoc/util/LocaleUtilTest.java?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/test/org/apache/maven/xdoc/util/LocaleUtilTest.java (added)
+++ maven/maven-1/plugins/trunk/xdoc/src/test/org/apache/maven/xdoc/util/LocaleUtilTest.java Sat May 21 08:10:41 2005
@@ -0,0 +1,69 @@
+package org.apache.maven.xdoc.util;
+
+/* ====================================================================
+ * Copyright 2001-2004 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ====================================================================
+ */
+import java.util.Locale;
+
+import org.apache.maven.xdoc.util.LocaleUtil;
+
+import junit.framework.TestCase;
+
+/**
+ * LocaleUtil Test class.
+ *
+ * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
+ * @version $Id$
+ */
+public class LocaleUtilTest extends TestCase {
+
+ public void testCodeToLocale1() {
+ Locale locale = LocaleUtil.codeToLocale("en");
+ assertEquals(locale.toString(), "en");
+ }
+
+ public void testCodeToLocale2() {
+ Locale locale = LocaleUtil.codeToLocale("en_CA");
+ assertEquals(locale.toString(), "en_CA");
+ }
+
+ public void testCodeToLocaleAsNull() {
+ Locale locale = LocaleUtil.codeToLocale(null);
+ assertNull(locale);
+ }
+
+ public void testCodeToLocaleAsDefault() {
+ Locale locale = LocaleUtil.codeToLocale("default");
+ assertEquals(locale, Locale.getDefault());
+ }
+
+ public void testCodesToLocales() {
+ Locale[] locales = LocaleUtil.codesToLocales("en, en_CA");
+ assertEquals(locales[0].toString(), "en");
+ assertEquals(locales[1].toString(), "en_CA");
+ }
+
+ public void testCodesToLocalesAsNull() {
+ Locale[] locales = LocaleUtil.codesToLocales(null);
+ assertNull(locales);
+ }
+
+ public void testDisplayName() {
+ Locale locale = new Locale("fr");
+ String result = LocaleUtil.displayName(locale, locale);
+ assertEquals(result, "Français");
+ }
+}
Propchange: maven/maven-1/plugins/trunk/xdoc/src/test/org/apache/maven/xdoc/util/LocaleUtilTest.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins/trunk/xdoc/src/test/org/apache/maven/xdoc/util/LocaleUtilTest.java
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/faq.fml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/faq.fml?rev=171222&r1=171221&r2=171222&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/faq.fml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/faq.fml Sat May 21 08:10:41 2005
@@ -72,8 +72,14 @@
</question>
<answer>Create an index.xml file in the xdocs directory.</answer>
</faq>
+ <faq id="i18n">
+ <question>Does the documentation generated by Maven Xdocs plugin support internationalization?</question>
+ <answer>
+ Yes. Please see the <a href="i18n.html">i18n</a> document.
+ </answer>
+ </faq>
</part>
-
+
<part id="navigation">
<title>Navigation</title>
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/goals.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/goals.xml?rev=171222&r1=171221&r2=171222&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/goals.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/goals.xml Sat May 21 08:10:41 2005
@@ -22,11 +22,11 @@
<properties>
<title>XDoc Plugin Goals</title>
<author email="dion@apache.org">dIon Gillard</author>
+ <author email="vincent.siveton@gmail.com">Vincent Siveton</author>
</properties>
<body>
<goals>
-
<goal>
<name>xdoc</name>
<description>
@@ -49,8 +49,19 @@
This goal defines the <code>DVSL</code> tag library for generating
documentation. A single tag <code>dvsl:dvsl</code> is defined.
</description>
- </goal>
-
+ </goal>
+ <goal>
+ <name>copy-user-bundles</name>
+ <description>
+ Copy user bundles in the XDOC plugin. Used for the i18n support.
+ </description>
+ </goal>
+ <goal>
+ <name>clean-user-bundles</name>
+ <description>
+ Remove all user bundles from the XDOC plugin.
+ </description>
+ </goal>
</goals>
</body>
</document>
Added: maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml?rev=171222&view=auto
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml (added)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml Sat May 21 08:10:41 2005
@@ -0,0 +1,166 @@
+<?xml version="1.0"?>
+
+<!--
+ /*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+-->
+
+<document>
+ <properties>
+ <title>About</title>
+ <author email="vincent.siveton@gmail.com">Vincent Siveton</author>
+ </properties>
+
+ <body>
+ <section name="Internationalization">
+ <p>
+ This plugin could produce internationalised Maven1 documentation.
+ </p>
+ </section>
+ <section name="Used Technologies">
+ <p>
+ XDoc plugin uses Java to produce internationalised
+ documentation. Please refer to:
+ <ul>
+ <li>
+ <a href="http://java.sun.com/j2se/corejava/intl/index.jsp">
+ Core Java Internationalization
+ </a>
+ </li>
+ <li>
+ <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/ResourceBundle.html">
+ ResourceBundle (Java 2 Platform SE v1.4.2)
+ </a>
+ </li>
+ <li>
+ <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/locale.doc.html">
+ Supported Locales
+ </a>
+ </li>
+ <li>
+ <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">
+ Supported Encodings
+ </a>
+ </li>
+ </ul>
+
+ The XDoc plugin will generate this following structure:
+ <source>
+|-- 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...)</source>
+ </p>
+ </section>
+ <section name="Getting started">
+ <subsection name="First step">
+ <p>
+ 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 <code>project.properties</code> file:
+ <div class="source">
+ <pre>
+maven.xdoc.locale.default=en
+maven.xdoc.locale.supported=fr, de</pre>
+ </div>
+ </p>
+ </subsection>
+ <subsection name="Second step">
+ <p>
+ You should define your own bundles called
+ <code>${maven.xdoc.bundle}.properties</code>
+ in the
+ <code>${maven.xdoc.bundle.src}</code>
+ directory. In our example, you should have:
+ <div class="source">
+ <pre>
+|-- ${maven.xdoc.bundle.src}\
+ |-- user_dir\
+ |-- ${maven.xdoc.bundle}.properties
+ |-- ${maven.xdoc.bundle}_fr.properties
+ |-- ${maven.xdoc.bundle}_de.properties
+</pre>
+ </div>
+ </p>
+ </subsection>
+ <subsection name="Last step">
+ <p>
+ You should create your own XDoc files which supports i18n. For
+ <code>navigation.xml</code> :
+ <source><![CDATA[
+<menu key="mykey"/>
+<item key="mykey" href="/mylink.html" />]]></source>
+ For <code>myxdoc.xml</code> :
+ <source><![CDATA[
+<title key="mykey"/>
+<message key="mykey"/>
+<section key="mykey"/>
+<subsection key="mykey"/>]]></source>
+
+ NOTE: XDoc plugin always uses key if defined. For instance,
+ this line of code:
+ <source><![CDATA[<title key="myKey">blabla</title>]]></source>
+ will produce the key value and not "blabla".
+
+ </p>
+ </subsection>
+ <subsection name="Beautify the generated navigation">
+ <p>
+ If you have lots of languages defined, you can beautify the
+ display with a select form. Just add this following property:
+
+ <div class="source">
+ <pre>maven.xdoc.ui.localeList.asSelect=true</pre>
+ </div>
+ </p>
+ </subsection>
+ </section>
+ <section name="Language supported">
+ <p>
+ Actually, only English, French and German are currently fully
+ supported by Maven. Contributions are welcome!
+ </p>
+ </section>
+ <section name="Known Issues">
+ <subsection name="Generated Reports">
+ <p>
+ All generated reports by other plugins are not supported by the XDoc plugin.
+ Each Maven1 plugin should be translated by their authors.
+ </p>
+ </subsection>
+ <subsection name="Others Plugins">
+ <p>
+ Actually, PDF and HTML2XDOC plugins do not support the
+ internationalization.
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml?rev=171222&r1=171221&r2=171222&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/navigation.xml Sat May 21 08:10:41 2005
@@ -32,6 +32,7 @@
<menu name="Overview">
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
+ <item name="i18n" href="/i18n.html"/>
<item name="FAQs" href="/faq.html"/>
</menu>
</body>
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml?rev=171222&r1=171221&r2=171222&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/properties.xml Sat May 21 08:10:41 2005
@@ -18,11 +18,11 @@
-->
<document>
-
<properties>
<title>Xdoc Properties</title>
<author email="smor@apache.org">Stéphane MOR</author>
<author email="vmassol@apache.org">Vincent Massol</author>
+ <author email="vincent.siveton@gmail.com">Vincent Siveton</author>
</properties>
<body>
@@ -113,6 +113,88 @@
</tr>
</table>
</section>
+ <section name="I18n Properties">
+ <table>
+ <tr>
+ <th>Property name</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>maven.xdoc.date.format</td>
+ <td>Yes</td>
+ <td>
+ Sets the format of the date to display. Defaults to "dd MMMM
+ yyyy" (eg: "14 August 2002"). For details on the format, see
+ SimpleDateFormat in the jdk documentation.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.date.locale</td>
+ <td>Yes</td>
+ <td>Sets the locale used for the date. Defaults to "en", ie english.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.locale.default</td>
+ <td>Yes</td>
+ <td>
+ Sets the default locale used for the translation. If null, it is
+ the default locale for this instance of the Java Virtual Machine
+ Defaults to "en", ie english, to ensure backward compatible.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.locale.supported</td>
+ <td>Yes</td>
+ <td>
+ A comma separated of locales supported by the project, ie "fr,
+ en_CA"
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.bundle.src</td>
+ <td>Yes</td>
+ <td>
+ Specifies the location where user bundles are stored. The
+ default value is ${maven.docs.src}.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.bundle</td>
+ <td>Yes</td>
+ <td>
+ Specifies the name of the user bundles. The default value is
+ xdocs.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.ui.displayByDefault</td>
+ <td>Yes</td>
+ <td>
+ Boolean value to specify the display of the default language, ie
+ "English [By default]". The default value is false.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.ui.localeList.asSelect</td>
+ <td>Yes</td>
+ <td>
+ Boolean value to display the language list as an HTML
+ <select/> tag. The default value is false.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.xdoc.ui.localeList.max</td>
+ <td>Yes</td>
+ <td>
+ An integer value to specify the maximum number of locales
+ displayes without an HTML <select/> tag. The default value is 5.
+ </td>
+ </tr>
+ </table>
+ </section>
<section name="Presentation Properties">
<table>
<tr>
@@ -156,23 +238,6 @@
<li>bottom : after the organization name, in the footer</li>
</ul>
If "maven.xdoc.date" is left empty, no date is shown on the site (default).
- </td>
- </tr>
- <tr>
- <td>maven.xdoc.date.format</td>
- <td>Yes</td>
- <td>
- Sets the format of the date to display.
- Defaults to "dd MMMM yyyy" (eg: "14 August 2002").
- For details on the format, see SimpleDateFormat in the jdk documentation.
- </td>
- </tr>
- <tr>
- <td>maven.xdoc.date.locale</td>
- <td>Yes</td>
- <td>
- Sets the locale used for the date.
- Defaults to "en", ie english.
</td>
</tr>
<tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org