Author: dennisl
Date: Mon Mar 12 20:29:14 2012
New Revision: 1299832
URL: http://svn.apache.org/viewvc?rev=1299832&view=rev
Log:
Move all i18n and l10n documentation over from the Site Plugin so that we have
everything in one place.
Merge r1299830 from trunk.
Modified:
maven/plugins/branches/maven-site-plugin-2.x/ (props changed)
maven/plugins/branches/maven-site-plugin-2.x/pom.xml (props changed)
maven/plugins/branches/maven-site-plugin-2.x/src/ (props changed)
maven/plugins/branches/maven-site-plugin-2.x/src/it/inheritedReports/
(props changed)
maven/plugins/branches/maven-site-plugin-2.x/src/site/xdoc/i18n.xml
Propchange: maven/plugins/branches/maven-site-plugin-2.x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Mar 12 20:29:14 2012
@@ -1 +1 @@
-/maven/plugins/trunk/maven-site-plugin:1150948,1174605,1174614,1175226
+/maven/plugins/trunk/maven-site-plugin:1150948,1174605,1174614,1175226,1299830
Propchange: maven/plugins/branches/maven-site-plugin-2.x/pom.xml
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Mar 12 20:29:14 2012
@@ -1,2 +1,2 @@
/maven/plugins/branches/maven-site-plugin-3.x/pom.xml:940318,942876,956257,956299,984961,992626,1003823
-/maven/plugins/trunk/maven-site-plugin/pom.xml:1150948,1174605,1174614,1175226
+/maven/plugins/trunk/maven-site-plugin/pom.xml:1150948,1174605,1174614,1175226,1299830
Propchange: maven/plugins/branches/maven-site-plugin-2.x/src/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Mar 12 20:29:14 2012
@@ -1,2 +1,2 @@
/maven/plugins/branches/maven-site-plugin-3.x/src:940318,942876,956257,956299,984961,992626,1003823
-/maven/plugins/trunk/maven-site-plugin/src:1150948,1174605,1174614,1175226
+/maven/plugins/trunk/maven-site-plugin/src:1150948,1174605,1174614,1175226,1299830
Propchange:
maven/plugins/branches/maven-site-plugin-2.x/src/it/inheritedReports/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Mar 12 20:29:14 2012
@@ -1 +1 @@
-/maven/plugins/trunk/maven-site-plugin/src/it/inheritedReports:801155,801171,801470,806898-806906,807943-808180,809252,810298,884137,886844,886847,890094,890124,891014,891688,920027,920041,942622,943455,944145,950463,956681,984466,984960,984991,984996,1029307,1033379,1037476,1039137,1039143,1039748-1039749,1049020,1051139-1051449,1055019,1055033,1055047,1055089,1060289,1063639,1064626,1065576,1065582,1066038,1067103,1067120,1070079-1070080,1070100,1070104,1074118,1075018,1075782,1075810,1075995,1076167,1076195,1077911,1077924,1078235,1079474,1079529,1079698,1080781,1081676,1081837,1081887,1082091,1082242,1082274,1082877,1083147,1083251,1083473,1084564,1086313,1086338-1086339,1086533,1087455,1088584,1089802,1089852,1091331,1098168,1098170,1099591,1126420,1126918-1126945,1132936,1145546,1145555,1145947,1147048,1150948,1174605,1174614,1175226
+/maven/plugins/trunk/maven-site-plugin/src/it/inheritedReports:801155,801171,801470,806898-806906,807943-808180,809252,810298,884137,886844,886847,890094,890124,891014,891688,920027,920041,942622,943455,944145,950463,956681,984466,984960,984991,984996,1029307,1033379,1037476,1039137,1039143,1039748-1039749,1049020,1051139-1051449,1055019,1055033,1055047,1055089,1060289,1063639,1064626,1065576,1065582,1066038,1067103,1067120,1070079-1070080,1070100,1070104,1074118,1075018,1075782,1075810,1075995,1076167,1076195,1077911,1077924,1078235,1079474,1079529,1079698,1080781,1081676,1081837,1081887,1082091,1082242,1082274,1082877,1083147,1083251,1083473,1084564,1086313,1086338-1086339,1086533,1087455,1088584,1089802,1089852,1091331,1098168,1098170,1099591,1126420,1126918-1126945,1132936,1145546,1145555,1145947,1147048,1150948,1174605,1174614,1175226,1299830
Modified: maven/plugins/branches/maven-site-plugin-2.x/src/site/xdoc/i18n.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-2.x/src/site/xdoc/i18n.xml?rev=1299832&r1=1299831&r2=1299832&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-2.x/src/site/xdoc/i18n.xml
(original)
+++ maven/plugins/branches/maven-site-plugin-2.x/src/site/xdoc/i18n.xml Mon Mar
12 20:29:14 2012
@@ -28,386 +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>Languages available</th>
- <th>Site Plugin</th>
- <th>Project Info Reports Plugin</th>
- <th>Maven Doxia Tools</th>
- </tr>
- <tr>
- <td>Brazilian Portuguese</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>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>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>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>
- <tr>
- <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>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>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>English (Default)</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>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>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>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>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>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>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>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>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>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>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>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>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>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>
- </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>
