You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by pg...@apache.org on 2009/12/01 00:13:13 UTC

svn commit: r885614 - in /maven/ant-tasks/trunk/src: main/resources/org/apache/maven/artifact/ant/antlib.xml site/apt/download.apt.vm site/apt/index.apt site/apt/installation.apt site/apt/reference.apt site/site.xml

Author: pgier
Date: Mon Nov 30 23:13:13 2009
New Revision: 885614

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

Added:
    maven/ant-tasks/trunk/src/site/apt/download.apt.vm   (with props)
Modified:
    maven/ant-tasks/trunk/src/main/resources/org/apache/maven/artifact/ant/antlib.xml
    maven/ant-tasks/trunk/src/site/apt/index.apt
    maven/ant-tasks/trunk/src/site/apt/installation.apt
    maven/ant-tasks/trunk/src/site/apt/reference.apt
    maven/ant-tasks/trunk/src/site/site.xml

Modified: maven/ant-tasks/trunk/src/main/resources/org/apache/maven/artifact/ant/antlib.xml
URL: http://svn.apache.org/viewvc/maven/ant-tasks/trunk/src/main/resources/org/apache/maven/artifact/ant/antlib.xml?rev=885614&r1=885613&r2=885614&view=diff
==============================================================================
--- maven/ant-tasks/trunk/src/main/resources/org/apache/maven/artifact/ant/antlib.xml (original)
+++ maven/ant-tasks/trunk/src/main/resources/org/apache/maven/artifact/ant/antlib.xml Mon Nov 30 23:13:13 2009
@@ -6,7 +6,7 @@
   <taskdef name="deploy" classname="org.apache.maven.artifact.ant.DeployTask"/>
   <taskdef name="install-provider" classname="org.apache.maven.artifact.ant.InstallWagonProviderTask"/>
   <taskdef name="mvn" classname="org.apache.maven.artifact.ant.Mvn"/>
-  <taskdef name="writePom" classname="org.apache.maven.artifact.ant.WritePomTask"/>
+  <taskdef name="writepom" classname="org.apache.maven.artifact.ant.WritePomTask"/>
 
   <!-- Types -->
   <typedef name="localRepository" classname="org.apache.maven.artifact.ant.LocalRepository"/>

Added: maven/ant-tasks/trunk/src/site/apt/download.apt.vm
URL: http://svn.apache.org/viewvc/maven/ant-tasks/trunk/src/site/apt/download.apt.vm?rev=885614&view=auto
==============================================================================
--- maven/ant-tasks/trunk/src/site/apt/download.apt.vm (added)
+++ maven/ant-tasks/trunk/src/site/apt/download.apt.vm Mon Nov 30 23:13:13 2009
@@ -0,0 +1,56 @@
+ ------
+Download Maven Ant Tasks
+ ------
+Paul Gier
+ ------
+30 November 2009
+ ------
+
+~~ 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
+
+Download the Maven Ant Tasks
+
+   The Maven Ant Tasks are distributed as a jar file to be included in the Ant classpath.  The complete 
+   sources can be downloaded as a zip or a tar.gz file.
+
+   After selecting the file to download, you will be prompted for a mirror.  If the file is not found 
+   on your selected mirror, please be patient, as it may take 24 hours to reach all mirrors.
+
+   The Maven Ant Tasks are distributed under the {{{http://maven.apache.org/license.html} Apache License, version 2.0}}.
+
+*-------------------------+---------+----------+-----------+
+|                         | Mirrors | Checksum | Signature |
+*-------------------------+---------+----------+-----------+
+| Binaries (jar)          | {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-ant-tasks-${project.version}.jar} maven-ant-tasks-${project.version}.jar}} | {{{http://www.apache.org/dist/maven/binaries/maven-ant-tasks-${project.version}.jar.md5} maven-ant-tasks-${project.version}.jar.md5}} | {{{http://www.apache.org/dist/maven/binaries/maven-ant-tasks-${project.version}.jar.asc} maven-ant-tasks-${project.version}.jar.asc}} |
+*-------------------------+---------+----------+-----------+
+| Sources (zip)           | {{{http://www.apache.org/dyn/closer.cgi/maven/source/maven-ant-tasks-${project.version}-src.zip} maven-ant-tasks-${project.version}-src.zip}} | {{{http://www.apache.org/dist/maven/source/maven-ant-tasks-${project.version}-src.zip.md5} maven-ant-tasks-${project.version}-src.zip.md5}} | {{{http://www.apache.org/dist/maven/source/maven-ant-tasks-${project.version}-src.zip.asc} maven-ant-tasks-${project.version}-src.zip.asc}} |
+*-------------------------+---------+----------+-----------+
+| Sources (tar.gz)        | {{{http://www.apache.org/dyn/closer.cgi?path=/maven/source/maven-ant-tasks-${project.version}-src.tar.gz} maven-ant-tasks-${project.version}-src.tar.gz}} | {{{http://www.apache.org/dist/maven/source/maven-ant-tasks-${project.version}-src.tar.gz.md5} maven-ant-tasks-${project.version}-src.tar.gz.md5}} | {{{http://www.apache.org/dist/maven/source/maven-ant-tasks-${project.version}-src.tar.gz.asc} maven-ant-tasks-${project.version}-src.tar.gz.asc}} |
+*-------------------------+---------+----------+-----------+
+
+* System {Requirements}
+
+*-----------------+------------------------------------------------------------------------------------------------+
+| <<JDK>>         | JDK version 1.5 or above is required (This is due to dependencies on internal Maven libraries.)
+*-----------------+------------------------------------------------------------------------------------------------+
+| <<Ant>>         | Ant version 1.6.x or 1.7.x is required
+*-----------------+------------------------------------------------------------------------------------------------+
+

Propchange: maven/ant-tasks/trunk/src/site/apt/download.apt.vm
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/ant-tasks/trunk/src/site/apt/download.apt.vm
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Modified: maven/ant-tasks/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/ant-tasks/trunk/src/site/apt/index.apt?rev=885614&r1=885613&r2=885614&view=diff
==============================================================================
--- maven/ant-tasks/trunk/src/site/apt/index.apt (original)
+++ maven/ant-tasks/trunk/src/site/apt/index.apt Mon Nov 30 23:13:13 2009
@@ -29,23 +29,32 @@
 
 Maven Ant Tasks
 
-  The Mavent Ant Tasks allow many of Maven's artifact handling features to be used
-  from within Ant. These include:
+  The Mavent Ant Tasks allow several of Maven's artifact handling features to be used
+  from within an Ant build. These include:
 
     * <Dependency management> - including transitive dependencies, scope recognition and SNAPSHOT handling
 
     * <Artifact deployment> - deployment to a Maven repository (file integrated, other with extensions)
 
-    * <POM processing> - for reading a Maven 2.0.x <<<pom.xml>>> file
+    * <POM processing> - for reading and writing a Maven 2 <<<pom.xml>>> file
 
-  The Ant tasks can be downloaded from the {{{http://maven.apache.org/download.html} Maven 2.0 download page}}.
+  The Ant tasks can be downloaded from the {{{download.html} download page}}.
 
-  Ant 1.6.x or 1.7.x is required to use Maven Ant tasks.
+* System Requirements
+
+*-----------------+------------------------------------------------------------------------------------------------+
+| <<JDK>>         | JDK version 1.5 or above is required (This is due to dependencies on internal Maven libraries.)
+*-----------------+------------------------------------------------------------------------------------------------+
+| <<Ant>>         | Ant version 1.6.x or 1.7.x is required
+*-----------------+------------------------------------------------------------------------------------------------+
 
 * Usage
 
-  General instructions for installing and using the maven ant tasks can be found on the {{{installation.html}installation page}}
-  and the {{{usage.html}usage page}} respectively.
+  General instructions for installing and using the Maven Ant Tasks can be found on the 
+  {{{installation.html}installation page}} and the {{{usage.html}usage page}} respectively. 
+  Some more specific use cases are described in the examples given below. Last but not least, 
+  users occasionally contribute additional examples, tips or errata to the
+  {{{http://docs.codehaus.org/display/MAVENUSER/Maven+Ant+Tasks}project's wiki page}}.
 
 * Examples
 
@@ -57,14 +66,26 @@
 
   * {{{examples/pom.html}Pom task}}
 
+  * {{{examples/write-pom.html}WritePom task}}
+
   * {{{examples/mvn.html}Mvn task}}
 
 * Getting Help
 
-  If you have any questions specific to the Ant tasks, please contact the
-  {{{http://maven.apache.org/mail-lists.html} Maven Users Mailing List}}.
+  In case you still have questions regarding the Maven Ant Tasks usage, please have a look at the {{{faq.html}FAQ}} and feel
+  free to contact the {{{mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
+  already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
+  the {{{mail-lists.html}mail archive}}.
+
+  If you feel like the Ant tasks are missing a feature or have a defect, you can fill a feature request or bug report in our
+  {{{issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
+  concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
+  entire debug logs, Ant build scripts or most preferably little demo projects attached to the issue are very much appreciated.
+  Of course, patches are welcome, too. Contributors can check out the project from our
+  {{{source-repository.html}source repository}} and will find supplementary information in the
+  {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}. 
 
-  For more on the Maven functionality behind the Ant tasks, try the following links:
+  For more information on the Maven functionality behind the Ant tasks, try the following links:
 
     * {{{http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html} Dependency Mechanism}}
 

Modified: maven/ant-tasks/trunk/src/site/apt/installation.apt
URL: http://svn.apache.org/viewvc/maven/ant-tasks/trunk/src/site/apt/installation.apt?rev=885614&r1=885613&r2=885614&view=diff
==============================================================================
--- maven/ant-tasks/trunk/src/site/apt/installation.apt (original)
+++ maven/ant-tasks/trunk/src/site/apt/installation.apt Mon Nov 30 23:13:13 2009
@@ -30,6 +30,7 @@
 Installing Maven Ant Tasks
 
   For convenience, Maven Ant Tasks and all its dependencies are packaged together as a single JAR file.
+  This can be downloaded from the {{{download.html} download page}}.
 
   There are two ways to use the tasks from your scripts.
 

Modified: maven/ant-tasks/trunk/src/site/apt/reference.apt
URL: http://svn.apache.org/viewvc/maven/ant-tasks/trunk/src/site/apt/reference.apt?rev=885614&r1=885613&r2=885614&view=diff
==============================================================================
--- maven/ant-tasks/trunk/src/site/apt/reference.apt (original)
+++ maven/ant-tasks/trunk/src/site/apt/reference.apt Mon Nov 30 23:13:13 2009
@@ -170,7 +170,7 @@
 | <<<version>>>    | The version of the provider to install.                                  | Yes          |             |
 *------------------+--------------------------------------------------------------------------+--------------+-------------+
 
-* <<<{writePom}>>> <(since 2.1.0)>
+* <<<{writepom}>>> <(since 2.1.0)>
 
   This task will write a POM object to a file.
 

Modified: maven/ant-tasks/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/ant-tasks/trunk/src/site/site.xml?rev=885614&r1=885613&r2=885614&view=diff
==============================================================================
--- maven/ant-tasks/trunk/src/site/site.xml (original)
+++ maven/ant-tasks/trunk/src/site/site.xml Mon Nov 30 23:13:13 2009
@@ -23,6 +23,7 @@
   <body>
     <menu name="Overview">
       <item name="Introduction" href="index.html"/>
+      <item name="Download" href="download.html"/>
       <item name="Installation" href="installation.html"/>
       <item name="Usage" href="usage.html"/>
       <item name="Release Notes" href="release-notes.html"/>
@@ -32,6 +33,7 @@
       <item name="dependencies" href="examples/dependencies.html"/>
       <item name="install, deploy" href="examples/install-deploy.html"/>
       <item name="pom" href="examples/pom.html"/>
+      <item name="writepom" href="examples/write-pom.html"/>
       <item name="mvn" href="examples/mvn.html"/>
     </menu>
     <menu name="Reference">
@@ -41,6 +43,7 @@
       <item name="localRepository" href="reference.html#localRepository"/>
       <item name="remoteRepository" href="reference.html#remoteRepository"/>
       <item name="pom" href="reference.html#pom"/>
+      <item name="writepom" href="reference.html#writepom"/>
       <item name="versionMapper" href="reference.html#versionMapper"/>
     </menu>
   </body>