You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2007/07/21 02:57:21 UTC
svn commit: r558210 - in
/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site:
apt/examples/incorporating-report-into-site.apt apt/index.apt site.xml
Author: dennisl
Date: Fri Jul 20 17:57:20 2007
New Revision: 558210
URL: http://svn.apache.org/viewvc?view=rev&rev=558210
Log:
o Add an example on how to incorporate a swizzle report into a site.
Added:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/incorporating-report-into-site.apt (with props)
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml
Added: maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/incorporating-report-into-site.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/incorporating-report-into-site.apt?view=auto&rev=558210
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/incorporating-report-into-site.apt (added)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/incorporating-report-into-site.apt Fri Jul 20 17:57:20 2007
@@ -0,0 +1,88 @@
+ ------
+ Incorporating a Report Into a Site
+ ------
+ Dennis Lundberg
+ ------
+ 2007-07-21
+ ------
+
+ ~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Incorporating a Report Into a Site
+
+ You might want to incorporate a report into your project's site. This can be
+ achieved by adding an <<<execution>>> to your <<<pom.xml>>>. The execution
+ will be bound to the <<<pre-site>>> phase. That means that it will be run
+ <before> the site is created. The xdoc that we generate here will be picked
+ up by the site plugin, because we put it into the <<<generated-site>>>
+ directory.
+
+ The following example uses the maven-war-plugin again. We will create a
+ report which will contain open issues that has been voted on.
+
++-------+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-swizzle-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <executions>
+ <execution>
+ <id>votes</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ <configuration>
+ <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
+ <projectKey>MWAR</projectKey>
+ <projectVersion>*</projectVersion>
+ <template>VOTES</template>
+ <result>target/generated-site/xdoc/votes.xml</result>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++-------+
+
+ You can then link to this page from your site. Here's what it would look like if
+ you added a link in the site descriptor (<<<site.xml>>>) for your project:
+
++-------+
+<project>
+ [...]
+ <body>
+ <menu name="Overview">
+ [...]
+ <item name="Votes" href="votes.html"/>
+ </menu>
+ [...]
+ </body>
+</project>
++-------+
Propchange: maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/incorporating-report-into-site.apt
------------------------------------------------------------------------------
svn:eol-style = native
Modified: maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt?view=diff&rev=558210&r1=558209&r2=558210
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt (original)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt Fri Jul 20 17:57:20 2007
@@ -64,3 +64,5 @@
* {{{examples/generating-resolved-issues-report.html}Resolved Issues Report}}
* {{{examples/generating-votes-report.html}Votes Report}}
+
+ * {{{examples/incorporating-report-into-site.html}Incorporating a Report Into a Site}}
Modified: maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml?view=diff&rev=558210&r1=558209&r2=558210
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml (original)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml Fri Jul 20 17:57:20 2007
@@ -32,6 +32,7 @@
<item name="Generating Release Report" href="examples/generating-release-report.html"/>
<item name="Generating Resolved Issues Report" href="examples/generating-resolved-issues-report.html"/>
<item name="Generating Votes Report" href="examples/generating-votes-report.html"/>
+ <item name="Incorporating a Report Into a Site" href="examples/incorporating-report-into-site.html"/>
</menu>
</body>
</project>