site.xml <custom> parameter and template variables not documented
-----------------------------------------------------------------
Key: MSITE-552
URL: http://jira.codehaus.org/browse/MSITE-552
Project: Maven 2.x and 3.x Site Plugin
Issue Type: Bug
Reporter: SebbASF
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
--
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
