Maven 1.x XDoc Plugin

Encoding problem: Non-ASCII characters like German umlauts are not transcoded properly.

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Won't Fix
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Environment:
    Maven 1.1 beta 1
    SuSE Linux 9.1
  • Number of attachments :
    0

Description

Posting to the maven-users list:

We face encoding problems with the Maven-Reports. The output is declared to be ISO-8859-1 (Latin 1), but it actually isn't (neither the XML nor the HTML). Non-ASCII characters like German umlauts are not transcoded properly.

I noticed the same problem in the docs of the official maven tasklist plugin at http://maven.apache.org/maven-1.x/reference/plugins/tasklist/checkstyle/, e.g.: La variable 'destDir' devrait être privée et avoir des accesseurs.

When I set maven.docs.outputencoding to UTF-8 it is even worse: The transformation then makes apparently two wrong bytes out of every single byte of the aready erroneous transcoded characters.

I've not found any hint in the docs or in Jira so far; can somebody please shed some light on it for me?

I'm using Maven 1.1 beta 1.

Regards,
Gisbert Amm

Activity

Hide
Gisbert Amm added a comment -

Follow-Up on the mailing list:

I finally found something I consider a workaround for the checkstyle report (I already use the 3.0-SNAPSHOT of the plugin) and the xdocs:

I'v changed the locale settings on my SuSE 9.1 system like that

export LANG=de_DE.utf8
export LC_CTYPE=de_DE.utf8

(setting of LC_CTYPE was necessary aswell)

and set the following Maven properties:

maven.docs.outputencoding=UTF-8
maven.xdoc.locale.default=de_DE.utf8

Now the German umlauts are displayed correctly within the checkstyle report and the documents generated out of the xdocs (like index.xml). However, other reports like Javadoc, Source Xref and Test Xref still suffer from wrong encoded characters.

Regards,
Gisbert Amm

Lukas Theussl wrote:
> On Linux you also have to set the system encoding explicitly,
> see http://maven.apache.org/maven-1.x/reference/plugins/xdoc/faq.html#problems-unicode
> Arnaud HERITIER wrote:
>
>> For checkstyle it fixes only the locale.
>> It doesn't help for the encoding
>>
>>> ----Message d'origine----
>>> De : Lukas Theussl ltheussl@apache.org Envoyé : mercredi 16 novembre 2005 00:03
>>>
>>> For the checkstyle plugin this should be fixed in the current 3.0-SNAPSHOT (see http://jira.codehaus.org/browse/MPCHECKSTYLE-39 ), but it might still be a problem for other plugins.
>>>
>>> Gisbert, which plugins/reports do you have problems with?

Show
Gisbert Amm added a comment - Follow-Up on the mailing list: I finally found something I consider a workaround for the checkstyle report (I already use the 3.0-SNAPSHOT of the plugin) and the xdocs: I'v changed the locale settings on my SuSE 9.1 system like that export LANG=de_DE.utf8 export LC_CTYPE=de_DE.utf8 (setting of LC_CTYPE was necessary aswell) and set the following Maven properties: maven.docs.outputencoding=UTF-8 maven.xdoc.locale.default=de_DE.utf8 Now the German umlauts are displayed correctly within the checkstyle report and the documents generated out of the xdocs (like index.xml). However, other reports like Javadoc, Source Xref and Test Xref still suffer from wrong encoded characters. Regards, Gisbert Amm Lukas Theussl wrote: > On Linux you also have to set the system encoding explicitly, > see http://maven.apache.org/maven-1.x/reference/plugins/xdoc/faq.html#problems-unicode > Arnaud HERITIER wrote: > >> For checkstyle it fixes only the locale. >> It doesn't help for the encoding >> >>> ----Message d'origine---- >>> De : Lukas Theussl ltheussl@apache.org Envoyé : mercredi 16 novembre 2005 00:03 >>> >>> For the checkstyle plugin this should be fixed in the current 3.0-SNAPSHOT (see http://jira.codehaus.org/browse/MPCHECKSTYLE-39 ), but it might still be a problem for other plugins. >>> >>> Gisbert, which plugins/reports do you have problems with?
Hide
Lukas Theussl added a comment -

For javadoc, did you try to set the maven.javadoc.locale property? If this works then we should set the default to maven.xdoc.locale.default.

In the jxr plugin, the maven.compile.encoding property from the java plugin is used (I think this is undocumented ), can you try if this helps?

Any other reports you have troubles with?

Show
Lukas Theussl added a comment - For javadoc, did you try to set the maven.javadoc.locale property? If this works then we should set the default to maven.xdoc.locale.default. In the jxr plugin, the maven.compile.encoding property from the java plugin is used (I think this is undocumented ), can you try if this helps? Any other reports you have troubles with?
Hide
Lukas Theussl added a comment -

Closing as won't fix since it 's not an xdoc specific issue.Please open an issue in the respective plugins if you still have problems with certain reports.

Show
Lukas Theussl added a comment - Closing as won't fix since it 's not an xdoc specific issue.Please open an issue in the respective plugins if you still have problems with certain reports.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: