You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "SebbASF (JIRA)" <ji...@codehaus.org> on 2011/02/11 00:38:22 UTC
[jira] Created: (MSITE-552) site.xml parameter and
template variables not documented
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
[jira] (MSITE-638) site.xml parameter and template
variables not documented
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/MSITE-638?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dennis Lundberg moved DOXIASITETOOLS-51 to MSITE-638:
-----------------------------------------------------
Component/s: (was: Decoration model)
site descriptor
documentation
Key: MSITE-638 (was: DOXIASITETOOLS-51)
Project: Maven 2.x and 3.x Site Plugin (was: Maven Doxia Sitetools)
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: MSITE-638
> URL: https://jira.codehaus.org/browse/MSITE-638
> Project: Maven 2.x and 3.x Site Plugin
> Issue Type: Bug
> Components: documentation, site descriptor
> 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, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIASITETOOLS-51) site.xml parameter
and template variables not documented
Posted by "Herve Boutemy (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/DOXIASITETOOLS-51?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=282283#comment-282283 ]
Herve Boutemy commented on DOXIASITETOOLS-51:
---------------------------------------------
variable list added in [r1190074|http://svn.apache.org/viewvc?rev=1190074&view=rev]
please review and help polishing
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: DOXIASITETOOLS-51
> URL: https://jira.codehaus.org/browse/DOXIASITETOOLS-51
> Project: Maven Doxia Sitetools
> 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.
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIASITETOOLS-51) site.xml parameter
and template variables not documented
Posted by "Robert Scholte (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/DOXIASITETOOLS-51?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=282334#comment-282334 ]
Robert Scholte commented on DOXIASITETOOLS-51:
----------------------------------------------
Hervé,
Once DOXIA-450 is released, we can use the [ContextTool|http://velocity.apache.org/tools/releases/2.0/javadoc/org/apache/velocity/tools/generic/ContextTool.html] to display all available variables.
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: DOXIASITETOOLS-51
> URL: https://jira.codehaus.org/browse/DOXIASITETOOLS-51
> Project: Maven Doxia Sitetools
> 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.
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (DOXIASITETOOLS-51) site.xml parameter and template
variables not documented
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/DOXIASITETOOLS-51?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dennis Lundberg updated DOXIASITETOOLS-51:
------------------------------------------
Component/s: Decoration model
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: DOXIASITETOOLS-51
> URL: https://jira.codehaus.org/browse/DOXIASITETOOLS-51
> Project: Maven Doxia Sitetools
> Issue Type: Bug
> Components: Decoration model
> 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, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIASITETOOLS-51) site.xml parameter
and template variables not documented
Posted by "Herve Boutemy (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/DOXIASITETOOLS-51?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=276314#comment-276314 ]
Herve Boutemy commented on DOXIASITETOOLS-51:
---------------------------------------------
FYI, link to [2] reworded in [r1157576|http://svn.apache.org/viewvc?rev=1157576&view=rev]
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: DOXIASITETOOLS-51
> URL: https://jira.codehaus.org/browse/DOXIASITETOOLS-51
> Project: Maven Doxia Sitetools
> 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.
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (DOXIASITETOOLS-51) site.xml parameter
and template variables not documented
Posted by "Herve Boutemy (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/DOXIASITETOOLS-51?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=282279#comment-282279 ]
Herve Boutemy commented on DOXIASITETOOLS-51:
---------------------------------------------
custom field description improved in [r1190057|http://svn.apache.org/viewvc?rev=1190057&view=rev]
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: DOXIASITETOOLS-51
> URL: https://jira.codehaus.org/browse/DOXIASITETOOLS-51
> Project: Maven Doxia Sitetools
> 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.
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Moved: (DOXIASITETOOLS-51) site.xml parameter and
template variables not documented
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIASITETOOLS-51?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dennis Lundberg moved MSITE-552 to DOXIASITETOOLS-51:
-----------------------------------------------------
Key: DOXIASITETOOLS-51 (was: MSITE-552)
Project: Maven Doxia Sitetools (was: Maven 2.x and 3.x Site Plugin)
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: DOXIASITETOOLS-51
> URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-51
> Project: Maven Doxia Sitetools
> 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
[jira] (MSITE-638) site.xml parameter and template
variables not documented
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/MSITE-638?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dennis Lundberg closed MSITE-638.
---------------------------------
Resolution: Fixed
Fix Version/s: 3.1
Assignee: Dennis Lundberg
Fixed in [r1310089|http://svn.apache.org/viewvc?view=revision&revision=1310089].
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: MSITE-638
> URL: https://jira.codehaus.org/browse/MSITE-638
> Project: Maven 2.x and 3.x Site Plugin
> Issue Type: Bug
> Components: documentation, site descriptor
> Reporter: SebbASF
> Assignee: Dennis Lundberg
> Fix For: 3.1
>
>
> 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, please contact your JIRA administrators: https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MSITE-552) site.xml parameter and
template variables not documented
Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MSITE-552?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=255782#action_255782 ]
Dennis Lundberg commented on MSITE-552:
---------------------------------------
Yes the custom element seems to need better documentation, which should be at the Doxia site.
In paragraph 3 in [1] has a link to [2]. That should be enough for the Site Plugin portion of this issue.
> 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
[jira] Commented: (DOXIASITETOOLS-51) site.xml parameter
and template variables not documented
Posted by "SebbASF (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/DOXIASITETOOLS-51?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=255791#action_255791 ]
SebbASF commented on DOXIASITETOOLS-51:
---------------------------------------
The link to [2] is entitled "XML Schema Reference for the site descriptor" which could be better worded, for example:
"full reference for the site descriptor"
> site.xml <custom> parameter and template variables not documented
> -----------------------------------------------------------------
>
> Key: DOXIASITETOOLS-51
> URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-51
> Project: Maven Doxia Sitetools
> 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