Author: michaelo
Date: Wed Feb 24 22:48:11 2016
New Revision: 1732238
URL: http://svn.apache.org/viewvc?rev=1732238&view=rev
Log:
Improved docs for Doxia (Sitetools) 1.7 and Velocity 1.7 upgrade
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm?rev=1732238&r1=1732237&r2=1732238&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm
Wed Feb 24 22:48:11 2016
@@ -167,23 +167,9 @@ Creating Content
<<Note:>> {{{http://velocity.apache.org/}Apache Velocity}} is used to apply
the
filtering. Because Velocity uses a dot-notation to traverse beans you
<<cannot>>
- use dots in your properties defined in <<<\<properties\>>>>.
-
- If you declare these properties in your POM
-
-+-----+
- <properties>
- <!-- This will not work because the name of the property has a dot in it
-->
- <my.property>My value</my.property>
- <!-- This will work because the name of the property has no dot in it -->
- <myProperty>My other value</myProperty>
- </properties>
-+-----+
-
- and then use the expression <<<$\{my.property\}>>> in your document, it will
- <<not>> work. If you instead use the expression <<<$\{myProperty\}>>> it will
- work just fine. Alternatively, you can say
<<<${project.properties.get("my.property")}>>>
- which is cumbersome to write.
+ use dotted properties defined in <<<\<properties\>>>> directly. It is
generally
+ advised to access properties by using the <<<$context>>> tool.
+ E.g., with <<<$context.get("my.property")>>>.
Some properties are defined by default: see
{{{/doxia/doxia-sitetools/doxia-site-renderer/#Velocity_processing} Doxia
Site Renderer's Velocity processing reference}}
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt?rev=1732238&r1=1732237&r2=1732238&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
Wed Feb 24 22:48:11 2016
@@ -124,7 +124,7 @@ Configuring the Site Descriptor
</project>
+-----+
- The format of the "Last Published" date is the ISO date format that is
+ The format of the "Last Published" date is the ISO extended date format that
is
{{{http://www.w3.org/QA/Tips/iso-date}recommended by the W3C}}. Because the
web has an international, cross-cultural audience it is recommended to <not>
change the date format.
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt?rev=1732238&r1=1732237&r2=1732238&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/migrate.apt Wed Feb 24
22:48:11 2016
@@ -54,9 +54,11 @@ Migrate
</plugin>
+-----------------+
- * Site Decoration Model has changed type for <<<head>>>/<<<footer>>> from
DOM to String:
+ * Site Decoration Model has changed type for <<<head>>> and <<<footer>>>
from <<<DOM>>> to <<<String>>>:
if your <<<site.xml>>> (or one parent) contains XML content, you'll need to
escape it, usually by
adding <<<\<![CDATA[>>> and <<<]]\>>>>.
+
+ *
[]
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt?rev=1732238&r1=1732237&r2=1732238&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt Wed Feb 24
22:48:11 2016
@@ -52,9 +52,9 @@ mvn site
By default, the resulting site will be in the <<<target/site/>>> directory.
<<Note:>> If you have a multi module project, then the links between the
- parent and child modules will <not> work when you use '<<<mvn site>>>' or
- '<<<mvn site:site>>>'. If you want to use those links, you should use
- '<<<mvn site:stage>>>' instead. You can read more about that goal further
down on
+ parent and child modules will <not> work when you use <<<mvn site>>> or
+ <<<mvn site:site>>>. If you want to use those links, you should use
+ <<<mvn site:stage>>> instead. You can read more about that goal further down
on
this page in the section called '<Staging a Site>'.
<<Note:>> For performance reasons, Maven compares the timestamps of generated
