polished documentation
git-svn-id: https://svn.apache.org/repos/asf/maven/ant-tasks/trunk@965079 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/site/apt/examples/mvn.apt.vm b/src/site/apt/examples/mvn.apt.vm
index 68f7660..112b57a 100644
--- a/src/site/apt/examples/mvn.apt.vm
+++ b/src/site/apt/examples/mvn.apt.vm
@@ -28,7 +28,7 @@
The Mvn Task
- <<Note: This task is available since version 2.0.10 of the maven ant tasks>>
+ <<Note: This task is available since version 2.0.10 of the Maven Ant Tasks>>
The Maven Ant Tasks have some limited support for calling a full Maven build from Ant.
The <<<mvn>>> task is a subclass of the Ant {{{http://ant.apache.org/manual/CoreTasks/java.html}java}}
@@ -69,11 +69,11 @@
</artifact:mvn>
-----
- <<Note: this will use version ${mavenVersion} of the core Maven libraries contained in the ant tasks jar>>
+ <<Note: this will use version ${mavenVersion} of the core Maven libraries, contained in the Maven Ant Tasks jar>>
Using the Java Task
- The java task can be used directly without any need for the Maven Ant Tasks. However,
+ The java task can be used directly without any need for the Maven Ant Tasks. However,
this method requires that Maven is already installed on the system. A
property called <<<maven.home>>> must be set to point to the local Maven installation,
then an Ant macro can be defined for calling Maven.
@@ -105,7 +105,7 @@
</macrodef>
-----
- This example defines an Ant macro called <<<maven>>>. The macro can then be used in
+ This example defines an Ant macro called <<<maven>>>. The macro can then be used in
the build like this:
-----
diff --git a/src/site/apt/examples/pom.apt b/src/site/apt/examples/pom.apt
index 9d9c386..385336d 100644
--- a/src/site/apt/examples/pom.apt
+++ b/src/site/apt/examples/pom.apt
@@ -35,13 +35,14 @@
can be used to resolve build dependencies, build the project classpath, and/or
define project properties.
-Reading an exising POM file
+Reading an existing POM file
An example pom is provided here:
-----
<project>
<modelVersion>4.0.0</modelVersion>
+
<groupId>com.mycompany.project</groupId>
<artifactId>project-model</artifactId>
<version>1.0-SNAPSHOT</version>
@@ -82,7 +83,7 @@
* <version> - the version of the artifact you are building.
- * <dependencies> - the artifacts that this project is dependant on.
+ * <dependencies> - the artifacts that this project is dependent on.
This is all that is required for most projects. However, it is also possible to use other fields available in
Maven to describe your project, and reference them from your build script.
@@ -96,7 +97,7 @@
Defining a POM in Ant
If a POM file is not available, the ant task can also be used to define an in-memory pom.
-
+
----
<artifact:pom id="mypom" groupId="org.acme" artifactId="project1" version="1.0">
<dependency groupId="junit" artifactId="junit" version="4.1"/>
@@ -125,7 +126,8 @@
<echo>The build directory is ${mypom.build.directory}</echo>
-----
- For more information on the elements available in the POM, see the {{{http://maven.apache.org/maven-model/maven.html} descriptor reference}}.
+ For more information on the elements available in the POM, see the
+ {{{http://maven.apache.org/ref/current/maven-model/maven.html} descriptor reference}}.
Accessing dependencies in the POM
diff --git a/src/site/apt/examples/write-pom.apt b/src/site/apt/examples/write-pom.apt
index 7edc5ee..53a3ad2 100644
--- a/src/site/apt/examples/write-pom.apt
+++ b/src/site/apt/examples/write-pom.apt
@@ -28,10 +28,10 @@
The WritePom Task
- <<Note: This task is available since version 2.1.0 of the maven ant tasks>>
+ <<Note: This task is available since version 2.1.0 of the Maven Ant Tasks>>
- The WritePom task can be used to generate a POM file based on information defined in
- the Ant build. For example, this could be used to generate a POM used when
+ The WritePom task can be used to generate a POM file based on information defined in
+ the Ant build. For example, this could be used to generate a POM used when
deploying build artifacts to a Maven repository.
The first step is to define a pom using the pom task.
@@ -45,28 +45,32 @@
----
The next step is to call the writePom task using the pom id created above.
-
+
----
<artifact:writepom pomRefId="mypom1" file="target/mypom1.xml"/>
----
This will generate a pom in the location specified.
-
+
----
<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
+
<groupId>org.acme</groupId>
<artifactId>project1</artifactId>
<version>1.0</version>
+
<name>My awesome project</name>
+
<licenses>
<license>
<name>apache</name>
<url>http://www.apache.org/</url>
</license>
</licenses>
+
<dependencies>
<dependency>
<groupId>junit</groupId>
@@ -82,12 +86,11 @@
</dependency>
</dependencies>
</project>
-----
-
- By default the <<<writePom>>> task will not include unnecessary information such as build configuration,
+----
+
+ By default the <<<writePom>>> task will not include unnecessary information such as build configuration,
repositories, and profiles. If this information is needed in the pom, the "trim" option can be set to false.
----
<artifact:writepom pomRefId="mypom1" file="target/mypom1.xml" trim="false"/>
----
-
\ No newline at end of file
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index 7534eb4..0e33886 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -89,6 +89,6 @@
* {{{http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html} Dependency Mechanism}}
- * {{{http://maven.apache.org/maven-settings/settings.html} Settings Reference}}
+ * {{{http://maven.apache.org/ref/current/maven-settings/settings.html} Settings Reference}}
- * {{{http://maven.apache.org/maven-model/maven.html} POM Reference}}
+ * {{{http://maven.apache.org/ref/current/maven-model/maven.html} POM Reference}}
diff --git a/src/site/apt/reference.apt b/src/site/apt/reference.apt
index 405c48b..8462d38 100644
--- a/src/site/apt/reference.apt
+++ b/src/site/apt/reference.apt
@@ -237,12 +237,13 @@
** <<<authentication>>>
The authentication element is used for passing a username, password and other credentials to the repository either
- on upload or download. The content is the same as for <<<server>>> in the {{{http://maven.apache.org/maven-settings/settings.html#class_server} settings reference}}.
+ on upload or download. The content is the same as for <<<server>>> in the
+ {{{http://maven.apache.org/ref/current/maven-settings/settings.html#class_server} settings reference}}.
** <<<proxy>>>
The proxy element is typically used for HTTP repositories. The content is the same as for <<<proxy>>> in the
- {{{http://maven.apache.org/maven-settings/settings.html#class_proxy} settings reference}}.
+ {{{http://maven.apache.org/ref/current/maven-settings/settings.html#class_proxy} settings reference}}.
* <<<{pom}>>>
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index b94da13..2f94b95 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -24,8 +24,8 @@
<faq id="build">
<question>How to build a Maven project with Maven Ant Tasks?</question>
<answer>
- <p>See the <a href="examples/mvn.html">examples page</a> for the mvn task for information about building
- a maven project from ant. </p>
+ <p>See the <a href="examples/mvn.html">examples page</a> for the mvn task for information about building
+ a Maven project from Ant.</p>
</answer>
</faq>
</part>
