You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2012/04/08 00:29:03 UTC
svn commit: r1310895 -
/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
Author: dennisl
Date: Sat Apr 7 22:29:03 2012
New Revision: 1310895
URL: http://svn.apache.org/viewvc?rev=1310895&view=rev
Log:
Improve the documentation of the properties that are available in the Velocity context.
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt?rev=1310895&r1=1310894&r2=1310895&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/apt/index.apt Sat Apr 7 22:29:03 2012
@@ -55,31 +55,31 @@ Doxia Site Tools - Site Renderer
*---------------------------------+----------------------+-------------------------------+
|| variable || type || description ||
*---------------------------------+----------------------+-------------------------------+
-| <<<alignedFileName>>> | <<<String>>> | |
+| <<<alignedFileName>>> | <<<String>>> | The file name of the (html) document being rendered, relative to the document being rendered |
*---------------------------------+----------------------+-------------------------------+
-| <<<authors>>> | <<<List\<String\>>>> | |
+| <<<authors>>> | <<<List\<String\>>>> | A list of authors from the source document |
*---------------------------------+----------------------+-------------------------------+
| <<<bodyContent>>> | <<<String>>> | |
*---------------------------------+----------------------+-------------------------------+
-| <<<decoration>>> | {{{../doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html}<<<DecorationModel>>>}} | |
+| <<<decoration>>> | {{{../doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html}<<<DecorationModel>>>}} | This is a model that represents the data in your <<<site.xml>>> |
*---------------------------------+----------------------+-------------------------------+
-| <<<currentDate>>> | <<<Date>>> | |
+| <<<currentDate>>> | <<<Date>>> | The date when the site is rendered |
*---------------------------------+----------------------+-------------------------------+
-| <<<currentFileName>>> | <<<String>>> | |
+| <<<currentFileName>>> | <<<String>>> | The file name of the (html) document being rendered, relative to the site root |
*---------------------------------+----------------------+-------------------------------+
-| <<<dateCreation>>> | <<<String>>> | |
+| <<<dateCreation>>> | <<<String>>> | The date specified in the source document, in the format "yyyyMMdd" |
*---------------------------------+----------------------+-------------------------------+
-| <<<dateFormat>>> | <<<DateFormat>>> | |
+| <<<dateFormat>>> | <<<DateFormat>>> | An instance of the default date format for the locale of the document being rendered |
*---------------------------------+----------------------+-------------------------------+
-| <<<dateRevision>>> | <<<String>>> | |
+| <<<dateRevision>>> | <<<String>>> | The date when the site is rendered, in the format "yyyyMMdd" |
*---------------------------------+----------------------+-------------------------------+
| <<<headContent>>> | <<<String>>> | |
*---------------------------------+----------------------+-------------------------------+
-| <<<locale>>> | <<<Locale>>> | |
+| <<<locale>>> | <<<Locale>>> | The locale for the document being rendered |
*---------------------------------+----------------------+-------------------------------+
-| <<<publishDate>>> | <<<Date>>> | |
+| <<<publishDate>>> | <<<Date>>> | An optional hardcoded publish date that has been set programmatically |
*---------------------------------+----------------------+-------------------------------+
-| <<<relativePath>>> | <<<String>>> | |
+| <<<relativePath>>> | <<<String>>> | The path to the site root from the document being rendered |
*---------------------------------+----------------------+-------------------------------+
| <<<shortTitle>>> | <<<String>>> | The title of the document, excluding the project or site name |
*---------------------------------+----------------------+-------------------------------+