You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jv...@apache.org on 2005/10/05 18:42:09 UTC
svn commit: r295032 - in /maven/components/trunk/maven-site/src/site: apt/
apt/guides/getting-started/ fml/ xdoc/ xdoc/developers/
Author: jvanzyl
Date: Wed Oct 5 09:41:59 2005
New Revision: 295032
URL: http://svn.apache.org/viewcvs?rev=295032&view=rev
Log:
o applied patch by David Jackman which corrects many small issues
with the doco. Thanks!
Modified:
maven/components/trunk/maven-site/src/site/apt/guides/getting-started/index.apt
maven/components/trunk/maven-site/src/site/apt/lifecycle.apt
maven/components/trunk/maven-site/src/site/apt/plugin-overview.apt
maven/components/trunk/maven-site/src/site/apt/site.apt
maven/components/trunk/maven-site/src/site/fml/about.fml
maven/components/trunk/maven-site/src/site/fml/general.fml
maven/components/trunk/maven-site/src/site/fml/maven1.fml
maven/components/trunk/maven-site/src/site/xdoc/configuration.xml
maven/components/trunk/maven-site/src/site/xdoc/dependency-mechanism.xml
maven/components/trunk/maven-site/src/site/xdoc/developers/mojo-api-specification.xml
maven/components/trunk/maven-site/src/site/xdoc/getting-started.xml
Modified: maven/components/trunk/maven-site/src/site/apt/guides/getting-started/index.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/getting-started/index.apt?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/getting-started/index.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/guides/getting-started/index.apt Wed Oct 5 09:41:59 2005
@@ -20,7 +20,12 @@
course, work for small projects but Maven shines in helping teams operate more effectively by allowing team members
to focus on what the stakeholders of a project require. You can leave the build infrastructure to Maven!
-* What is Maven?
+Sections
+
+ * {{{link1}What is Maven?}}
+
+
+* {link1} What is Maven?
At first glance Maven can appear to be many things, but in a nutshell Maven is an attempt <to apply patterns to
a project's build infrastructure in order to promote comprehension and productivity by providing a clear path in the
Modified: maven/components/trunk/maven-site/src/site/apt/lifecycle.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/lifecycle.apt?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/lifecycle.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/lifecycle.apt Wed Oct 5 09:41:59 2005
@@ -16,7 +16,7 @@
For the person building a project, this means that it is only necessary to learn a small set of commands to build any
Maven project, and the POM will ensure they get the results they desired.
- The most common lifecycle phases that would be executed on a project are the following:
+ The most common lifecycle phases that would be executed on a project are the following (a complete list of the lifecycle phases is given below):
* <<<validate>>> - validate the project is correct and all necessary information is available
@@ -86,17 +86,17 @@
| <<<deploy>>> | <<<deploy:deploy>>>
*------------------------------+---------------------------------------------------------------------------------------+
- This is an almost standard set of bindings, however, some packages handle them differently. For example, a project
+ This is an almost standard set of bindings; however, some packages handle them differently. For example, a project
that is purely metadata (packaging <<<pom>>>) only binds the <<<install>>> and <<<deploy>>> phases.
Note that for some packaging tpyes to be available, you may also need to include a particular plugin in your
- <<<build>>> section, similarly to the next section. One example of a plugin that requires this is the Plexus plugin,
+ <<<build>>> section (as described in the next section). One example of a plugin that requires this is the Plexus plugin,
which provides a <<<plexus-application>>> and <<<plexus-service>>> packaging.
** Plugins
The second way to add goals to phases is to configure plugins in your project. As you will see in the later sections,
- plugins contain information that says where to bind particular goals to. Note that adding the plugin on its own is not
+ plugins contain information that indicate which lifecycle phase to bind each goal to. Note that adding the plugin on its own is not
enough information - you must also specify the goals you want run as part of your build.
The goals that are configured will be added to the goals already bound to the lifecycle from the packaging selected.
@@ -128,8 +128,8 @@
...
----
- You might be wondering why that executions element is there? That is so that you can run the same goal multiple times
- with different configuration, if needed. Separate executions can also be given an ID so that during inheritence or the
+ You might be wondering why that executions element is there. That is so that you can run the same goal multiple times
+ with different configuration if needed. Separate executions can also be given an ID so that during inheritence or the
application of profiles you can control whether goal configuration is merged or turned into an additional execution.
When multiple executions are given that match a particular phase, they are executed in the order specified in the POM,
@@ -137,7 +137,7 @@
Now, in the case of <<<modello:java>>>, it only makes sense in the <<<generate-sources>>> phase. But some goals can be
used in more than one phase, and there may not be a sensible default. For those, you can specify the phase yourself.
- For example, let's say you have a goal <<<touch:timestamp>>> that echos the current time to file, and you want it to
+ For example, let's say you have a goal <<<touch:timestamp>>> that echos the current time to a file, and you want it to
run in the <<<process-test-resources>>> phase to indicate when the tests were started. This would be configured like
so:
@@ -163,7 +163,7 @@
* Build Lifecycle Phase Reference
- The following phases are executed in the order given, up to the point of the one specified.
+ The following lists all build lifecycle phases, which are executed in the order given up to the point of the one specified.
*-------------------------------+--------------------------------------------------------------------------------------+
| <<<validate>>> | validate the project is correct and all necessary information is available.
@@ -231,7 +231,7 @@
** Specifying a New Packaging
- If your plugin is intended to provide a unique artifact type, then you will need to not only provide the goal to
+ If your plugin is intended to provide a unique artifact type, then you will need to provide not only the goal to
package it with, but also a mapping of how the default lifecycle should behave.
This is currently achieved by adding a Plexus descriptor to your plugin (or modifying it if it already exists).
@@ -264,7 +264,7 @@
In this example, the <<<role-hint>>> is used to specify the packaging, and the <<<role>>> of
<<<org.apache.maven.lifecycle.mapping.LifecycleMapping>>> indicates this is a lifecycle mapping for that packaging.
- Implementation is required, and while you can provide your own, the default given above should suit and standard case.
+ <<<implementation>>> is required, and while you can provide your own, the default given above should suit the standard case.
The phases to bind are listed in the configuration element, and each that is given can have one goal associated with
that phase for that particular packaging.
@@ -373,7 +373,7 @@
to bind a goal one or more times to a particular phase, as well as specifying configuration. Note that configuration
already provided in the POM to that plugin that is not part of a specific execution will also be applied.
- The lifecycle ID given here, <<<clover>>> can then be used in the mojo to specify what to overlay on the forked
+ The lifecycle ID given here (<<<clover>>>) can then be used in the mojo to specify what to overlay on the forked
lifecycle when executing it, using the following mojo level declaration:
----
Modified: maven/components/trunk/maven-site/src/site/apt/plugin-overview.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/plugin-overview.apt?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/plugin-overview.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/plugin-overview.apt Wed Oct 5 09:41:59 2005
@@ -63,7 +63,7 @@
and the parameters it is expecting.
MOJO is a play on POJO (Plain-old-Java-object), substituting "Maven" for
- "Plain". Mojo is also an iteresting word (see {{{http://www.answers.com/mojo&r=67}definition}}.
+ "Plain". Mojo is also an iteresting word (see {{{http://www.answers.com/mojo&r=67}definition}}).
From {{{http://www.wikipedia.org}Wikipedia}}, a "mojo" is defined as:
"...a small bag worn by a person under the clothes (also known as a mojo hand).
Such bags were thought to have supernatural powers, such as protecting from evil,
@@ -161,12 +161,15 @@
** Why Change the Plugin Architecture?
- See the previous question for the long version, but the short version can
+ See the previous section for the long version, but the short version can
be summed up by the following list of benefits.
* A managed lifecycle
+
* Multiple implementation languages
+
* Reusability outside of the build system
+
* The ability to write Maven plugins entirely in Java
In Maven 1.0, a plugin was defined using Jelly, and while it was possibly to
Modified: maven/components/trunk/maven-site/src/site/apt/site.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/site.apt?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/site.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/site.apt Wed Oct 5 09:41:59 2005
@@ -75,14 +75,14 @@
only SSH is supported, as above which copies to the host <<<www.mycompany.com>>> in the path <<</www/docs/project/>>>.
Deploying the site is done with the <<<site:deploy>>> goal. Note that you cannot just call the deployment goal on its own, however.
- You must presently run the <<<site:site>>> goal independantly.
+ You must presently run the <<<site:site>>> goal as well.
---------------
m2 site:site site:deploy
---------------
<<Note:>> the trailing slash in the URL above indicates that any subprojects that inherit this value should append their artifact ID to
- the path instead of using it as is.
+ the path instead of using it as-is.
* Creating a Site Descriptor
@@ -132,7 +132,7 @@
* Adding Extra Resources
You can add any arbitrary resources to you site by including them in a
- <<<resources>>> directory as shown below. Addition CSS will be picked up
+ <<<resources>>> directory as shown below. Additional CSS files will be picked up
when they are placed in the <<<css>>> directory within the <<<resources>>>
directory.
@@ -220,5 +220,5 @@
+- site_fr.xml (French site descriptor)
--------------------
- With one site descriptor by language, translated site can evolve independently.
+ With one site descriptor per language, the translated site(s) can evolve independently.
Modified: maven/components/trunk/maven-site/src/site/fml/about.fml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/fml/about.fml?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/fml/about.fml (original)
+++ maven/components/trunk/maven-site/src/site/fml/about.fml Wed Oct 5 09:41:59 2005
@@ -74,7 +74,7 @@
<li>To be able to implement the features demanded that were not possible under the Maven 1.0 architecture</li>
</ul>
<p>
- Unfortunately, to reach these goals - we've had to sacrifice backwards compatibility to do this. Instead of
+ Unfortunately, to reach these goals we've had to sacrifice backwards compatibility. Instead of
making many small incremental changes that would break compatibility often over time, we decided to build on a
new, solid base that can be reliable for the future, and also to maintain the existing Maven 1.x product to
ensure that existing users are not left out in the cold.
@@ -83,7 +83,7 @@
</faq>
<faq id="tech-review">
- <question>What does beta release mean?</question>
+ <question>What does "beta release" mean?</question>
<answer>
<p>
Maven 2.0 is now in beta testing. We believe it is equally functional to Maven 1.0, however there are still
@@ -165,7 +165,7 @@
<p>
We get asked a lot whether Maven 2.0 will support other languages, in particular Groovy.
We will allow the use of Groovy - and virtually any other scripting
- language if there is demand, or someone can commit a small amount of time to implementing a
+ language (if there is demand) or someone can commit a small amount of time to implementing a
factory for it.
</p>
<p>
Modified: maven/components/trunk/maven-site/src/site/fml/general.fml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/fml/general.fml?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/fml/general.fml (original)
+++ maven/components/trunk/maven-site/src/site/fml/general.fml Wed Oct 5 09:41:59 2005
@@ -86,11 +86,11 @@
Absolutely yes!
</p>
<p>
- By configuring <sourceDirectory>, <resources> and other elements of
- the <build> section.
+ By configuring &lt;sourceDirectory&gt;, &lt;resources&gt; and other elements of
+ the &lt;build&gt; section.
</p>
<p>
- In addition, you may need to change plugin configuration if you are
+ In addition, you may need to change the plugin configuration if you are
not using plugin defaults for their files/directories.
</p>
</answer>
@@ -113,7 +113,7 @@
<answer>
<p>
You most probably need to configure Maven to use a proxy. Please see the information on
- <a href="configuration.html">configuring settings.xml</a> for how to configure your proxy
+ <a href="configuration.html">configuring settings.xml</a> for information on how to configure your proxy
for Maven.
</p>
</answer>
Modified: maven/components/trunk/maven-site/src/site/fml/maven1.fml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/fml/maven1.fml?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/fml/maven1.fml (original)
+++ maven/components/trunk/maven-site/src/site/fml/maven1.fml Wed Oct 5 09:41:59 2005
@@ -7,13 +7,13 @@
<answer>
<p>
Maven 2.0 will feel very different to a Maven 1.0 user - and perhaps a little strange. But it is a lot simpler
- to work with, and closer to how Maven was always meant to be! The key changes from Maven 1.0 are:
+ to work with and closer to how Maven was always meant to be! The key changes from Maven 1.0 are:
</p>
<ul>
<li>
<i>Faster and smaller</i>
- - The Maven core no longer uses Ant, Jelly or Xerces making it much smaller, has
- fewer dependencies and is perfect for embedding in other tools.
+ - The Maven core no longer uses Ant, Jelly or Xerces making it much smaller, have
+ fewer dependencies, and is perfect for embedding in other tools.
</li>
<li>
<i>Defined build lifecycle</i>
Modified: maven/components/trunk/maven-site/src/site/xdoc/configuration.xml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/xdoc/configuration.xml?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/xdoc/configuration.xml (original)
+++ maven/components/trunk/maven-site/src/site/xdoc/configuration.xml Wed Oct 5 09:41:59 2005
@@ -29,8 +29,8 @@
</p>
<p>
<b>Note:</b>
- the installation and user configuration can not be used to add shared project information -
- for example setting
+ the installation and user configuration cannot be used to add shared project information -
+ for example, setting
<code><organization></code>
or
<code><distributionManagement></code>
@@ -68,14 +68,14 @@
<p>
You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. The username and
password are only required if your proxy requires basic authentication (note that later releases may support
- storing your passwords in a secured keystore - in the mean time, please ensure your
+ storing your passwords in a secured keystore - in the meantime, please ensure your
<code>settings.xml</code>
file is secured with permissions appropriate for your operating system).
</p>
<p>
The
<code>nonProxyHosts</code>
- setting accepts wild cards, and each host not to proxy is separated by the
+ setting accepts wild cards, and each host name is separated by a
<code>|</code>
character. This matches the
<a href="http://java.sun.com/j2se/1.4.2/docs/guide/net/properties.html">JDK configuration</a>
@@ -150,11 +150,11 @@
<li>There is a synchronized mirror on the internet that is geographically closer and faster</li>
<li>You want to replace a particular repository with your own internal repository which you have greater
control over</li>
- <li>You want to run maven-proxy to provide a local cache to a mirror and need to use it's URL instead</li>
+ <li>You want to run maven-proxy to provide a local cache to a mirror and need to use its URL instead</li>
</ul>
<p>
To configure a mirror of a given repository, you provide it in your settings file, giving the new repository
- it's own
+ its own
<code>id</code>
and
<code>url</code>
@@ -182,7 +182,7 @@
.]]></source>
<p>
<i>Please note:</i>
- this particular is not actually set up for Maven 2 yet, so this should be treated as an
+ this particular feature is not actually set up for Maven 2 yet, so this should be treated as an
example only.
</p>
</section>
Modified: maven/components/trunk/maven-site/src/site/xdoc/dependency-mechanism.xml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/xdoc/dependency-mechanism.xml?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/xdoc/dependency-mechanism.xml (original)
+++ maven/components/trunk/maven-site/src/site/xdoc/dependency-mechanism.xml Wed Oct 5 09:41:59 2005
@@ -48,8 +48,8 @@
<li>
<i>Dependency mediation</i>
- this determines what version of a dependency will be used when multiple
- different ones are encountered. Currently, Maven 2.0 only supports using the "nearest definition" - so
- you can always guarantee a version by declaring it explicitly in the project's POM.
+ versions of an artifact are encountered. Currently, Maven 2.0 only supports using the "nearest definition" - so
+ you can always guarantee a version by declaring it explicitly in your project's POM.
</li>
<li>
<i>Dependency scope</i>
@@ -198,7 +198,7 @@
</project>]]></source>
</p>
<p>
- These two example POMs share a common dependencies and each one non-trivial dependency. This information
+ These two example POMs share a common dependency and each has one non-trivial dependency. This information
can be put in the parent POM like this:
<source><![CDATA[
<project>
Modified: maven/components/trunk/maven-site/src/site/xdoc/developers/mojo-api-specification.xml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/xdoc/developers/mojo-api-specification.xml?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/xdoc/developers/mojo-api-specification.xml (original)
+++ maven/components/trunk/maven-site/src/site/xdoc/developers/mojo-api-specification.xml Wed Oct 5 09:41:59 2005
@@ -29,7 +29,7 @@
the way of the programmer with its new Mojo API. This opens up the
opportunity for many Mojos to be reused outside of Maven, or bridged
into Maven from external systems like Ant.</p>
- <p>NOTE: For now, we will limit the discussion to Java-based mojos, since
+ <p>NOTE: For now, we will limit the discussion to Java-based Mojos, since
each scripting language will present these same basic requirements with
various forms of implementation.</p>
<p>Although the requirements on Mojos are minimal by design, there are
@@ -55,7 +55,7 @@
must implement (or else extend its abstract base class counterpart
<code>org.apache.maven.plugin.AbstractMojo</code>
). This interface
- guarantees the correct execution contract for the mojo: no parameters,
+ guarantees the correct execution contract for the Mojo: no parameters,
void return type, and a throws clause that allows only
<code>org.apache.maven.plugin.MojoExecutionException</code>
and its
@@ -73,7 +73,7 @@
under the path
<code>META-INF/maven</code>
inside the Plugin jar file. Fortunately,
- Maven also provides a set of javadoc annotations and tools to generate
+ Maven also provides a set of Javadoc annotations and tools to generate
this descriptor, so developers don't have to worry about directly
authoring or maintaining a separate XML metadata file.
</p>
@@ -86,7 +86,7 @@
<p>This interface forms the contract required for Mojos to interact
with the Maven infrastructure. It features an
<code>execute()</code>
- method, which trigger's the Mojo's build-process behavior, and can
+ method, which triggers the Mojo's build-process behavior, and can
throw a
<code>MojoExecutionException</code>
if an error condition
@@ -323,12 +323,12 @@
descriptor must accompany these classes inside the plugin jar. This
descriptor file is used to provide metadata about the parameters and
other component requirements for a set of Mojos so that Maven can
- initialize the Mojo and validate it's configuration before executing
+ initialize the Mojo and validate its configuration before executing
it. As such, the plugin descriptor has a certain set of information
that is required for each Mojo specification to be valid, as well as
requirements for the overall plugin descriptor itself.</p>
<p>NOTE: In the following discussion, bolded items are the descriptor's
- element name along with a javadoc annotation (if applicable) supporting
+ element name along with a Javadoc annotation (if applicable) supporting
that piece of the plugin descriptor. A couple of examples are:
<b>someElement
(@annotation parameterName="parameterValue")</b>
@@ -355,7 +355,7 @@
<td>Descriptors for each Mojo provided by the plugin, each inside a
<b>mojo</b>
sub-element. Mojo descriptors are covered in detail
- below. Obviously, a plugin without any declared mojos doesn't
+ below. Obviously, a plugin without any declared Mojos doesn't
make sense, so the
<b>mojos</b>
element is required, along with
@@ -404,7 +404,7 @@
<td>none (detected)</td>
<td>Yes</td>
<td>The Mojo's fully-qualified class name (or script path in
- the case of non-java mojos).</td>
+ the case of non-Java Mojos).</td>
</tr>
<tr>
<td>language</td>
@@ -412,7 +412,7 @@
<td>No. Default:
<code>java</code>
</td>
- <td>The implementation language for this Mojo (java,
+ <td>The implementation language for this Mojo (Java,
beanshell, etc.).</td>
</tr>
<tr>
@@ -475,8 +475,8 @@
<td>No</td>
<td>The description of this Mojo's functionality.
<i>Using the
- toolset, this will be the class-level javadoc description
- provided. NOTE: While this is not a required part of the mojo
+ toolset, this will be the class-level Javadoc description
+ provided. NOTE: While this is not a required part of the Mojo
specification, it SHOULD be provided to enable future
tool support for browsing, etc. and for clarity.</i>
</td>
@@ -494,8 +494,8 @@
</tr>
</table>
</p>
- <p>Each Mojo specifies the parameters that it expects to be able to work
- with. These parameters are the Mojo's link to the outside world, and
+ <p>Each Mojo specifies the parameters that it expects in order to work.
+ These parameters are the Mojo's link to the outside world, and
will be satisfied through a combination of POM/project values, plugin
configurations (from the POM and configuration defaults), and System
properties.</p>
@@ -527,7 +527,7 @@
parameter from the Mojo's declared defaults (discussed below) or
from the POM.
<i>Using the toolset, this is detected as the
- java field name.</i>
+ Java field name.</i>
</td>
</tr>
<tr>
@@ -544,11 +544,11 @@
<td>type</td>
<td>none (detected)</td>
<td>Yes</td>
- <td>The java type for this parameter. This is used to validate the
+ <td>The Java type for this parameter. This is used to validate the
result of any expressions used to calculate the value which
should be injected into the Mojo for this parameter.
<i>Using the
- toolset, this is detected as the class of the java field
+ toolset, this is detected as the class of the Java field
corresponding to this parameter.</i>
</td>
</tr>
@@ -589,7 +589,7 @@
<td>none (detected)</td>
<td>No</td>
<td>The description of this parameter's use inside the Mojo.
- <i>Using the toolset, this is detected as the javadoc description
+ <i>Using the toolset, this is detected as the Javadoc description
for the field. NOTE: While this is not a required part of the
parameter specification, it SHOULD be provided to enable future
tool support for browsing, etc. and for clarity.</i>
@@ -618,14 +618,14 @@
<td>@deprecated</td>
<td>No</td>
<td>Marks a parameter as deprecated. The rules on deprecation are
- the same as normal java with language elements. This will trigger
+ the same as normal Java with language elements. This will trigger
a warning when a user tries to configure a parameter marked as
deprecated.</td>
</tr>
</table>
</p>
<p>The final component of a plugin descriptor is the dependencies. This
- enables the plugin to function independently of it's POM (or at least
+ enables the plugin to function independently of its POM (or at least
to declare the libraries it needs to run). Dependencies are taken from
the
<b>runtime</b>
@@ -644,15 +644,15 @@
needs to do is declare his project to be a plugin from within the POM.
Once this is done, Maven will call the appropriate descriptor
generators, etc. to produce an artifact that is ready for use within
- Maven builds. Optional metadata can be injected via javadoc annotation
- (and possibly jdk5 annotations in the future) as described above,
+ Maven builds. Optional metadata can be injected via Javadoc annotation
+ (and possibly JDK5 annotations in the future) as described above,
enabling richer interactions between the Mojo and the user. The
section below describes the changes to the POM which are necessary to
create plugin artifacts.</p>
</section>
<section name="Project Descriptor (POM) Requirements">
<p>From the POM, Maven plugin projects look quite similar to any other
- project. For pure java plugins, the differences are even smaller than
+ project. For pure Java plugins, the differences are even smaller than
for script-based plugins. The following details the POM elements
which are necessary to build a Maven plugin artifact.</p>
<p>
@@ -680,9 +680,9 @@
</td>
<td>In the case of script-based Mojos (which are not covered in
detail within this document), the POM must include an additional
- element to distinguish script sources from (optional) java
- supporting classes. This element is the scriptSourceDirectory,
- inside the build section. This directory is included in the list
+ element to distinguish script sources from (optional) Java
+ supporting classes. This element is <code>scriptSourceDirectory</code>,
+ inside the <code>build</code> section. This directory is included in the list
of resources which accompany any compiled code in the resulting
artifact. It is specified separately from the resources in the
build section to denote its special status as an alternate source
@@ -711,7 +711,7 @@
href="plugin-overview.html">link</a>
]
</li>
- <li>QDox Project (javadoc annotations) [
+ <li>QDox Project (Javadoc annotations) [
<a
href="http://qdox.codehaus.org">link</a>
]
Modified: maven/components/trunk/maven-site/src/site/xdoc/getting-started.xml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/xdoc/getting-started.xml?rev=295032&r1=295031&r2=295032&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/xdoc/getting-started.xml (original)
+++ maven/components/trunk/maven-site/src/site/xdoc/getting-started.xml Wed Oct 5 09:41:59 2005
@@ -6,7 +6,7 @@
<body>
<section name="Getting Started">
<p>
- This section will help you create a trivial project, and build it, and should provide enough information
+ This section will help you create a trivial project and build it, and should provide enough information
to build any project that requires Maven 2.0. It assumed that you have already
<a href="download.html">Downloaded and Installed</a>
a Maven 2.0 release.
@@ -23,7 +23,7 @@
</p>
<source>m2 archetype:create -DgroupId=com.mycompany.app -DartifactId=my-app</source>
<p>
- This command has created a layout according the the conventions laid out
+ This command creates a layout according the the conventions laid out
<a href="http://maven.apache.org/reference/conventions.html">here</a>
.
</p>
@@ -170,7 +170,7 @@
<a name="configuring_plugins"/>
<subsection name="Configuring Plugins">
<p>
- What if you would like to customise whether a plugins is enabled, or how a plugin operates?
+ What if you would like to customise whether a plugins is enabled or how a plugin operates?
In Maven 1.0, you would have added some
<code>preGoal</code>
to
@@ -244,9 +244,9 @@
-DgroupId=com.mycompany.app -DartifactId=my-webapp \
-DarchetypeArtifactId=maven-archetype-webapp</source>
<p>
- Note that these must all be on a single line. This will create a directory
+ Note that these must all be on a single line. This will create a directory called
<code>my-webapp</code>
- and the following
+ containing the following
project descriptor:
</p>
<source><![CDATA[<project>
@@ -391,7 +391,7 @@
<code>my-app</code>
JAR. This does a few things: it makes it available
on the classpath to any code in the WAR (none in this case), it makes sure the JAR is always built before the
- WAR, and it indicates to the WAR plugin to include the JAR in it's library directory.
+ WAR, and it indicates to the WAR plugin to include the JAR in its library directory.
</p>
<p>
You may have noticed that
@@ -420,7 +420,7 @@
and the artifacts in the reactor will be used from the target directories instead of the local repository.
</p>
<p>
- You might like to generate you IDEA workspace again from the top level directory...
+ You might like to generate your IDEA workspace again from the top level directory...
</p>
<source>m2 idea:idea</source>
</subsection>