Maven Surefire
  1. Maven Surefire
  2. SUREFIRE-267

Add a window and a document title plus a document description (like made in javadoc and jxr plugin)

    Details

    • Type: New Feature New Feature
    • Status: Open Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 2.0 Report Plugin
    • Fix Version/s: Backlog
    • Labels:
      None
    • Environment:
      WinXp, Java5
    • Number of attachments :
      1

      Description

      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

        Issue Links

          Activity

          Hide
          Dan Fabulich added a comment -

          I definitely like the idea of adding a title to the surefire reports document, but I hesitate to add yet more options to this plugin, which already has a lot of options, especially ones that sound so similar. (Shall I set the docTitle or the windowTitle? Does the docTitle show up at the top, or is it the docDescription?)

          Perhaps a smaller version that just manages the document title, and uses that for the same purpose as the docTitle?

          Show
          Dan Fabulich added a comment - I definitely like the idea of adding a title to the surefire reports document, but I hesitate to add yet more options to this plugin, which already has a lot of options, especially ones that sound so similar. (Shall I set the docTitle or the windowTitle? Does the docTitle show up at the top, or is it the docDescription?) Perhaps a smaller version that just manages the document title, and uses that for the same purpose as the docTitle?
          Hide
          Benjamin Bentmann added a comment -

          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:

          <reportSet>
            <titles>
               <en>My English Title for the Report</en>
               <de>Mein Deutscher Titel für den Bericht</de>
            </titles>
          </reportSet>
          

          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.

          Show
          Benjamin Bentmann added a comment - 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: <reportSet> <titles> <en> My English Title for the Report </en> <de> Mein Deutscher Titel für den Bericht </de> </titles> </reportSet> 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.
          Hide
          Vincent Siveton added a comment -

          Benjamin, I am not really in favour on this i18n approach. Let s discuss it on the wiki or on dev@

          FYI we have an I18N proposal here:
          http://docs.codehaus.org/display/MAVEN/I18N+Plugin+Description

          Show
          Vincent Siveton added a comment - Benjamin, I am not really in favour on this i18n approach. Let s discuss it on the wiki or on dev@ FYI we have an I18N proposal here: http://docs.codehaus.org/display/MAVEN/I18N+Plugin+Description
          Hide
          Benjamin Bentmann added a comment -

          I'm quite fine with any other approach. My only intention was to point out the problem with the existing patch for this issue to prevent its premature adaption. The solution I proposed was just to give an inspiration, it's not my wish. Personally, I have no need for multiple locales in the site anyway (writing good documentation for a single language is quite enough work...) so it's a rather a theoretical concern for me

          Show
          Benjamin Bentmann added a comment - I'm quite fine with any other approach. My only intention was to point out the problem with the existing patch for this issue to prevent its premature adaption. The solution I proposed was just to give an inspiration, it's not my wish. Personally, I have no need for multiple locales in the site anyway (writing good documentation for a single language is quite enough work...) so it's a rather a theoretical concern for me

            People

            • Assignee:
              Unassigned
              Reporter:
              Martin Zeltner
            • Votes:
              2 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:

                Time Tracking

                Estimated:
                Original Estimate - 10 minutes
                10m
                Remaining:
                Remaining Estimate - 10 minutes
                10m
                Logged:
                Time Spent - Not Specified
                Not Specified