[jira] Commented: (MSITE-287) Clarify/fix documentation about encoding for translated resource bundles.

["Benjamin Bentmann (JIRA)" <ji...@codehaus.org>]

    [ http://jira.codehaus.org/browse/MSITE-287?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_124640 ] 

Benjamin Bentmann commented on MSITE-287:
-----------------------------------------

I would like to continue to argue against needlessly introducing Unicode escapes for Latin-1 characters into a file that is by common convention assumed to be encoded in ISO-8859-1. As Vincent himself has just proven, using Unicode escapes does not prevent messing up the I18n ([plugin-report_de.properties|http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-plugin/src/main/resources/plugin-report_de.properties?r1=620114&r2=630057&pathrev=630057], [pluginxdoc_de.properties|http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/resources/pluginxdoc_de.properties?r1=629657&r2=630057&pathrev=630057], [Unicode FFFD|http://unicode.org/glossary/index.html#replacement_character]):
- the conversion itself is error-prone
- the result is not easily readable/controllable by humans

So why scramble a file that is supposed to be human-readable with unicode escapes? Contributors that provide I18n for their native language usually know about the details of properly encoding their properties files because they are used to this in their other Java projects. In contrast, English speaking developers are used to live in an ASCII world and seem less sensitive to encoding issues.

> Clarify/fix documentation about encoding for translated resource bundles.
> -------------------------------------------------------------------------
>
>                 Key: MSITE-287
>                 URL: http://jira.codehaus.org/browse/MSITE-287
>             Project: Maven 2.x Site Plugin
>          Issue Type: Improvement
>    Affects Versions: 2.0-beta-6
>            Reporter: Benjamin Bentmann
>            Priority: Minor
>
> According to http://maven.apache.org/plugins/maven-site-plugin/i18n.html translators are expected to provide their properties files in UTF-8 encoding. However, the JRE reads properties files using ISO-8859-1 encoding (see [class javadoc for PropertyResourceBundle|http://java.sun.com/javase/6/docs/api/java/util/PropertyResourceBundle.html]).
> Either the documentation should be fixed to state ISO-8859-1 or it should be made clear why Maven requires another encoding than usual.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira