[ http://jira.codehaus.org/browse/MPLUGIN-7?page=comments#action_68402 ]
Brett Porter commented on MPLUGIN-7: ------------------------------------ we will need to do this without the multi-page feature for now. Edwin - that latest page looks good, however - I'd avoid using tables in the lower section and I'd include the description again (more like Javadoc). - Instead of Optional? Yes I'd say "Required: Yes/No". - In the table at the top, I think since the type is short I'd put it in it's own column which will make it more compact. - I'd suggest splitting the top table into 2 tables: first, "required fields" and "optional fields" > 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 > Assignee: Edwin Punzalan > Priority: Minor > Attachments: MPLUGIN-7-maven-plugin-tools-api.patch, assembly-mojo.html, > xmlbeans-mojo1.html, xmlbeans-mojo2.html > > Original Estimate: 8 hours > Time Spent: 10 hours > Remaining: 0 minutes > > 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
