Author: dennisl
Date: Sun Dec 30 16:05:43 2007
New Revision: 607626
URL: http://svn.apache.org/viewvc?rev=607626&view=rev
Log:
o Remove the column "Default Value" and move that info into the "Description"
column, to save some screen real estate.
o Minor tweaks.
Modified:
maven/shared/trunk/maven-archiver/src/site/xdoc/index.xml
Modified: maven/shared/trunk/maven-archiver/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-archiver/src/site/xdoc/index.xml?rev=607626&r1=607625&r2=607626&view=diff
==============================================================================
--- maven/shared/trunk/maven-archiver/src/site/xdoc/index.xml (original)
+++ maven/shared/trunk/maven-archiver/src/site/xdoc/index.xml Sun Dec 30
16:05:43 2007
@@ -21,42 +21,42 @@
<properties>
<title>Maven Archiver Home Page</title>
<author email="[EMAIL PROTECTED]">Olivier Lamy</author>
- <author email="[EMAIL PROTECTED]">Dennis Lundberg</author>
+ <author email="[EMAIL PROTECTED]">Dennis Lundberg</author>
</properties>
<body>
<section name="Maven Archiver">
<p>The Maven Archiver is mainly used by plugins to handle packaging.</p>
<source>
- <<a href="#class_archive">archive</a>>
- <addMavenDescriptor/>
- <compress/>
- <forced/>
- <index/>
- <<a href="#class_manifest">manifest</a>>
- <addClasspath/>
- <addDefaultImplementationEntries/>
- <addDefaultSpecificationEntries/>
- <addExtensions/>
- <classpathMavenRepositoryLayout/>
- <classpathPrefix/>
- <mainClass/>
- <packageName/>
- </manifest>
- <manifestEntries>
- <key>value</key>
- </manifestEntries>
- <manifestFile/>
- <manifestSections>
- <<a href="#class_manifestSection">manifestSection</a>>
- <name/>
- <manifestEntries>
- <key>value</key>
- </manifestEntries>
- <manifestSection/>
- </manifestSections>
- <pomPropertiesFile/>
- </archive>
+<<a href="#class_archive">archive</a>>
+ <addMavenDescriptor/>
+ <compress/>
+ <forced/>
+ <index/>
+ <<a href="#class_manifest">manifest</a>>
+ <addClasspath/>
+ <addDefaultImplementationEntries/>
+ <addDefaultSpecificationEntries/>
+ <addExtensions/>
+ <classpathMavenRepositoryLayout/>
+ <classpathPrefix/>
+ <mainClass/>
+ <packageName/>
+ </manifest>
+ <manifestEntries>
+ <key>value</key>
+ </manifestEntries>
+ <manifestFile/>
+ <manifestSections>
+ <<a href="#class_manifestSection">manifestSection</a>>
+ <name/>
+ <manifestEntries>
+ <key>value</key>
+ </manifestEntries>
+ <manifestSection/>
+ </manifestSections>
+ <pomPropertiesFile/>
+</archive>
</source>
<a name="class_archive"/>
@@ -65,12 +65,12 @@
<tr>
<th>Element</th>
<th>Description</th>
- <th>Default Value</th>
<th>Type</th>
</tr>
<tr>
<td>addMavenDescriptor</td>
- <td>Whether the generated archive will contain these two Maven
files:
+ <td>
+ Whether the generated archive will contain these two Maven files:
<ul>
<li>
The pom file, located in the archive in
@@ -81,14 +81,16 @@
located in the archive in
<code>META-INF/maven/${groupId}/${artifactId}/pom.properties</code>
</li>
</ul>
+ The default value is <code>true</code>.
</td>
- <td>true</td>
<td>boolean</td>
</tr>
<tr>
<td>compress</td>
- <td>Activate compression for the archive.</td>
- <td>true</td>
+ <td>
+ Activate compression for the archive.
+ The default value is <code>true</code>.
+ </td>
<td>boolean</td>
</tr>
<tr>
@@ -107,8 +109,8 @@
An archiver doesn't necessarily support checks for uptodate. If
so, setting this option to <code>true</code> will simply be
ignored.
</p>
+ The default value is <code>true</code>.
</td>
- <td>true</td>
<td>boolean</td>
</tr>
<tr>
@@ -116,30 +118,37 @@
<td>
Whether the generated archive will contain an
<code>INDEX.LIST</code> file.
+ The default value is <code>false</code>.
</td>
- <td>false</td>
<td>boolean</td>
</tr>
<tr>
+ <td><a href="#class_manifest">manifest</a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
<td>manifestEntries</td>
<td>A list of key/value pairs to add to the manifest.</td>
- <td>N/A</td>
<td>Map</td>
</tr>
<tr>
<td>manifestFile</td>
<td>With this you can supply your own manifest file.</td>
- <td>N/A</td>
<td>File</td>
</tr>
<tr>
+ <td><a href="#class_manifestSection">manifestSections</a></td>
+ <td></td>
+ <td></td>
+ </tr>
+ <tr>
<td>pomPropertiesFile</td>
<td>
Use this to override the auto generated
<a href="#pom-properties-content">pom.properties</a> file
(only if <code>addMavenDescriptor</code> is set to
<code>true</code>)
</td>
- <td>N/A</td>
<td>File</td>
</tr>
</table>
@@ -151,15 +160,14 @@
<tr>
<th>Element</th>
<th>Description</th>
- <th>Default Value</th>
<th>Type</th>
</tr>
<tr>
<td>addClasspath</td>
<td>
Whether to generate a <code>Class-Path</code> manifest entry.
+ The default value is <code>false</code>.
</td>
- <td>false</td>
<td>boolean</td>
</tr>
<tr>
@@ -172,8 +180,8 @@
Implementation-Vendor-Id: ${pom.groupId}
Implementation-Vendor: ${pom.organization.name}
</source>
+ The default value is <code>false</code>.
</td>
- <td>false</td>
<td>boolean</td>
</tr>
<tr>
@@ -184,8 +192,8 @@
Specification-Title: ${pom.name}
Specification-Version: ${pom.version}
</source>
+ The default value is <code>false</code>.
</td>
- <td>false</td>
<td>boolean</td>
</tr>
<tr>
@@ -193,8 +201,8 @@
<td>
Whether to generate an <code>Extension-List</code> manifest
entry.
+ The default value is <code>false</code>.
</td>
- <td>false</td>
<td>boolean</td>
</tr>
<tr>
@@ -202,9 +210,9 @@
<td>
The generated <code>Class-Path</code> entry will contains paths
that follow the Maven 2 repository layout:
- <code>${groupId}/${artifactId}/${version}/${fileName}</code>
+ <code>${groupId}/${artifactId}/${version}/${fileName}</code>.
+ The default value is <code>false</code>.
</td>
- <td>false</td>
<td>boolean</td>
</tr>
<tr>
@@ -212,20 +220,18 @@
<td>
A text that will be prefixed to all your <code>Class-Path</code>
entries.
+ The default value is <code>""</code>.
</td>
- <td>empty String</td>
<td>String</td>
</tr>
<tr>
<td>mainClass</td>
<td>The <code>Main-Class</code> manifest entry.</td>
- <td>N/A</td>
<td>String</td>
</tr>
<tr>
<td>packageName</td>
<td>Package manifest entry.</td>
- <td>N/A</td>
<td>String</td>
</tr>
</table>
@@ -237,7 +243,6 @@
<tr>
<th>Element</th>
<th>Description</th>
- <th>Default Value</th>
<th>Type</th>
</tr>
<tr>
@@ -245,13 +250,11 @@
<td>
The name of the section.
</td>
- <td>N/A</td>
<td>String</td>
</tr>
<tr>
<td>manifestEntries</td>
<td>A list of key/value pairs to add to the manifest.</td>
- <td>N/A</td>
<td>Map</td>
</tr>
</table>
