svn commit: r508971 - in /tapestry/tapestry5/tapestry-component-report/trunk/src/site: ./ apt/ apt/index.apt resources/ resources/images/ resources/images/asf_logo_wide.gif site.xml

[hl...@apache.org]

Author: hlship
Date: Sun Feb 18 12:06:42 2007
New Revision: 508971

URL: http://svn.apache.org/viewvc?view=rev&rev=508971
Log:
Add site documentation

Added:
    tapestry/tapestry5/tapestry-component-report/trunk/src/site/
    tapestry/tapestry5/tapestry-component-report/trunk/src/site/apt/
    tapestry/tapestry5/tapestry-component-report/trunk/src/site/apt/index.apt
    tapestry/tapestry5/tapestry-component-report/trunk/src/site/resources/
    tapestry/tapestry5/tapestry-component-report/trunk/src/site/resources/images/
    tapestry/tapestry5/tapestry-component-report/trunk/src/site/resources/images/asf_logo_wide.gif   (with props)
    tapestry/tapestry5/tapestry-component-report/trunk/src/site/site.xml

Added: tapestry/tapestry5/tapestry-component-report/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-component-report/trunk/src/site/apt/index.apt?view=auto&rev=508971
==============================================================================
--- tapestry/tapestry5/tapestry-component-report/trunk/src/site/apt/index.apt (added)
+++ tapestry/tapestry5/tapestry-component-report/trunk/src/site/apt/index.apt Sun Feb 18 12:06:42 2007
@@ -0,0 +1,36 @@
+ ----
+ Tapestry Component Parameters Report
+ ----
+ 
+Tapestry Component Parameters Report
+
+  This report generates a comprehensive listing of all the components in your module (either a component library or
+  a Tapestry application). For each component, the inheritance, description and complete set of parameters (including inherited parameters)
+  are displayed.
+ 
+* Usage
+
+  Just add the following to the reporting/plugins section of your POM:
+  
++---+
+<plugin>
+    <groupId>org.apache.tapestry</groupId>
+    <artifactId>tapestry-component-report</artifactId>
+    <version>5.0.2-SNAPSHOT</version>
+    <configuration>
+        <rootPackage>org.example.myapp</rootPackage>
+    </configuration>                
+</plugin>
++---+
+
+  Be sure the update the \<version\> element with the current version of the Maven plugin, and update the
+  \<rootPackage\> element with the value for your application (this will match the value you configure inside
+  your
+  {{{http://tapestry.apache.org/tapestry5/tapestry-core/conf.html}web.xml}}).
+  
+* Limitations
+
+  Doesn't recognize Mixins unless they have parameters.
+  
+  Doesn't have any way to generate parameters for base classes from another library; the tools assume that the components
+  are entirely self-contained within the current model.
\ No newline at end of file

Added: tapestry/tapestry5/tapestry-component-report/trunk/src/site/resources/images/asf_logo_wide.gif
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-component-report/trunk/src/site/resources/images/asf_logo_wide.gif?view=auto&rev=508971
==============================================================================
Binary file - no diff available.

Propchange: tapestry/tapestry5/tapestry-component-report/trunk/src/site/resources/images/asf_logo_wide.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: tapestry/tapestry5/tapestry-component-report/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/tapestry-component-report/trunk/src/site/site.xml?view=auto&rev=508971
==============================================================================
--- tapestry/tapestry5/tapestry-component-report/trunk/src/site/site.xml (added)
+++ tapestry/tapestry5/tapestry-component-report/trunk/src/site/site.xml Sun Feb 18 12:06:42 2007
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- 
+    Copyright 2007 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
+    http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<project name="Tapestry Core">
+    <bannerLeft>
+        <name>Tapestry</name>
+        <href>http://tapestry.apache.org/</href>
+        <src>images/tapestry_banner.gif</src>
+    </bannerLeft>
+    <bannerRight>
+        <name>Apache</name>
+        <href>http://www.apache.org</href>
+        <src>images/asf_logo_wide.gif</src>
+    </bannerRight>
+    <skin>
+        <groupId>org.apache.tapestry</groupId>
+        <artifactId>maven-skin</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </skin>
+    
+    <publishDate format="dd MMM yyyy" />
+    
+    <body>
+        <links>
+            <item name="Tapestry" href="http://tapestry.apache.org/" />
+            <item name="Apache" href="http://www.apache.org/" />
+        </links>
+        
+       
+        <menu name="Tapestry Component Report">
+            <item name="Usage" href="index.html"/>
+       </menu> 
+        
+        <menu ref="reports"/>
+        
+    </body>
+</project>