Author: olamy
Date: Fri Feb  3 16:27:56 2012
New Revision: 1240235

URL: http://svn.apache.org/viewvc?rev=1240235&view=rev
Log:
add an index page in tomcat7 with link to all maven goals

Added:
    tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/
    tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/index.apt
      - copied, changed from r1240234, 
tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt
    tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/usage.apt.vm   
(with props)
Modified:
    tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt
    tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/site.xml
    tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/site.xml

Modified: tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt
URL: 
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt?rev=1240235&r1=1240234&r2=1240235&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt 
(original)
+++ tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt Fri 
Feb  3 16:27:56 2012
@@ -29,7 +29,7 @@
 
 Tomcat Maven Plugin
 
- The Tomcat Maven Plugin provides goals to manipulate WAR projects within the 
{{{http://tomcat.apache.org/}Tomcat}} servlet container.
+ The Tomcat6 Maven Plugin provides goals to manipulate WAR projects within the 
{{{http://tomcat.apache.org/}Tomcat}} servlet container version 6.x .
 
 * Goals Overview
 
@@ -41,7 +41,7 @@ Tomcat Maven Plugin
 
 * Usage
 
-  Instructions on how to use the Tomcat Maven Plugin can be found on the 
{{{usage.html}usage page}}.
+  Instructions on how to use the Tomcat Maven Plugin can be found on the 
{{{./usage.html}usage page}}.
 
 * Examples
 

Modified: tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/site.xml
URL: 
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/site.xml?rev=1240235&r1=1240234&r2=1240235&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/site.xml (original)
+++ tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/site.xml Fri Feb  3 
16:27:56 2012
@@ -34,7 +34,6 @@
       <item name="Deployment to Tomcat 7" 
href="examples/deployment-tomcat7.html"/>
     </menu>
 
-    <menu ref="modules"/>
     <menu ref="reports"/>
 
     <menu name="ASF">

Copied: tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/index.apt 
(from r1240234, 
tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt)
URL: 
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/index.apt?p2=tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/index.apt&p1=tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt&r1=1240234&r2=1240235&rev=1240235&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/tomcat6-maven-plugin/src/site/apt/index.apt 
(original)
+++ tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/index.apt Fri 
Feb  3 16:27:56 2012
@@ -1,10 +1,9 @@
  ---
  Introduction
  ---
- Mark Hobson
- <markhob...@gmail.com>
+ Olivier Lamy
  ---
- 2010-02-15
+ 2012-02-03
  ---
 
  ~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,25 +28,12 @@
 
 Tomcat Maven Plugin
 
- The Tomcat Maven Plugin provides goals to manipulate WAR projects within the 
{{{http://tomcat.apache.org/}Tomcat}} servlet container.
+ The Tomcat7 Maven Plugin provides goals to manipulate WAR projects within the 
{{{http://tomcat.apache.org/}Tomcat}} servlet container version 7.x
 
 * Goals Overview
 
-  The goals for this plugin come in two categories:
-
-  * {{{./context-goals.html}Goals to manipulate deployed projects within 
Tomcat}}
-
-  * {{{./container-goals.html}Goals to obtain information from Tomcat}}
+  The goals for this plugin are available here {{{./plugin-info.html}goals 
page}}.
 
 * Usage
 
-  Instructions on how to use the Tomcat Maven Plugin can be found on the 
{{{usage.html}usage page}}.
-
-* Examples
-
-  To provide you with better understanding of some usages of the Tomcat Maven 
Plugin,
-  you can take a look into the following examples:
-
-  * {{{./examples/add-system-properties.html}Adding System Properties}}
-
-  * {{{./examples/deployment.html}How to deploy projects to Tomcat}}
+  Instructions on how to use the Tomcat Maven Plugin can be found on the 
{{{./usage.html}usage page}}.

Added: tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/usage.apt.vm
URL: 
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/usage.apt.vm?rev=1240235&view=auto
==============================================================================
--- tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/usage.apt.vm 
(added)
+++ tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/usage.apt.vm 
Fri Feb  3 16:27:56 2012
@@ -0,0 +1,182 @@
+ ---
+ Usage
+ ---
+ Olivier Lamy
+ ---
+ 2012-02-03
+ ---
+
+ ~~ 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/doxia/references/apt-format.html
+
+Usage
+
+ If no explicit configuration is provided then the Tomcat7 Maven Plugin 
defaults to
+ the following:
+
+ * Tomcat manager URL of <<<http://localhost:8080/manager>>>
+
+ * Authentication details of username <<<admin>>> and no password
+
+ * Context path of <<</$\{project.artifactId\}>>>
+
+ []
+
+ These can be overridden as described below.
+
+* Using a different Tomcat manager URL
+
+ To configure the plugin for a different Tomcat instance, add a plugin
+ configuration block to your <<<pom.xml>>> as follows:
+
++--
+<project>
+  ...
+  <build>
+    ...
+    <plugins>
+      ...
+      <plugin>
+        <groupId>org.apache.tomcat.maven</groupId>
+        <artifactId>tomcat7-maven-plugin</artifactId>
+        <version>${project.version}</version>
+        <configuration>
+          <url>http://www.mydomain.com:1234/mymanager</url>
+        </configuration>
+      </plugin>
+      ...
+    </plugins>
+    ...
+  </build>
+  ...
+</project>
++--
+
+ The default Tomcat manager URL is <<<http://localhost:8080/manager>>>.
+
+* Using different Tomcat manager authentication details
+
+ To specify a different username and password to use when authenticating with
+ Tomcat manager:
+
+ [[1]] Add a plugin configuration block to your <<<pom.xml>>>:
+
++--
+<project>
+  ...
+  <build>
+    ...
+    <plugins>
+      ...
+      <plugin>
+        <groupId>org.apache.tomcat.maven</groupId>
+        <artifactId>tomcat7-maven-plugin</artifactId>
+        <version>${project.version}</version>
+        <configuration>
+          <server>myserver</server>
+        </configuration>
+      </plugin>
+      ...
+    </plugins>
+    ...
+  </build>
+  ...
+</project>
++--
+
+ [[2]] Add a corresponding <<<server>>> block to your <<<settings.xml>>>:
+
++--
+<settings>
+  ...
+  <servers>
+    ...
+    <server>
+      <id>myserver</id>
+      <username>myusername</username>
+      <password>mypassword</password>
+    </server>
+    ...
+  </servers>
+  ...
+</settings>
++--
+
+ []
+
+ The default authentication details are username <<<admin>>> and no password.
+
+* Using a different context path
+
+ The default context path is <<</$\{project.artifactId\}>>>.
+
+ To change the context path to <<</mycontext>>> configure the plugin like this:
+
++--
+<project>
+  ...
+  <build>
+    ...
+    <plugins>
+      ...
+      <plugin>
+        <groupId>org.apache.tomcat.maven</groupId>
+        <artifactId>tomcat7-maven-plugin</artifactId>
+        <version>${project.version}</version>
+        <configuration>
+          <path>/mycontext</path>
+        </configuration>
+      </plugin>
+      ...
+    </plugins>
+    ...
+  </build>
+  ...
+</project>
++--
+
+ If you are using <<<project.build.finalName>>> to change the name of your WAR
+ file, you can use that value when you configure the context path as well. To 
do
+ that add the following configuration block to your <<<pom.xml>>>:
+
++--
+<project>
+  ...
+  <build>
+    ...
+    <finalName>mycontext</finalName>
+    ...
+    <plugins>
+      ...
+      <plugin>
+        <groupId>org.apache.tomcat.maven</groupId>
+        <artifactId>tomcat7-maven-plugin</artifactId>
+        <version>${project.version}</version>
+        <configuration>
+          <path>/\${project.build.finalName}</path>
+        </configuration>
+      </plugin>
+      ...
+    </plugins>
+    ...
+  </build>
+  ...
+</project>
++--

Propchange: 
tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/usage.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: 
tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/apt/usage.apt.vm
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/site.xml
URL: 
http://svn.apache.org/viewvc/tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/site.xml?rev=1240235&r1=1240234&r2=1240235&view=diff
==============================================================================
--- tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/site.xml (original)
+++ tomcat/maven-plugin/trunk/tomcat7-maven-plugin/src/site/site.xml Fri Feb  3 
16:27:56 2012
@@ -22,10 +22,10 @@
   <body>
     <menu name="Overview">
       <item name="Introduction" href="index.html"/>
+      <item name="Goals" href="plugin-info.html"/>
       <item name="Javadoc" href="apidocs/index.html"/>
     </menu>
 
-    <menu ref="modules"/>
     <menu ref="reports"/>
 
     <menu name="ASF">



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org

Reply via email to