geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jdil...@apache.org
Subject svn commit: r437957 - in /geronimo/genesis/trunk/config/geronimo-skin/src/site: apt/usage.apt site.xml
Date Tue, 29 Aug 2006 04:28:04 GMT
Author: jdillon
Date: Mon Aug 28 21:28:04 2006
New Revision: 437957

URL: http://svn.apache.org/viewvc?rev=437957&view=rev
Log:
Adding usage

Added:
    geronimo/genesis/trunk/config/geronimo-skin/src/site/apt/usage.apt
Modified:
    geronimo/genesis/trunk/config/geronimo-skin/src/site/site.xml

Added: geronimo/genesis/trunk/config/geronimo-skin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/geronimo/genesis/trunk/config/geronimo-skin/src/site/apt/usage.apt?rev=437957&view=auto
==============================================================================
--- geronimo/genesis/trunk/config/geronimo-skin/src/site/apt/usage.apt (added)
+++ geronimo/genesis/trunk/config/geronimo-skin/src/site/apt/usage.apt Mon Aug 28 21:28:04
2006
@@ -0,0 +1,90 @@
+ ------
+ Genesis Geronimo Skin
+ ------
+ ???
+ ------
+ ???
+
+Usage
+
+ To use this skin for a module, the skin needs to be specified in the modules
+ <<<site.xml>>>, or the module need to inherit from a module which has
that
+ configuration it it's <<<site.xml>>>.
+ 
+ Normally this is done automatically for projects that use <<<project-config>>>
+ as the parent of the projects top-level pom.
+ 
+* Standalone Example
+
++----------+
+<project name="${project.name}">
+    <skin>
+        <groupId>org.apache.geronimo.genesis.config</groupId>
+        <artifactId>geronimo-skin</artifactId>
+        <version>1.1-SNAPSHOT</version>
+    </skin>
+    
+    <publishDate format="dd MMM yyyy"/>
+    
+    <bannerLeft>
+        <src>images/topleft_logo_437x64.gif</src>
+        <href>http://geronimo.apache.org</href>
+    </bannerLeft>
+    
+    <body>
+        
+        ${parentProject}
+        
+        ${modules}
+        
+        ${reports}
+        
+    </body>
+</project>
++----------+
+
+* Top-level Example
+
+ For projects which inherit from <<<project-config>>> the skin is picked
up
+ automatically.
+ 
+ <<NOTE:>> That the top-level omits <<<$\{parentProject\}>>>
to avoid listing any
+ genesis bits in the generated site navigation.
+
++----------+
+<project name="${project.name}">
+    
+    <body>
+        
+        ${modules}
+        
+        ${reports}
+        
+    </body>
+
+</project>
++----------+
+
+* Module Example
+
+ For projects which inherit from <<<project-config>>> the skin is picked
up
+ automatically.
+ 
+ Children modules however should display links to their parent, so they need
+ to include <<<$\{parentProject\}>>>.
+
++----------+
+<project name="${project.name}">
+    
+    <body>
+        
+        ${parentProject}
+        
+        ${modules}
+        
+        ${reports}
+        
+    </body>
+
+</project>
++----------+

Modified: geronimo/genesis/trunk/config/geronimo-skin/src/site/site.xml
URL: http://svn.apache.org/viewvc/geronimo/genesis/trunk/config/geronimo-skin/src/site/site.xml?rev=437957&r1=437956&r2=437957&view=diff
==============================================================================
--- geronimo/genesis/trunk/config/geronimo-skin/src/site/site.xml (original)
+++ geronimo/genesis/trunk/config/geronimo-skin/src/site/site.xml Mon Aug 28 21:28:04 2006
@@ -28,6 +28,11 @@
         
         ${modules}
         
+        <menu name="${project.name}">
+            <item name="Overview" href="index.html"/>
+            <item name="Usage" href="usage.html"/>
+        </menu>
+        
         ${reports}
         
     </body>



Mime
View raw message