maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Benjamin Bentmann (JIRA)" <j...@codehaus.org>
Subject [jira] Commented: (SUREFIRE-267) Add a window and a document title plus a document description (like made in javadoc and jxr plugin)
Date Sun, 06 Jan 2008 13:50:57 GMT

    [ http://jira.codehaus.org/browse/SUREFIRE-267?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_118898
] 

Benjamin Bentmann commented on SUREFIRE-267:
--------------------------------------------

While it's surely a nice feature to customize the window/document title for the report, I
would like to raise the following questions about the proposed solution.

Isn't this a more general feature? At first look, I would rather say that customizable titles
would be of interest not only for the Surefire report but other reports as well. E.g. I could
just go ahead and open a related issue for the Changes plugin because I would like to have
its report named "Release History" instead of "Changes Report". But if each plugin implements
this feature on its own, things get error-prone, hard to maintain and might be inconsistent.
Therefore it seems this feature is best realized at some general/shared place like the Site
plugin or Doxia.

What about internationalization? One can tell the Site plugin to output reports for various
locales but the proposed patch limits the user to only one title string (i.e. only one locale).
This does not fit together. If the user wants to properly change the title strings, he would
need to specify something like a map locale > string.

I could imagine something like this in the POM:
{code:xml}
<reportSet>
  <titles>
     <en>My English Title for the Report</en>
     <de>Mein Deutscher Titel für den Bericht</de>
  </titles>
</reportSet>
{code}
Letting the user provide customized resource bundles as some kind of overlay for the plugin's
internal bundle might be another approach but this seems kind of overdressed to me.

> Add a window and a document title plus a document description (like made in javadoc and
jxr plugin)
> ---------------------------------------------------------------------------------------------------
>
>                 Key: SUREFIRE-267
>                 URL: http://jira.codehaus.org/browse/SUREFIRE-267
>             Project: Maven Surefire
>          Issue Type: New Feature
>          Components: report plugin
>    Affects Versions: 2.0 Report Plugin
>         Environment: WinXp, Java5
>            Reporter: Martin Zeltner
>             Fix For: 2.x
>
>         Attachments: patch_maven-surefire-report-plugin_add-window-and-doc-title-plus-doc-description.patch
>
>   Original Estimate: 10 minutes
>  Remaining Estimate: 10 minutes
>
> Add a window and a document title plus a document description (like made in javadoc and
jxr plugin). By default the windowTitle, docTitle and docDescription are taken from the resource
bundle but if one likes to use a specific (like made in javadoc and jxr plugin) these three
parameters can be personalized. See appended patch.
> Cheers,
> Martin

-- 
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

       

Mime
View raw message