Author: hboutemy
Date: Thu Oct 27 23:05:42 2011
New Revision: 1190074
URL: http://svn.apache.org/viewvc?rev=1190074&view=rev
Log:
[DOXIASITETOOLS-51] added the list of variable defined in 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=1190074&r1=1190073&r2=1190074&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
Thu Oct 27 23:05:42 2011
@@ -44,3 +44,54 @@ Doxia Site Tools - Site Renderer
{{{http://docs.codehaus.org/display/MAVENUSER/Maven+Skins}more skins are
listed in MAVENUSER wiki}}.
Some documentation is available on
{{{/plugins/maven-site-plugin/examples/creatingskins.html}how to write a new
skin}}.
+
+* Velocity processing
+
+ When their file names end in <<<.vm>>>, documents are processed by Velocity.
+
+ The velocity context defines some variables:
+
+*---------------------------------+--------------------+-------------------------------+
+|| variable || type || description
||
+*---------------------------------+--------------------+-------------------------------+
+| <<<relativePath>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<authors>>> | <<<List\<String\>>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<title>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<headContent>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<bodyContent>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<decoration>>> |
{{{../doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html}<<<DecorationModel>>>}}
| |
+*---------------------------------+--------------------+-------------------------------+
+| <<<dateCreation>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<dateRevision>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<currentDate>>> | <<<Date>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<dateFormat>>> | <<<DateFormat>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<currentFileName>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<alignedFileName>>> | <<<String>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<locale>>> | <<<Locale>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<supportedLocales>>> | <<<List\<Locale\>>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| template properties | |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<PathTool>>> | <<<PathTool>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<FileUtils>>> | <<<FileUtils>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<StringUtils>>> | <<<StringUtils>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+| <<<i18n>>> | <<<i18n>>> |
|
+*---------------------------------+--------------------+-------------------------------+
+
+ see
<<<{{{./xref/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.html#426}DefaultSiteRenderer.createContext(...)}}>>>
+ source for more details.
