Uploaded image for project: 'Maven Plugin Tools'
  1. Maven Plugin Tools
  2. MPLUGIN-7

Reformat the autogenerated goal parameters page to improve readibility.

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • None
    • 2.2
    • None
    • None
    • any, jdk 1.4.2_06

    Description

      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.

      Attachments

        1. assembly-mojo.html
          11 kB
          Edwin Punzalan
        2. MPLUGIN-7-maven-plugin-tools-api.patch
          6 kB
          Edwin Punzalan
        3. MPLUGIN-7-maven-plugin-tools-api.patch
          12 kB
          Edwin Punzalan
        4. MPLUGIN-7-maven-plugin-tools-api.patch
          11 kB
          Edwin Punzalan
        5. assembly-mojo.html
          11 kB
          Edwin Punzalan
        6. assembly-mojo.html
          19 kB
          Edwin Punzalan
        7. MPLUGIN-7-maven-plugin-tools-api.patch
          11 kB
          Edwin Punzalan
        8. MPLUGIN-7-maven-plugin-tools-api.patch
          10 kB
          Edwin Punzalan
        9. assembly-mojo.html
          24 kB
          Edwin Punzalan
        10. xmlbeans-mojo2.html
          15 kB
          Herve Boutemy
        11. xmlbeans-mojo1.html
          18 kB
          Herve Boutemy

        Issue Links

          Activity

            People

              elpunzalan Edwin Punzalan
              corridor Corridor Software Developer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - 8h Original Estimate - 8h
                  8h
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 15h
                  15h