Author: rdonkin
Date: Sat Jan 17 08:33:10 2009
New Revision: 735307
URL: http://svn.apache.org/viewvc?rev=735307&view=rev
Log:
Added an example
Added:
james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/examples/
james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/examples/standard.apt
Modified:
james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml
james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml
Added:
james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/examples/standard.apt
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/examples/standard.apt?rev=735307&view=auto
==============================================================================
---
james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/examples/standard.apt
(added)
+++
james/mailet/maven-mailetdocs-plugin/trunk/src/site/apt/examples/standard.apt
Sat Jan 17 08:33:10 2009
@@ -0,0 +1,47 @@
+ ------
+ Standard Mailets Example
+ ------
+ Apache JAMES Project Team
+ ------
+ 2009-01-17
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you 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.
+
+Cataloging A Large Project
+
+ {{{http://james.apache.org/mailet/standard} James Standard Mailets}} contains
+ more than 50 matchers and mailets. MailetDocs is used to generate a
+ {{{http://james.apache.org/mailet/standard/mailet-report.html} catalog}} with
+ reports on each mailet and matcher (for example
+
{{{http://james.apache.org/mailet/standard/mailet-report.html#HasHeader}HasHeader}}).
+
+ Setting up this report is easy. Just add the plugin to the <<<reporting>>>
section.
+ For example:
+
++----------------------------------------------
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.james</groupId>
+ <artifactId>maven-mailetdocs-plugin</artifactId>
+ <version>0.1</version>
+ </plugin>
+ ...
++----------------------------------------------
+
\ No newline at end of file
Modified: james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml?rev=735307&r1=735306&r2=735307&view=diff
==============================================================================
--- james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml (original)
+++ james/mailet/maven-mailetdocs-plugin/trunk/src/site/site.xml Sat Jan 17
08:33:10 2009
@@ -41,6 +41,10 @@
href="doap_crypto-mailets.rdf"
img='http://www.w3.org/RDF/icons/rdf_metadata_button.32'/>
</menu>
+
+ <menu name='Examples'>
+ <item name='Large Catalog' href='examples/standard.html'/>
+ </menu>
<menu name="Mailet">
<item name="API" href="http://james.apache.org/mailet/api"/>
Modified: james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml?rev=735307&r1=735306&r2=735307&view=diff
==============================================================================
--- james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml
(original)
+++ james/mailet/maven-mailetdocs-plugin/trunk/src/site/xdoc/index.xml Sat Jan
17 08:33:10 2009
@@ -32,6 +32,11 @@
<ul>
<li><a href='mailetdocs-mojo.html'>mailetdocs:mailetdocs</a>
Generates catelog and reports on mailets and matchers</li>
</ul>
+ </subsection>
+ <subsection name='Examples'>
+ <ul>
+ <li><a href='examples/standard.html'>Cataloging A Large
Project</a></li>
+ </ul>
</subsection>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
