Uploaded image for project: 'Maven Site Plugin'
  1. Maven Site Plugin
  2. MSITE-638

site.xml <custom> parameter and template variables not documented

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.1
    • Labels:
      None

      Description

      There's no proper documentation on the Maven site descriptor "custom" tag.
      It's not mentioned in the main documentation [1], and is only mentioned in passing in [2] - which in turn is not referenced from [1]

      Here are the full details from [2]:

      custom DOM Custom configuration for use with customized Velocity templates

      The DOM reference above appears to be an instance of Xpp3Dom [3].

      Also, the Doxia code sets various context variables (in DefaultSiteRenderer ?).

      This should all be documented, along with some simple examples, and referenced as necessary from the Maven site plugin documentation

      [1] http://maven.apache.org/plugins/maven-site-plugin/examples/sitedescriptor.html
      [2] http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html
      [3] http://plexus.codehaus.org/plexus-utils/apidocs/org/codehaus/plexus/util/xml/Xpp3Dom.html

        Attachments

          Activity

            People

            • Assignee:
              dennisl@apache.org Dennis Lundberg
              Reporter:
              sebb Sebb
            • Votes:
              2 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: