Author: epunzalan
Date: Wed Jul 26 19:21:18 2006
New Revision: 425933
URL: http://svn.apache.org/viewvc?rev=425933&view=rev
Log:
PR: MASSEMBLY-122
revised site docs accdg to reviews in the dev list
- fixed simple link to single
- added an faq on using javadoc to jar javadoc files docs
- added goals in the navigation bar
- added link to the project summary page in features.html
- fixed some typos and grammatical errors
- removed "Assembly Plugin" on page headings
- added the Usage section in index.html
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-components.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt
(original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/descriptor-refs.apt
Wed Jul 26 19:21:18 2006
@@ -107,7 +107,7 @@
Use <<<src>>> as the <<<descriptorId>>> of your assembly to create source
archives for your project. The archive should contain enough information
- for anyone to be able to build your project. The <<<bin>>> descriptorId
+ for anyone to be able to build your project. The <<<src>>> descriptorId
produces the archive in three formats: tar.gz, tar.bz2, and zip.
Below is the <<<src>>> descriptor format:
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt
(original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/index.apt
Wed Jul 26 19:21:18 2006
@@ -23,7 +23,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin - Examples
+Examples
* Table of Contents
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/index.apt
Wed Jul 26 19:21:18 2006
@@ -23,10 +23,11 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin - Multi-Module Examples
+Multi-Module Examples
- Multimodule Projects use \<moduleSets\> in their assemblies. The
- examples below may be able to help you when creating assemblies for your
+ Multimodule Projects use \<moduleSets\> in their assemblies.
+
+ The examples below may be able to help you when creating assemblies for your
multimodule project.
* {{{module-source-inclusion-simple.html}Adding Module Sources to the
Assembly}}
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-binary-inclusion-simple.apt
Wed Jul 26 19:21:18 2006
@@ -1,5 +1,5 @@
---
- Including Module Artifacts
+ Including Module Binaries
---
John Casey
---
@@ -23,13 +23,13 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin Example - Including Module Artifacts
+Including Module Binaries
* Introduction
It is common practice to create an assembly using the parent POM of a
multimodule build. At times, you may want to ensure that this assembly also
- includes one or more of the module artifacts.
+ includes one or more of the module binaries.
This example demonstrates how to include the artifact and dependencies of a
module, under the directory <<<modules/\<module-name\>>>>.
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/multimodule/module-source-inclusion-simple.apt
Wed Jul 26 19:21:18 2006
@@ -23,7 +23,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin Example - Including Module Sources
+Including Module Sources
* Introduction
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/filtering-some-distribution-files.apt
Wed Jul 26 19:21:18 2006
@@ -23,7 +23,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin Example - Filtering Some Distribution Files
+Filtering Some Distribution Files
* Introduction
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/index.apt
Wed Jul 26 19:21:18 2006
@@ -23,7 +23,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin - Single Project Examples
+Single Project Examples
A Single Project is a project whose assemblies does not use \<moduleSets\>.
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-components.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-components.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-components.apt
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-components.apt
Wed Jul 26 19:21:18 2006
@@ -23,7 +23,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin Example - Using Component Descriptors
+Using Component Descriptors
* Introduction
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
---
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt
(original)
+++
maven/plugins/trunk/maven-assembly-plugin/src/site/apt/examples/single/using-repositories.apt
Wed Jul 26 19:21:18 2006
@@ -23,7 +23,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin - Using Repositories
+Using Repositories
* Introduction
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt
(original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/features.apt Wed Jul
26 19:21:18 2006
@@ -22,7 +22,9 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin - Features
+Features
+
+ The current version of this plugin can be found
{{{project-summary.html}here}}.
<NOTE: Features with no version information have been present since the
first final release of the plugin.>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/index.apt Wed Jul 26
19:21:18 2006
@@ -41,9 +41,9 @@
* zip
- * tar.bz
+ * tar.gz
- * tar.gz2
+ * tar.bz2
* jar
@@ -120,6 +120,12 @@
* {{{single-mojo.html}assembly:single}} An assembly mojo created as a
work-around for lifecycle issues until addressed in the Maven 2.1 release.
+
+
+* Usage
+
+ Instructions on how to use the Assembly Plugin can be found
+ {{{usage.html}here}}.
* Examples
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/apt/usage.apt Wed Jul 26
19:21:18 2006
@@ -22,7 +22,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Assembly Plugin - Configuration and Usage
+Configuration and Usage
* Introduction
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml Wed Jul 26
19:21:18 2006
@@ -19,7 +19,7 @@
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="deploy">
- <question>If the Assembly Plugin is ran during the package phase, do my
assemblies get deployed during the deploy phase?</question>
+ <question>If the Assembly Plugin is run during the package phase, do my
assemblies get deployed during the deploy phase?</question>
<answer>
<p>Yes. The assemblies created by the Assembly Plugin is attached to
your project so it gets deployed too.</p>
</answer>
@@ -28,6 +28,13 @@
<question>Can I use an artifact created by the assembly plugin as a
dependency?</question>
<answer>
<p>Yes. You can refer to it using the id of the assembly as the
dependency classifier.</p>
+ </answer>
+ </faq>
+ <faq id="javadoc">
+ <question>How do I use the Assembly Plugin to package my project's
javadoc files?</question>
+ <answer>
+ <p>The Javadoc Plugin can generate the javadoc files of your projects.
Also, the Javadoc Plugin can package them!</p>
+ <p>Please see the <a href="/plugins/maven-javadoc-plugin/">Javadoc
Plugin Documentation</a>.</p>
</answer>
</faq>
</part>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml?rev=425933&r1=425932&r2=425933&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/site.xml Wed Jul 26
19:21:18 2006
@@ -32,6 +32,7 @@
<menu name="Overview">
<item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<item name="Features" href="features.html"/>
<item name="Descriptor Format" href="assembly.html"/>
@@ -42,10 +43,10 @@
<menu name="Examples">
<item name="Examples Index" href="examples/index.html"/>
- <item name="Single Projects" collapse="false"
href="examples/simple/index.html">
- <item name="Filtering Some Distribution Files"
href="examples/simple/filtering-some-distribution-files.html"/>
- <item name="Using Component Descriptors"
href="examples/simple/using-components.html"/>
- <item name="Using Repositories"
href="examples/simple/using-repositories.html"/>
+ <item name="Single Project" collapse="false"
href="examples/single/index.html">
+ <item name="Filtering Some Distribution Files"
href="examples/single/filtering-some-distribution-files.html"/>
+ <item name="Using Component Descriptors"
href="examples/single/using-components.html"/>
+ <item name="Using Repositories"
href="examples/single/using-repositories.html"/>
</item>
<item name="Multimodule Projects" collapse="false"
href="examples/multimodule/index.html">
<item name="Include Module Artifacts"
href="examples/multimodule/module-binary-inclusion-simple.html"/>
