Author: ltheussl Date: Wed Sep 28 15:04:27 2005 New Revision: 292328 URL: http://svn.apache.org/viewcvs?rev=292328&view=rev Log: Clean-up to make it validate
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml Modified: 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=292328&r1=292327&r2=292328&view=diff ============================================================================== --- maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml (original) +++ maven/maven-1/plugins/trunk/xdoc/xdocs/i18n.xml Wed Sep 28 15:04:27 2005 @@ -31,6 +31,7 @@ <p> XDoc plugin uses Java to produce internationalised documentation. Please refer to: + </p> <ul> <li> <a href="http://java.sun.com/j2se/corejava/intl/index.jsp"> @@ -53,8 +54,9 @@ </a> </li> </ul> - + <p> The XDoc plugin will generate this following structure: + </p> <source> |-- en\ |-- user_dir\ @@ -73,7 +75,6 @@ |-- user_dir\ |-- index.html |-- ... (mail-lists.html, maven-reports.html...)</source> - </p> </section> <section name="Getting started"> <subsection name="First step"> @@ -82,12 +83,12 @@ 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: + </p> <div class="source"> <pre> maven.xdoc.locale.default=en maven.xdoc.locale.supported=fr, de</pre> </div> - </p> </subsection> <subsection name="Second step"> <p> @@ -96,6 +97,7 @@ in the <code>${maven.xdoc.bundle.src}</code> directory. In our example, you should have: + </p> <div class="source"> <pre> |-- ${maven.xdoc.bundle.src}\ @@ -105,39 +107,41 @@ |-- ${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> : + </p> <source><![CDATA[ <menu key="mykey"/> <item key="mykey" href="/mylink.html" />]]></source> + <p> For <code>myxdoc.xml</code> : + </p> <source><![CDATA[ <title key="mykey"/> <message key="mykey"/> <section key="mykey"/> <subsection key="mykey"/> <a hrefkey="myhrefkey">My i18n link</a>]]></source> - + <p> NOTE: XDoc plugin always uses key if defined. For instance, this line of code: + </p> <source><![CDATA[<title key="myKey">blabla</title>]]></source> + <p> 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: - + </p> <div class="source"> <pre>maven.xdoc.ui.localeList.asSelect=true</pre> </div> - </p> </subsection> </section> <section name="Language supported"> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]