You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Corridor Software Developer (JIRA)" <ji...@codehaus.org> on 2005/10/05 05:03:11 UTC
[jira] Created: (MNG-1091) Reformat the autogenerated goal parameters page to improve readibility.
Reformat the autogenerated goal parameters page to improve readibility.
-----------------------------------------------------------------------
Key: MNG-1091
URL: http://jira.codehaus.org/browse/MNG-1091
Project: Maven 2
Type: Improvement
Components: maven-plugin-plugin
Versions: 2.0-beta-3
Environment: any, jdk 1.4.2_06
Reporter: Corridor Software Developer
Priority: Minor
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
[jira] Updated: (MNG-1091) Reformat the autogenerated goal parameters page to improve readibility.
Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-1091?page=all ]
Brett Porter updated MNG-1091:
------------------------------
Fix Version: (was: 2.0)
2.1
> Reformat the autogenerated goal parameters page to improve readibility.
> -----------------------------------------------------------------------
>
> Key: MNG-1091
> URL: http://jira.codehaus.org/browse/MNG-1091
> Project: Maven 2
> Type: Improvement
> Components: maven-plugin-plugin
> Versions: 2.0-beta-3
> Environment: any, jdk 1.4.2_06
> Reporter: Corridor Software Developer
> Assignee: Johnny R. Ruiz III
> Priority: Minor
> Fix For: 2.1
>
> 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
[jira] Updated: (MNG-1091) Reformat the autogenerated goal parameters page to improve readibility.
Posted by "Johnny R. Ruiz III (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-1091?page=all ]
Johnny R. Ruiz III updated MNG-1091:
------------------------------------
Assign To: Johnny R. Ruiz III
Remaining Estimate: 8 hours
Original Estimate: 28800
Currently this plugin generates an xdoc file describing the goals and parameters of the plugin.
Shouldn't be instead of generating an xdoc, we generate an HTML report??
Currently it generates html report about the goal but not about the parameter.
> Reformat the autogenerated goal parameters page to improve readibility.
> -----------------------------------------------------------------------
>
> Key: MNG-1091
> URL: http://jira.codehaus.org/browse/MNG-1091
> Project: Maven 2
> Type: Improvement
> Components: maven-plugin-plugin
> Versions: 2.0-beta-3
> Environment: any, jdk 1.4.2_06
> Reporter: Corridor Software Developer
> Assignee: Johnny R. Ruiz III
> Priority: Minor
> Fix For: 2.0-beta-4
>
> 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
[jira] Commented: (MPLUGIN-7) Reformat the autogenerated goal
parameters page to improve readibility.
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MPLUGIN-7?page=comments#action_55294 ]
Vincent Siveton commented on MPLUGIN-7:
---------------------------------------
Hervé,
FYI plugin:xdoc is already implemented as a MavenReport, according the MNG-706 issue
http://svn.apache.org/viewcvs.cgi?rev=291309&view=rev
http://maven.apache.org/plugins/maven-plugin-plugin/report-mojo.html
Here is a small thread about AbstractMavenMultiPageReport subject:
http://www.nabble.com/multi-page-reports-t690194.html#a1915556
HTH
Thanks a lot for your support.
> 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
[jira] Commented: (MPLUGIN-7) Reformat the autogenerated goal
parameters page to improve readibility.
Posted by "Herv? BOUTEMY (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MPLUGIN-7?page=comments#action_55325 ]
Hervé BOUTEMY commented on MPLUGIN-7:
-------------------------------------
Hi Vincent,
Sorry, I did not explain myself clearly : I'm new to Maven2 internals (which are huge, but great)...
What I'm trying to do is to replace xdoc gerenation (what is done currently) by direct HTML generation through Sink API (what is proposed by Johnny and Brett on previous comments).
To do that, I need a way to create multiple pages with Sink API.
AbstractMultiPageReport has startPage(outputName) and endPage(MultiPageSink) methods : that seems to be here just for this need.
But when I call startPage, I get a NPE...
I could not find any Report using this API : when multi-page is needed, everybody seems to go back to xdoc generation (that's the "solution" proposed in the thread you quote).
Do you know how this class works ?
Thank for your interest and 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
[jira] Commented: (MPLUGIN-7) Reformat the autogenerated goal
parameters page to improve readibility.
Posted by "Herv? BOUTEMY (JIRA)" <ji...@codehaus.org>.
[ 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
[jira] Commented: (MNG-1091) Reformat the autogenerated goal parameters page to improve readibility.
Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-1091?page=comments#action_48482 ]
Brett Porter commented on MNG-1091:
-----------------------------------
yes, it should be direct to HTML eventually.
> Reformat the autogenerated goal parameters page to improve readibility.
> -----------------------------------------------------------------------
>
> Key: MNG-1091
> URL: http://jira.codehaus.org/browse/MNG-1091
> Project: Maven 2
> Type: Improvement
> Components: maven-plugin-plugin
> Versions: 2.0-beta-3
> Environment: any, jdk 1.4.2_06
> Reporter: Corridor Software Developer
> Assignee: Johnny R. Ruiz III
> Priority: Minor
> Fix For: 2.0-beta-4
>
> 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
[jira] Updated: (MNG-1091) Reformat the autogenerated goal parameters page to improve readibility.
Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-1091?page=all ]
Brett Porter updated MNG-1091:
------------------------------
Fix Version: 2.0-beta-4
> Reformat the autogenerated goal parameters page to improve readibility.
> -----------------------------------------------------------------------
>
> Key: MNG-1091
> URL: http://jira.codehaus.org/browse/MNG-1091
> Project: Maven 2
> Type: Improvement
> Components: maven-plugin-plugin
> Versions: 2.0-beta-3
> Environment: any, jdk 1.4.2_06
> Reporter: Corridor Software Developer
> Priority: Minor
> Fix For: 2.0-beta-4
>
>
> 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