You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Herv? BOUTEMY (JIRA)" <ji...@codehaus.org> on 2006/01/09 08:05:01 UTC

[jira] Commented: (MPLUGIN-7) Reformat the autogenerated goal parameters page to improve readibility.

    [ http://jira.codehaus.org/browse/MPLUGIN-7?page=comments#action_55270 ] 

Hervé BOUTEMY commented on MPLUGIN-7:
-------------------------------------

I tried to rewrite PluginXdocGenerator as a MavenReport, but I could not figure out how to use AbstractMavenMultiPageReport : did not find any documentation nor report using it.

Now I have code to write the new HTML report as a unique page : overview + 1 section per goal

If I don't find how to break it into multiple pages, I'll publish this version here : it's better than nothing and I hope it will help

> Reformat the autogenerated goal parameters page to improve readibility.
> -----------------------------------------------------------------------
>
>          Key: MPLUGIN-7
>          URL: http://jira.codehaus.org/browse/MPLUGIN-7
>      Project: Maven 2.x Plugin Plugin
>         Type: Improvement

>  Environment: any, jdk 1.4.2_06
>     Reporter: Corridor Software Developer
>     Priority: Minor

>
> Original Estimate: 8 hours
>         Remaining: 8 hours
>
> The goal plugin:xdoc creates a table describing the parameters for a plugin. An example may be found here: http://mojo.codehaus.org/xmlbeans-maven-plugin/xmlbeans-mojo.html
> In the example, notice that the nowrap on the type, expression and default-value columns causes the descriptions to be crammed into the right side of the page.
> So rather than having these values in their own columns, position them in rows below the parameter as is done in the maven-model documentation for the project descriptor. This way the fields don't compete for space across the page: 
> http://maven.apache.org/maven2/maven-model/maven.html
> What's more, the inclusion of hyperlinked xml at the top of the page describing the configuration section of the plugin would benefit the end user without manual effort of the plugin developer.

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org