Make all plugin xdocs validate

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@292933 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl 2005-10-01 07:06:46 +00:00
parent 8d86e6e568
commit fe4a78733e
38 changed files with 101 additions and 108 deletions

View File

@ -29,15 +29,15 @@
</section>
<section name="Using the abbot:test goal">
<section name="Pre-requisites">
<subsection name="Pre-requisites">
<p>
There are no pre-requisites.
</p>
</section>
</subsection>
</section>
<section name="Using the abbot:test-webapp goal">
<section name="Pre-requisites">
<subsection name="Pre-requisites">
<p>
The following environmental dependencies need to be present before
executing the Abbot plugin:
@ -49,8 +49,8 @@
page for the details.
</li>
</ul>
</section>
<section name="Limitations">
</subsection>
<subsection name="Limitations">
<p>
The following limitations are known for the
<code>abbot:test-webstart</code> goal:
@ -63,7 +63,7 @@
to do so (granted if the jar are signed).
</li>
</ul>
</section>
</subsection>
</section>
</body>

View File

@ -29,7 +29,7 @@
<p>
The following example demonstrates how to depoyment
of artifact to remote repositories can be configured.
</p>
<source><![CDATA[
#list of repositories to which we will deploy.
#There are 4 repositories
@ -62,7 +62,6 @@ maven.repo.R4=file://c:\\temp
maven.repo.R4.directory=repository
]]></source>
</p>
</section>
</body>
</document>

View File

@ -26,7 +26,6 @@
<body>
<section name="Security Considerations">
<p>
<source><![CDATA[
>
@ -57,7 +56,7 @@ It should be used only from command files.
incze
]]></source>
</p>
</section>
</body>
</document>

View File

@ -58,13 +58,14 @@
<subsection name="artifact:deploy">
<p>
Deploy an artifact to the set of remote repositories.
<br/>
</p>
<p>
Following files will be deployed to remote repository:
</p>
<ol>
<li>Artifact file</li>
<li>MD5 checksum file of this artifact</li>
</ol>
</p>
<table>
<tr>
<th>Attribute Name</th><th>Description</th><th>Optional?</th>
@ -106,8 +107,10 @@
<subsection name="artifact:deploy-snapshot">
<p>
Deploy a snapshot version of the artifact to a set of remote repositories.
<br/>
</p>
<p>
During deloyment following files are put to remote repository:
</p>
<ul>
<li>Timestamped Artifact file</li>
<li>MD5 checksum file of timestamped artifact file</li>
@ -115,8 +118,10 @@
<li>MD5 checksum file of this file</li>
<li>${artifactId}-snapshot-version</li>
</ul>
<p>
For example for artifact with artifactId = <i>foo</i>
the following files will be transferred to the remote repository:
</p>
<ul>
<li>foo-20030620.124616.jar</li>
<li>foo-20030620.124616.jar.md5</li>
@ -124,14 +129,15 @@
<li>foo-SNAPSHOT.jar.md5</li>
<li>foo-snapshot-version</li>
</ul>
<p>
File <i>foo-snapshot-version</i>
contains the version number (20030620.124616)
that the snapshot is linked to,
so that
<a href="http://maven.apache.org/reference/user-guide.html#Resolving SNAPSHOT Dependencies">'convert-snapshots'</a>
can correctly update dependencies in projects that will use this artifact.
<br/>
</p>
<p>
<b>artifact:deploy-snapshot</b> tag uses the same set of attributes
as <a href="artifact:deloy">artifact:deploy</a> tag
</p>
@ -139,19 +145,22 @@
<subsection name="artifact:install">
<p>
Install an artifact in the local repository
<br/>
</p>
<p>
Following files will be copied to the local repository:
</p>
<ol>
<li>Artifact file</li>
<li>MD5 checksum file of this artifact</li>
</ol>
</p>
<p>
<i>Why should I use <b>artifact:install</b> when it is so easy
to copy a file inside my plugin?
</i>
<br/>
</p>
<p>
There are few good reason for that:
</p>
<ul>
<li>
Although simple now, it will not necessarily remain that way
@ -168,7 +177,6 @@
usage of Ant.
</li>
</ul>
</p>
<table>
<tr>
<th>Attribute Name</th><th>Description</th><th>Optional?</th>
@ -204,19 +212,23 @@
<subsection name="artifact:install-snapshot">
<p>
Install a snapshot version of the artifact in the local repository
<br/>
</p>
<p>
Following files are copied to the local repository:
</p>
<ul>
<li>Timestamped Artifact file</li>
<li>Artifact file with version marked as <i>SNAPSHOT</i></li>
</ul>
<p>
For exaple for artifact with artifactId foo
following files will be transfered to local repository:
</p>
<ul>
<li>foo-20030620.124616.jar</li>
<li>foo-SNAPSHOT.jar</li>
</ul>
<br/>
<p>
<b>artifact:install-snapshot</b> tag uses the same set of attributes
as <a href="#artifact:install">artifact:install</a> tag
</p>

View File

@ -30,7 +30,7 @@
The following generates java sources for the foo.xsd' schema,
in the 'com.foo.bar' package. The sources will use Java 2 collection
types.
</p>
<source><![CDATA[
<preGoal name="java:compile">
@ -41,12 +41,11 @@
</preGoal>
]]></source>
</p>
<p>
The following generates java sources for the 'bar.xsd' schema.
The sources will not included marshalling support (marshal,
unmarshal, validate).
</p>
<source><![CDATA[
<preGoal name="java:compile">
@ -56,7 +55,6 @@
</preGoal>
]]></source>
</p>
</section>
</body>
</document>

View File

@ -26,7 +26,7 @@
<body>
<section name="Settings">
No properties.
<p>No properties.</p>
</section>
</body>
</document>

View File

@ -21,8 +21,8 @@
<document>
<properties>
<author email="vmassol@apache.org">Vincent Massol</author>
<title>Maven Clover plugin properties</title>
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>

View File

@ -26,14 +26,12 @@
<body>
<section name="Tasks">
<p>
<ul>
<li>
Find a way to switch projects easily, so that
we load all the plugins once for all projects.
</li>
</ul>
</p>
</section>
</body>
</document>

View File

@ -55,8 +55,9 @@
running reports several times.
</li>
</ul>
<p>Example:</p>
<a href="images/dashboard.jpg"><img src="images/dashboard.jpg" width="756" height="114"/></a>
<p>Example:<br/>
<a href="images/dashboard.jpg"><img src="images/dashboard.jpg" width="756" height="114" alt="dashboard.jpg"/></a>
</p>
</section>
<section name="Quick start">
<p>

View File

@ -30,11 +30,11 @@
reports over multiple projects using the reactor. To
understand the work of the plugin better we have to look at
the following topics
</p>
<ul>
<li>How to create the report data aggregate for a single project?</li>
<li>How are the report data aggregate for the master project?</li>
</ul>
</p>
</section>
<section name="Creating report data for a single project">
<p>
@ -46,10 +46,10 @@
</p>
<p>
This behaviour is controlled by
</p>
<source>
maven.dashboard.rungoals = [true|false]
</source>
</p>
<p>
If this property is set to "true" the Dashboard plugin looks at
the value of 'maven.dashboard.aggregators' to determine which
@ -62,16 +62,17 @@
<p>
The aggregation for the master project is a two-step process
triggered by the reactor
</p>
<ul>
<li>Aggregate the report data for a single project</li>
<li>Aggregate the aggregated data over all projects</li>
</ul>
</p>
<subsection name="Aggregate the report data for a single project">
<p>
The result of the aggregation is a file 'dashboard-single.xml'
which could look like the following example collecting data of
JUnit, Clover, PMD, CVS and Checkstyle reports
</p>
<source><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
@ -84,7 +85,6 @@
<aggregator name="cserrors">27</aggregator>
</dashboard-single>
]]></source>
</p>
</subsection>
<subsection name="Aggregate the aggregated data over all projects">
<p>
@ -92,6 +92,7 @@
subprojects which results into a 'dashboard-data.xml'.
This file is then transformed to the Dashoard HTML
report.
</p>
<source><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
@ -115,7 +116,6 @@
</project>
</dashboard>
]]></source>
</p>
</subsection>
</section>
</body>

View File

@ -24,7 +24,7 @@
</properties>
<body>
<section name="Maven Developer Activity Plug-in Settings">
<a href="../changelog/properties.html">See Changelog plugin properties</a>
<p><a href="../changelog/properties.html">See Changelog plugin properties</a></p>
</section>
</body>
</document>

View File

@ -137,14 +137,14 @@
<td>maven.build.dir</td>
<td>where the component will be assembled</td>
<td>
<A href="../java/properties.html#Other Settings">maven.build.dir</A>
<a href="../java/properties.html#Other Settings">maven.build.dir</a>
</td>
</tr>
<tr>
<td>maven.final.name</td>
<td>The assembled component will be <code>${maven.build.dir}/${maven.final.name}.ear</code></td>
<td>
<A href="../java/properties.html#Other Settings">maven.final.name</A>
<a href="../java/properties.html#Other Settings">maven.final.name</a>
</td>
</tr>
</table>

View File

@ -85,10 +85,10 @@
If the <a href="properties.html">${maven.eclipse.workspace}</a>
is <strong>not</strong> set, the file is created in the current
directory, and should be manually copied to
</p>
<source>
${eclipse workspace}/.metadata/.plugins/org.eclipse.ui.externaltools/externaltools.xml
</source>
</p>
</description>
</goal>
@ -107,16 +107,15 @@ ${eclipse workspace}/.metadata/.plugins/org.eclipse.ui.externaltools/externaltoo
<p>
If the <a href="properties.html">${maven.eclipse.workspace}</a>
is <strong>not</strong> set, the files should be manually copied to
</p>
<source>
${your eclipse workspace}/.metadata/.plugins/org.eclipse.debug.core/.launches/
</source>
</p>
</description>
</goal>
<a name="eclipse:add-maven-repo" />
<goal>
<name>eclipse:add-maven-repo</name>
<name>eclipse:add-maven-repo<a name="eclipse:add-maven-repo" /></name>
<description>
Ensures that the classpath variable <code>MAVEN_REPO</code>
exists in the Eclipse environment.

View File

@ -122,11 +122,11 @@
would be placed in <code>/target/generated-sources/schema/</code>.
<br/>
Settings in project.properties:
</p>
<source>
maven.xdoclet.hibernatedoclet.destDir=${maven.build.dir}/generated-sources/xdoclet
maven.hibernate.output.dir=${maven.build.dir}/generated-sources/schema
</source>
</p>
</subsection>
</section>
</body>

View File

@ -62,7 +62,6 @@
<li>
In order to reference an EJB client JAR from another project you'll need
to specify an <code>ejb-client</code> type. Here's an example:
</li>
<source><![CDATA[
<dependency>
<groupId>groupId</groupId>
@ -71,6 +70,7 @@
<type>ejb-client</type>
</dependency>
]]></source>
</li>
<li>
The following goals have been deprecated:
<code>ejb:ejb-client</code>, <code>ejb:install-client</code> and

View File

@ -29,9 +29,8 @@
<table>
<tr><th>Goal</th><th>Description</th></tr>
<a name="faq" />
<tr>
<td>faq</td>
<td>faq <a name="faq"/></td>
<td>
The default goal. This goal generates an xdoc document
from an XML FAQ document.

View File

@ -24,7 +24,7 @@
</properties>
<body>
<section name="Maven File Activity Plug-in Settings">
<a href="../changelog/properties.html">See Changelog plugin properties</a>
<p><a href="../changelog/properties.html">See Changelog plugin properties</a></p>
</section>
</body>
</document>

View File

@ -67,8 +67,8 @@
copying one of there to a different directory. This new copy
will be the one that we'll be working on. For this example, we
will consider the new template directory to be on
<source>/opt/templates/foo</source>
</p>
<source>/opt/templates/foo</source>
</subsection>
<subsection name="Template customization">
<p>
@ -89,7 +89,9 @@
<section name="Using">
<p>
Create a directory for your application and type
</p>
<source>maven genapp -Dmaven.genapp.template.dir=/opt/templates/foo</source>
<p>
This should generate the application template you defined.
</p>
<p>

View File

@ -32,9 +32,8 @@
<th>Description</th>
</tr>
<a name="gump:gump"/>
<tr>
<td>gump:gump</td>
<td>gump:gump<a name="gump:gump"/></td>
<td>
Generates a
<code>gump.xml</code> file for Apache Gump
@ -42,9 +41,8 @@
</td>
</tr>
<a name="gump:multiproject"/>
<tr>
<td>gump:multiproject</td>
<td>gump:multiproject<a name="gump:multiproject"/></td>
<td>
Generates a
<code>gump.xml</code> file for Apache Gump
@ -53,18 +51,16 @@
</td>
</tr>
<a name="gump"/>
<tr>
<td>gump</td>
<td>gump<a name="gump"/></td>
<td>
The default goal. This is an alias for
<a href="#gump:gump">gump:gump</a>.
</td>
</tr>
<a name="gump:generate-descriptor"/>
<tr>
<td>gump:generate-descriptor</td>
<td>gump:generate-descriptor<a name="gump:generate-descriptor"/></td>
<td>
This is an alias for
<a href="#gump:gump">gump:gump</a>.

View File

@ -29,30 +29,29 @@
<table>
<tr><th>Goal</th><th>Description</th></tr>
<a name="hibernate:schema-export" />
<tr>
<td>hibernate:schema-export</td>
<td>hibernate:schema-export<a name="hibernate:schema-export" /></td>
<td>
Creates SQL DDL file and generates the database schema from set of *.hbm.xml files
</td>
</tr>
<a name="hibernate:schema-update" />
<tr>
<td>hibernate:schema-update</td>
<td>hibernate:schema-update<a name="hibernate:schema-update" /></td>
<td>
Updates the database schema based on the set of *.hbm.xml files
</td>
</tr>
<a name="hibernate:aggregate-mappings" />
<tr>
<td>hibernate:aggregate-mappings</td>
<td>hibernate:aggregate-mappings<a name="hibernate:aggregate-mappings" /></td>
<td>
Aggregates multiple hibernate mappings into one
</td>
</tr>
<a name="hibernate:code-generation" />
<tr>
<td>hibernate:code-generation</td>
<td>hibernate:code-generation<a name="hibernate:code-generation" /></td>
<td>
Generates Java classes from set of *.hbm.xml files
</td>

View File

@ -29,9 +29,8 @@
<table>
<tr><th>Goal</th><th>Description</th></tr>
<a name="html2xdoc" />
<tr>
<td>html2xdoc</td>
<td>html2xdoc<a name="html2xdoc" /></td>
<td>
The default goal. This goal generates xdoc documents from some basic
HTML documentation which can then be styled by the xdoc goal to use

View File

@ -20,8 +20,8 @@
<document>
<properties>
<author email="plynch@apache.org">Peter Lynch</author>
<title>Maven J2EE Plug-in: Appserver Notes</title>
<author email="plynch@apache.org">Peter Lynch</author>
</properties>
<body>

View File

@ -20,8 +20,8 @@
<document>
<properties>
<author email="dion@multitask.com.au">dIon Gillard</author>
<title>Maven J2EE Plug-in Directory Layout</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
</properties>
<body>

View File

@ -20,9 +20,9 @@
<document>
<properties>
<title>Futures for the J2EE Plug-in</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
<author email="plynch@apache.org">Peter Lynch</author>
<title>Futures for the J2EE Plug-in</title>
</properties>
<body>

View File

@ -20,10 +20,10 @@
<document>
<properties>
<title>Maven J2EE Plug-in Goals</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
<author email="kevin@rocketred.com.au">Kevin O'Neill</author>
<author email="plynch@apache.org">Peter Lynch</author>
<title>Maven J2EE Plug-in Goals</title>
</properties>
<body>
@ -72,6 +72,7 @@
</p>
<p>
The validator checks the folowing:
</p>
<ol>
<li>The war file exists</li>
<li>It is readable</li>
@ -89,7 +90,6 @@
<li>Login and error pages specified in the <code>&lt;form-login-config
&gt;</code> element must exist in the war file</li>
</ol>
</p>
</subsection>
<subsection name="j2ee:ejb">
<p>
@ -101,13 +101,12 @@
<code><a href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a></code>
property.
</p>
<p>The files generated are:
<p>The files generated are:</p>
<ul>
<li><code>${maven.j2ee.ejb.name}.jar</code></li>
<li><code>${maven.j2ee.ejb.name}-remote.jar</code> <emp>(optional)</emp></li>
<li><code>${maven.j2ee.ejb.name}-local.jar</code> <emp>(optional)</emp></li>
<li><code>${maven.j2ee.ejb.name}-remote.jar</code> <em>(optional)</em></li>
<li><code>${maven.j2ee.ejb.name}-local.jar</code> <em>(optional)</em></li>
</ul>
</p>
<p>
Maven also includes the license file, LICENSE.txt, if it exists, in
the META-INF directory.

View File

@ -20,10 +20,10 @@
<document>
<properties>
<title>Maven J2EE Plug-in Properties Documentation</title>
<author email="dion@multitask.com.au">dIon Gillard</author>
<author email="kevino@jacus.com.au">Kevin O'Neill</author>
<author email="plynch@apache.org">Peter Lynch</author>
<title>Maven J2EE Plug-in Properties Documentation</title>
</properties>
<body>

View File

@ -19,10 +19,8 @@
<project>
<properties>
<author email="Dominik.Dahlem@cs.tcd.ie">Dominik Dahlem</author>
<!--<author email="Dominik.Dahlem@cs.tcd.ie">Dominik Dahlem</author>-->
<title>JCoverage Plugin</title>
</properties>
<body>

View File

@ -38,6 +38,7 @@
</p>
<p>
Metrics for each Java package include:
</p>
<ul>
<li><b>Number of Classes and Interfaces</b>
<p>
@ -107,7 +108,6 @@
</p>
</li>
</ul>
</p>
</section>
</body>

View File

@ -29,9 +29,8 @@
<table>
<tr><th>Goal</th><th>Description</th></tr>
<a name="jellydoc" />
<tr>
<td>jellydoc</td>
<td>jellydoc<a name="jellydoc" /></td>
<td>
The default goal. This goal generates the JellyDoc documentation of
all Jelly tags defined within your code base which can then be styled

View File

@ -37,12 +37,10 @@
to have implemented. (In decreasing order of importance)
</p>
<p>
<ol>
<li>The ability to include exclude parts of the tree</li>
<li>Persists remote url checks across runs</li>
</ol>
</p>
</section>
</body>
</document>

View File

@ -32,11 +32,11 @@
</p>
<p>
To register this report, include the following in your top-level <code>project.xml</code>:
</p>
<source><![CDATA[
<reports>
<report>maven-multiproject-plugin</report>
</reports>]]></source>
</p>
</section>
</body>
</document>

View File

@ -59,6 +59,7 @@
<section name="Default Templates">
<p>
The plugin provides two templates by default:
</p>
<ol>
<li>
<code>project.jelly</code> to get access to information in
@ -69,7 +70,6 @@
compilation.
</li>
</ol>
</p>
<subsection name="project.jelly">
<p>
This template produces a file (<code>${maven.build.dir}/project.nsi</code>)
@ -114,11 +114,13 @@
<p>
The <code>setup.nsh</code> file that is generated uses following list
of directories to search for files to include:
</p>
<ol>
<li><code>${maven.nsis.src}</code> if it exists,</li>
<li><code>${maven.build.dir}</code></li>
<li><code>${plugin.resources}</code></li>
</ol>
<p>
So anything in your NSIS source will override the defaults.
</p>
<p>

View File

@ -29,6 +29,7 @@
<p>
The process of creating an installer from your <code>${maven.nsis.build.dir}</code>
using the plugin is as follows:
</p>
<ol>
<li>
You, the user invoke the <code>nsis</code>, or <code>nsis:installer</code>
@ -57,7 +58,6 @@
setup.nsi file.
</li>
</ol>
</p>
<!--p>
reference up coming customisation doc here
</p-->

View File

@ -28,9 +28,8 @@
<section name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<a name="sim" />
<tr>
<td>maven-simian-plugin</td>
<td>maven-simian-plugin<a name="sim" /></td>
<td>
The default goal. This goal generates an xdoc document
containing a Simian report.

View File

@ -28,18 +28,16 @@
<section name="Goals">
<table>
<tr><th>Goal</th><th>Description</th></tr>
<a name="tasklist" />
<tr>
<td>tasklist</td>
<td>tasklist<a name="tasklist" /></td>
<td>
The default goal. This goal simply executes the
<a href="#tasklist:generate">tasklist:generate</a> goal
</td>
</tr>
<a name="tasklist:generate" />
<tr>
<td>tasklist:generate</td>
<td>tasklist:generate<a name="tasklist:generate" /></td>
<td>
Generates a list of tasks from the javadoc @todo tag
<br />

View File

@ -35,7 +35,7 @@
</description>
</goal>
</goals>
<goal>
<!--<goal>
<name>uberjar:install</name>
<description>Install the uberjar in the local repository</description>
</goal>
@ -50,6 +50,6 @@
<goal>
<name>uberjar:deploy-snapshot</name>
<description>Deploy the snapshot version of the uberjar to the remote repository(ies)</description>
</goal>
</goal>-->
</body>
</document>

View File

@ -26,7 +26,7 @@
<body>
<section name="Tasks">
<ul>
<ul><li></li>
</ul>
</section>
</body>

View File

@ -130,8 +130,7 @@
</td>
</tr>
<tr>
<a id="tld_dir"/>
<td>maven.war.tld.dir</td>
<td>maven.war.tld.dir<a id="tld_dir"/></td>
<td>Yes</td>
<td>
Subdirectory of web application context root directory
@ -181,11 +180,11 @@
<p>
This process is type senstive.
Currently following types are supported:
</p>
<ol>
<li>jar (bundled into WEB-INF/lib)</li>
<li>tld (bundled into WEB-INF/tld, see: <a href="#tld_dir">maven.war.tld.dir</a>)</li>
</ol>
</p>
</section>
</body>
</document>