Author: dennisl
Date: Thu Apr  5 21:51:43 2012
New Revision: 1310089

URL: http://svn.apache.org/viewvc?rev=1310089&view=rev
Log:
[MSITE-638] site.xml <custom> parameter and template variables not documented

Modified:
    
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt

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=1310089&r1=1310088&r2=1310089&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 
Thu Apr  5 21:51:43 2012
@@ -356,6 +356,29 @@ Configuring the Site Descriptor
   If you don't specify a skin, the Site Plugin will use
   {{{http://maven.apache.org/skins/maven-default-skin/}Maven Default Skin}}.
 
+* Custom Properties
+
+  The authors of skins have the option to use custom properties that are unique
+  to their skin. The users of the skin can then specify their own values for
+  these properties in their <<<site.xml>>> using the <<<\<custom\>>>> element.
+
+  One skin that uses this is the Maven Fluido Skin. There are many examples on
+  {{{http://maven.apache.org/skins/maven-fluido-skin/}their site}} showing what
+  is possible to do with custom properties. Here is one example:
+
++-----+
+<project>
+  ...
+  <custom>
+    <fluidoSkin>
+      <topBarEnabled>true</topBarEnabled>
+      <sideBarEnabled>false</sideBarEnabled>
+    </fluidoSkin>
+  </custom>
+  ...
+</project>
++-----+
+
 * Expressions
 
   The <<<site.xml>>> can contain some expressions, like 
<<<$\{project.name\}>>>.


Reply via email to