jvanzyl 2003/02/12 22:18:01
Modified: xdocs/reference user-guide.xml
Log:
o cleaning up formatting and starting to edit.
Revision Changes Path
1.36 +146 -177 jakarta-turbine-maven/xdocs/reference/user-guide.xml
Index: user-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/reference/user-guide.xml,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- user-guide.xml 13 Feb 2003 04:53:37 -0000 1.35
+++ user-guide.xml 13 Feb 2003 06:18:01 -0000 1.36
@@ -816,23 +816,18 @@
guide:
</p>
- <source><![CDATA[
+<source><![CDATA[
+<project
+ xmlns:deploy="deploy">
+
+ <goal name="deploy-my-project">
+ ...
+ <deploy:copy-deps todir="/path"/>
+ ...
+ </goal>
- <project xmlns:deploy="deploy">
-
- <goal name="deploy-my-project">
-
- ...
-
- <deploy:copy-deps todir="/path"/>
-
- ...
-
- </goal>
-
- </project>
-
- ]]></source>
+</project>
+]]></source>
<p>
Using the <code>deploy:copy-deps</code> tag you can easily place your
@@ -841,24 +836,17 @@
each dependency listed will be excluded from the copy:
</p>
- <source><![CDATA[
-
- <project xmlns:deploy="deploy">
-
- <goal name="deploy-my-project">
-
- ...
-
- <deploy:copy-deps todir="/path" excludes="servletapi,commons-util"/>
-
- ...
-
- </goal>
-
- </project>
-
- ]]></source>
-
+<source><![CDATA[
+<project
+ xmlns:deploy="deploy">
+
+ <goal name="deploy-my-project">
+ ...
+ <deploy:copy-deps todir="/path" excludes="servletapi,commons-util"/>
+ ...
+ </goal>
+</project>
+]]></source>
</subsection>
</section>
@@ -881,14 +869,12 @@
must also start with a lowercase letter [a-z]:
</p>
- <source>
- <![CDATA[
- <project>
- <id>foo</id>
- ...
- </project>
- ]]>
- </source>
+<source><![CDATA[
+<project>
+ <id>foo</id>
+ ...
+</project>
+]]></source>
<p>
All references from one project to another are to be made in terms of the
@@ -902,31 +888,27 @@
documentation.
</p>
- <source>
- <![CDATA[
- <project>
- <id>foo</id>
- <name>The Grand Master Foo</name>
- ...
- </project>
- ]]>
- </source>
+<source><![CDATA[
+<project>
+ <id>foo</id>
+ <name>The Grand Master Foo</name>
+ ...
+</project>
+]]></source>
<p>
A project should have a group identifier. This group identifier
is the basis for the name
</p>
- <source>
- <![CDATA[
- <project>
- <id>foo</id>
- <name>The Grand Master Foo</name>
- <groupId>org.foo.bar</groupId>
- ...
- </project>
- ]]>
- </source>
+<source><![CDATA[
+<project>
+ <id>foo</id>
+ <name>The Grand Master Foo</name>
+ <groupId>org.foo.bar</groupId>
+ ...
+</project>
+]]></source>
<p>
All artifacts published by a project should be based on the
@@ -936,17 +918,15 @@
that looks like the following:
</p>
- <source><![CDATA[
-
- repository
- |
- +-- org.foo.bar
- |-- distribution
- `-- jar
- |-- foo-1.0.jar
- `-- foo-2.0.jar
-
- ]]></source>
+<source><![CDATA[
+repository
+ |
+ +-- org.foo.bar
+ |-- distribution
+ `-- jar
+ |-- foo-1.0.jar
+ `-- foo-2.0.jar
+]]></source>
</subsection>
@@ -956,29 +936,26 @@
following:
</p>
- <source>
- <![CDATA[
- <project>
- <id>bar</id>
- <name>Baradelic Groove Machine</name>
- <groupId>org.bar.foo</groupId>
- ...
-
- <dependencies>
-
- <dependency>
- <groupId>org.foo.bar</groupId>
- <artifactId>foo</artifactId>
- <artifactType>jar</artifactType>
- <category>runtime</category>
- <version>1.0</version>
- </dependency>
-
- </dependencies>
-
- </project>
- ]]>
- </source>
+<source><![CDATA[
+<project>
+ <id>bar</id>
+ <name>Baradelic Groove Machine</name>
+ <groupId>org.bar.foo</groupId>
+ ...
+
+ <dependencies>
+
+ <dependency>
+ <groupId>org.foo.bar</groupId>
+ <artifactId>foo</artifactId>
+ <category>runtime</category>
+ <version>1.0</version>
+ </dependency>
+
+ </dependencies>
+
+</project>
+]]></source>
<p>
So, the project <code>bar</code> which depends on version
@@ -986,7 +963,7 @@
which belongs to the group with an id of <code>org.foo.bar</code>.
This dependency resolves to a JAR file that is stored in the local
repository.
The above entry assumes that the published artifact name is based
- on the artifact id. So for the above dependency entry Maven will
+ on the artifactId. So for the above dependency entry Maven will
assume a JAR name of <code>foo-1.0.jar</code>.
</p>
@@ -1043,46 +1020,41 @@
the optional JAR plus a bonus hypothetical:
</p>
- <source>
- <![CDATA[
-
- <dependencies>
+<source><![CDATA[
- <!-- A -->
- <dependency>
- <groupId>org.apache.tools.ant</groupId>
- <artifactId>ant</artifactId>
- <version>1.4.1</version>
- </dependency>
-
- <!-- B -->
- <dependency>
- <groupId>org.apache.tools.ant</groupId>
- <artifactId>ant-optional</artifactId>
- <version>1.4.1</version>
- </dependency>
-
- <!-- C -->
- <dependency>
- <groupId>org.apache.tools.ant</groupId>
- <artifactId>poorly-named</artifactId>
- <version>1.4.1</version>
- </dependency>
+<dependencies>
- </dependencies>
+ <!-- A -->
+ <dependency>
+ <groupId>org.apache.tools.ant</groupId>
+ <artifactId>ant</artifactId>
+ <version>1.4.1</version>
+ </dependency>
+
+ <!-- B -->
+ <dependency>
+ <groupId>org.apache.tools.ant</groupId>
+ <artifactId>ant-optional</artifactId>
+ <version>1.4.1</version>
+ </dependency>
+
+ <!-- C -->
+ <dependency>
+ <groupId>org.apache.tools.ant</groupId>
+ <artifactId>poorly-named</artifactId>
+ <version>1.4.1</version>
+ </dependency>
- ]]>
- </source>
+</dependencies>
+]]></source>
<p>
So A), B) and C) are actually pointers to single artifacts in a group.
So a single dependency is a reference to a single artifact in a group.
- Everything right now defaults to JARs, but a dependency might be a
- JavaDoc index that is to be merged with other JavaDoc indexes to form a
- global index. Or a pointer to whatever, say a set of resources to pack
- up into a distribution. We tried to leave it open while preserving the
- most used case where the artifact is a JAR required for building
- something.
+ Currently the type of an artifact defaults to a JAR if not specified. But
a
+ dependency might be a WAR file or a distribution. We tried to provide
flexibility while
+ providing a default for the type most used: The case where the artifact
is a JAR required
+ for building a project.
</p>
</subsection>
@@ -1110,23 +1082,21 @@
Below is a little snapshot of what the remote repository looks like:
</p>
- <source><![CDATA[
-
- repository
- |
- |-- org.apache.tools.ant
- | |-- distribution
- | `-- jars
- | |-- ant-1.4.1.jar
- | `-- ant-optional-1.4.1.jar
- +-- jsse
- |-- distribution
- `-- jars
- |-- jsse.jar
- |-- jcert.jar
- `-- jnet.jar
-
- ]]></source>
+<source><![CDATA[
+repository
+ |
+ |-- org.apache.tools.ant
+ | |-- distribution
+ | `-- jars
+ | |-- ant-1.4.1.jar
+ | `-- ant-optional-1.4.1.jar
+ +-- jsse
+ |-- distribution
+ `-- jars
+ |-- jsse.jar
+ |-- jcert.jar
+ `-- jnet.jar
+]]></source>
</section>
@@ -1188,37 +1158,36 @@
set of components where the site is generated
</p>
- <source><![CDATA[
- <goal
- name="project-site"
- description="Generate the site for the entire project">
-
- <!-- Generate the site for each of the components. -->
-
- <maven:reactor
- basedir="${basedir}/components"
- postProcessing="true"
- includes="*/project.xml"
- excludes="bad-component/*"
- goals="site"
- banner="Generating Site"
- ignoreFailures="true"/>
-
- <!--
- |
- | At this point because 'postProcessing' was turned on we have all
- | the processed POMs available to us in the ${reactorProjects} variable.
- |
- -->
-
- <j:forEach var="reactorProject" items="${reactorProjects}">
-
- ... Do whatever you want with the harvested information ...
-
- </j:forEach>
-
- </goal>
- ]]></source>
+<source><![CDATA[
+<goal
+ name="project-site"
+ description="Generate the site for the entire project">
+
+ <!-- Generate the site for each of the components. -->
+
+ <maven:reactor
+ basedir="${basedir}/components"
+ postProcessing="true"
+ includes="*/project.xml"
+ excludes="bad-component/*"
+ goals="site"
+ banner="Generating Site"
+ ignoreFailures="true"/>
+
+ <!--
+ |
+ | At this point because 'postProcessing' was turned on we have all
+ | the processed POMs available to us in the ${reactorProjects} variable.
+ |
+ -->
+
+ <j:forEach var="reactorProject" items="${reactorProjects}">
+
+ ... Do whatever you want with the harvested information ...
+
+ </j:forEach>
+</goal>
+]]></source>
<p>
If you have to generate documentation for N projects with an overall
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
