You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2012/03/12 21:25:36 UTC
svn commit: r1299830 -
/maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml
Author: dennisl
Date: Mon Mar 12 20:25:36 2012
New Revision: 1299830
URL: http://svn.apache.org/viewvc?rev=1299830&view=rev
Log:
Move all i18n documentation over to the main Maven site so that we have everything in one place.
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml
Modified: maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml?rev=1299830&r1=1299829&r2=1299830&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml Mon Mar 12 20:25:36 2012
@@ -28,447 +28,9 @@ under the License.
<body>
<section name="Internationalization">
<p>
- 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
- <a href="#Instructions_for_Translators">detailed instructions</a> below.
+ The documentation about internationalization and localization of plugins has been moved to:
+ <a href="http://maven.apache.org/plugins/localization.html">http://maven.apache.org/plugins/localization.html</a>
</p>
-
- <p>
- There are currently three files that needs to be localized to support a
- new language. The following table summarizes the currently supported
- languages.
- </p>
-
- <p>
- <b>Note:</b> 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.
- </p>
-
- <subsection name="Supported Languages">
- <table>
- <tr>
- <th>Locale</th>
- <th>Language</th>
- <th>Site Plugin</th>
- <th>Project Info Reports Plugin</th>
- <th>Maven Doxia Tools</th>
- </tr>
- <tr>
- <td>ca</td>
- <td>Catalan</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_ca.properties">See</a>
- </td>
- <td>
- N/A
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_ca.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>cs</td>
- <td>Czech</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_cs.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_cs.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_cs.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>da</td>
- <td>Danish</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_da.properties">See</a>
- </td>
- <td>
- N/A
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_da.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>de</td>
- <td>German</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_de.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_de.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_de.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>en</td>
- <td>English</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>es</td>
- <td>Spanish</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_es.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_es.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_es.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>fr</td>
- <td>French</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_fr.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_fr.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_fr.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>gl</td>
- <td>Gallegan</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_gl.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_gl.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_gl.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>hu</td>
- <td>Hungarian</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_hu.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_hu.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_hu.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>it</td>
- <td>Italian</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_it.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_it.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_it.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>ja</td>
- <td>Japanese</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_ja.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_ja.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_ja.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>ko</td>
- <td>Korean</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_ko.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_ko.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_ko.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>lt</td>
- <td>Lithuanian</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_lt.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_lt.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_lt.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>nl</td>
- <td>Dutch</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_nl.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_nl.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_nl.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>no</td>
- <td>Norwegian</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_no.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_no.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_no.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>pl</td>
- <td>Polish</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_pl.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_pl.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_pl.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>pt</td>
- <td>Portuguese</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_pt.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_pt.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_pt.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>pt_BR</td>
- <td>Portuguese (Brazil)</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_pt_BR.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_pt_BR.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_pt_BR.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>ru</td>
- <td>Russian</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_ru.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_ru.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_ru.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>sk</td>
- <td>Slovak</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_sk.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_sk.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_sk.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>sv</td>
- <td>Swedish</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_sv.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_sv.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_sv.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>tr</td>
- <td>Turkish</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_tr.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_tr.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_tr.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>zh_CN</td>
- <td>Chinese (China)</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_zh_CN.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_zh_CN.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_zh_CN.properties">See</a>
- </td>
- </tr>
- <tr>
- <td>zn_TW</td>
- <td>Chinese (Taiwan)</td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_zh_TW.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_zh_TW.properties">See</a>
- </td>
- <td>
- <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_zh_TW.properties">See</a>
- </td>
- </tr>
- </table>
-
- <p>
- To see the current level of localization support you can have a look
- at the L10n Status Report for each one of them:
- </p>
-
- <ul>
- <li><a href="l10n-status.html">Site Plugin</a></li>
- <li><a href="http://maven.apache.org/plugins/maven-project-info-reports-plugin/l10n-status.html">Project Info Reports Plugin</a></li>
- <li><a href="http://maven.apache.org/shared/maven-doxia-tools/l10n-status.html">Doxia Tools</a></li>
- </ul>
- </subsection>
-
- <subsection name="Instructions for Translators">
- <p>
- If you want to contribute a localization, follow these steps:
- </p>
-
- <ol>
- <li>
- 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.
- </li>
- <li>
- Rename the files to the wanted locale. For example,
- <code>site-plugin_de.properties</code> for a new German
- translation for Maven Site Plugin.
- </li>
- <li>
- 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.
- </li>
- <li>
- To test your localization
- <ul>
- <li>Checkout the latest source for
- <a href="source-repository.html">Site Plugin</a>,
- <a href="http://maven.apache.org/plugins/maven-project-info-reports-plugin/source-repository.html">Project Info Reports Plugin</a> and
- <a href="http://maven.apache.org/shared/maven-doxia-tools/source-repository.html">Maven Doxia Tools</a></li>
- <li>Include your files in <code>src/main/resources</code> for each one</li>
- <li>Run "<code>mvn install</code>" for each one</li>
- <li>Configure a project to produce a site in several locales</li>
- <li>Make sure that it is using the latest SNAPSHOT version of
- each of the above artifacts</li>
- <li>Run "<code>mvn site</code>" on that project and test it</li>
- </ul>
- </li>
- <li>
- When you are happy with it, create a new issue in
- <a href="http://jira.codehaus.org/browse/MSITE">JIRA</a>
- and attach your files there.
- </li>
- </ol>
- </subsection>
-
- <subsection name="References and Tools">
- <p>
- Please refer to the
- <a target="_blank" href="http://java.sun.com/javase/technologies/core/basic/intl/">
- Java Internationalization home page</a> for an introduction to the topic.
- </p>
-
- <p>
- Here you can find some useful tools to help you with charset
- questions and conversions:
- </p>
-
- <ul>
- <li>
- <b>Tools to find out the charset of a file</b>:
- Unix <i>file</i> command,
- <a href="http://cpdetector.sourceforge.net/">cpdetector</a>,
- <a href="http://plugins.intellij.net/plugin/?id=24">IntelliJ IDEA ShowEncodingPlugin</a>,
- <a href="http://notepad-plus.sourceforge.net/">Notepad++</a>, ...
- </li>
- <li>
- <b>Tools to write a file in a given charset</b>:
- any editor like Notepad, Eclipse, IntelliJ IDEA, ...
- </li>
- <li>
- <b>Tools to convert a file from one encoding to another encoding</b>:
- Unix <i>iconv</i> command, Notepad++.
- </li>
- <li>
- <b>IDE plugins</b>: <a href="http://propedit.sourceforge.jp/index_en.html">Properties Editor Eclipse Plugin</a>.
- </li>
- </ul>
-
- <p>
- You can also refer to this Sun FAQ:
- <a href="http://developers.sun.com/global/technology/standards/reference/faqs/determining-file-encoding.html">
- How Can I Determine the Encoding of a File?</a>.
- </p>
- </subsection>
</section>
</body>
</document>