svn commit: r1736723 - in /maven/doxia/doxia-sitetools/trunk: doxia-integration-tools/src/site/apt/index.apt doxia-integration-tools/src/site/site.xml doxia-site-renderer/src/site/site.xml

[hb...@apache.org]

Author: hboutemy
Date: Sun Mar 27 07:30:21 2016
New Revision: 1736723

URL: http://svn.apache.org/viewvc?rev=1736723&view=rev
Log:
[DOXIASITETOOLS-158] added documentation about interpolation (late and early)

Modified:
    maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/index.apt
    maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/site.xml
    maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/site.xml

Modified: maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/index.apt?rev=1736723&r1=1736722&r2=1736723&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/index.apt (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/index.apt Sun Mar 27 07:30:21 2016
@@ -38,3 +38,36 @@ Maven Doxia Integration Tools
 * Usage
 
   Instructions on how to use the integration of Doxia in Maven can be found {{{./usage.html}here}}.
+
+* <<<site.xml>>> Decoration Model Interpolation
+
+  Interpolation of {{{../doxia-decoration-model/decoration.html}<<<site.xml>>> decoration model}} injects
+  Maven project's information, replacing <<<$\{...\}>>> with calculated values
+  like it happens in {{{/ref/current/maven-model-builder/#Model_Interpolation}Maven model interpolation}}.
+
+  Interpolation can be <<late>> or <<early>>:
+
+  * with <<late>> interpolation, replacement happens <<after>> inheritance. This is the classical behaviour in Maven pom,
+
+  * with <<early>> interpolation, replacement happens <<before>> inheritance: this was the default behaviour for <<<project.*>>>
+  values until Doxia Sitetools 1.7, when these early and late interpolation definitions didn't exist.
+  Since Doxia Sitetools 1.7.1, early interpolation happens for <<<this.*>>> values.
+
+  []
+
+  Values are evaluated in sequence from different syntaxes:
+
+*-------------+--------------+--------------------+------------------+
+|| late value || early value || evaluation result || common examples ||
+*-------------+--------------+--------------------+------------------+
+| <<<project.*>>>\
+<<<*>>> (<deprecated>) | <<<this.*>>> | POM content (see {{{/ref/current/maven-model/maven.html}POM reference}}) | <<<$\{project.version\}>>>\
+              |              |                    | <<<$\{this.url\}>>>
+*-------------+--------------+--------------------+------------------+
+| <<<*>>> | <<<this.*>>> | model properties, such as project properties set in the pom | <<<$\{any.key\}>>>\
+              |              |                    | <<<$\{this.any.key\}>>>
+*-------------+--------------+--------------------+------------------+
+| <<<env.*>>>\
+<<<*>>>       | <<<env.*>>>\
+              | <<<*>>>      | environment variables | <<<$\{env.PATH\}>>>\
+*-------------+--------------+--------------------+------------------+

Modified: maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/site.xml?rev=1736723&r1=1736722&r2=1736723&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/site.xml (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/site.xml Sun Mar 27 07:30:21 2016
@@ -32,6 +32,10 @@ under the License.
       <!--item name="FAQ" href="faq.html"/-->
     </menu>
 
+    <menu name="Reference">
+      <item name="site.xml Decoration Model" href="../doxia-decoration-model/decoration.html"/>
+    </menu>
+
     <menu ref="reports" />
   </body>
 </project>

Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/site.xml?rev=1736723&r1=1736722&r2=1736723&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/site.xml (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/site/site.xml Sun Mar 27 07:30:21 2016
@@ -34,6 +34,11 @@
       <!--item name="FAQ" href="faq.html"/-->
     </menu>
 
+    <menu name="Reference">
+      <item name="site.xml Decoration Model" href="../doxia-decoration-model/decoration.html"/>
+      <item name="Skin Model" href="../doxia-skin-model/skin.html"/>
+    </menu>
+
     <menu ref="reports"/>
 
   </body>