You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2006/08/10 23:20:12 UTC
svn commit: r430533 - in /maven/site/trunk/src/site/apt:
background/philosophy-of-maven.apt guides/getting-started/index.apt
Author: dennisl
Date: Thu Aug 10 14:20:12 2006
New Revision: 430533
URL: http://svn.apache.org/viewvc?rev=430533&view=rev
Log:
[MNG-2250] fix misspelled and added missing words in getting started guide and philosphy of maven.
Patch provided by Roy Hodgman.
Modified:
maven/site/trunk/src/site/apt/background/philosophy-of-maven.apt
maven/site/trunk/src/site/apt/guides/getting-started/index.apt
Modified: maven/site/trunk/src/site/apt/background/philosophy-of-maven.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/background/philosophy-of-maven.apt?rev=430533&r1=430532&r2=430533&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/background/philosophy-of-maven.apt (original)
+++ maven/site/trunk/src/site/apt/background/philosophy-of-maven.apt Thu Aug 10 14:20:12 2006
@@ -11,13 +11,13 @@
Maven is generally considered by many to be a build tool. Many people who come to Maven initially are familiar
with Ant so it's a natural association but Maven is not just a build tool, and not just a replacement for Ant.
Maven is an entirely different creature from Ant. Ant is simply a toolbox whereas Maven is about the
- application of patterns in order to acheive an infrastructure which displays the characteristics of
+ application of patterns in order to achieve an infrastructure which displays the characteristics of
visibility, reusability, maintainability, and comprehensibility.
- Without these characteristics it is highly improbable multiple individuals will work productively together
- on a project. Without visibility it is unlikely an invidual will know what another has accomplished and as such
- there is a very good chance useful code will not be resused. When code is not resused it is very hard to create
- a maintainable system. When everyone is constanstly rooting around trying to figure out where all these different
+ Without these characteristics it is highly improbable that multiple individuals will work productively together
+ on a project. Without visibility it is unlikely an individual will know what another has accomplished and as such
+ there is a very good chance useful code will not be reused. When code is not reused it is very hard to create
+ a maintainable system. When everyone is constantly rooting around trying to figure out where all these different
bits and pieces are that make up your project there is very little chance anyone is going to comprehend the
project as a whole. As a result you end up with the silo effect, a decay of shared knowledge along with
the commensurate degree of frustration among team members. A natural effect when processes don't work
Modified: maven/site/trunk/src/site/apt/guides/getting-started/index.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/getting-started/index.apt?rev=430533&r1=430532&r2=430533&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/getting-started/index.apt (original)
+++ maven/site/trunk/src/site/apt/guides/getting-started/index.apt Thu Aug 10 14:20:12 2006
@@ -9,7 +9,7 @@
Maven Getting Started Guide
This guide is intended as a reference for those working with Maven for the first time, but is also intended to serve as
- a cookbook with self-contained references and solutions for common usecases. For first time users, it is recommended
+ a cookbook with self-contained references and solutions for common use cases. For first time users, it is recommended
that you step through the material in a sequential fashion. For users more familiar with Maven, this guide endeavours
to provide a quick solution for the need at hand. It is assumed at this point that you have downloaded Maven and
installed Maven on your local machine. If you have not done so please refer to the
@@ -105,8 +105,8 @@
To create our first Maven project we are going to use Maven's archetype mechanism. An archetype is defined as
<an original pattern or model from which all other things of the same kind are made>. In Maven, an archetype is a template
of a project which is combined with some user input to produce a working Maven project that has been tailored to the
- user's requirements. We are going to show you how the archetype mechanism works now, but if you would to know more about
- archetypes please refer to our {{{../introduction/introduction-to-archetypes.html}Introduction to Archetypes}}.
+ user's requirements. We are going to show you how the archetype mechanism works now, but if you would like to know more
+ about archetypes please refer to our {{{../introduction/introduction-to-archetypes.html}Introduction to Archetypes}}.
On to creating your first project! In order to create the simplest of Maven projects, execute the following from
the command line:
@@ -118,7 +118,7 @@
+-----+
Once you have executed this command, you will notice a few things have happened. First, you will notice that
- a directory names <<<my-app>>> has been created for the new project, and this directory contains a file named
+ a directory named <<<my-app>>> has been created for the new project, and this directory contains a file named
<<<pom.xml>>> that should look like this:
+-----+
@@ -166,7 +166,7 @@
* <<artifactId>> This element indicates the unique base name of the primary artifact being generated by this project.
The primary artifact for a project is typically a JAR file. Secondary artifacts like source bundles also use
- the artifactId as part of their final name. A typical artifact produced by would have the form
+ the artifactId as part of their final name. A typical artifact produced by Maven would have the form
\<artifactId\>-\<version\>.\<extension\> (for example, <<<myapp-1.0.jar>>>).
* <<packaging>> This element indicates the package type to be used by this artifact (e.g. JAR, WAR, EAR, etc.).
@@ -187,7 +187,7 @@
* <<url>> This element indicates where the project's site can be found. This is often used in Maven's
generated documentation.
- * <<description>> This elements provides a basic description of your project. This is often used in
+ * <<description>> This element provides a basic description of your project. This is often used in
Maven's generated documentation.
[]
@@ -269,11 +269,11 @@
The first time you execute this (or any other) command, Maven will need to download all the plugins and related
dependencies it needs to fulfill the command. From a clean installation of Maven this can take quite a while (in
the output above, it took almost 4 minutes). If you execute the command again, Maven will now have what it needs,
- so it won't need to download anything new and will be able to execute the command much quicker.
+ so it won't need to download anything new and will be able to execute the command much more quickly.
As you can see from the output, the compiled classes were placed in <<<$\{basedir\}/target/classes>>>, which is
- another standard convention employed by Maven. So, if you're a keen observer you'll notice that using the
- standard conventions the POM above is very small and you haven't explicity had to tell Maven where any of
+ another standard convention employed by Maven. So, if you're a keen observer, you'll notice that by using the
+ standard conventions the POM above is very small and you haven't had to tell Maven explicitly where any of
your sources are or where the output should go. By following the standard Maven conventions you can get
a lot done with very little effort! Just as a casual comparison, let's take a look at what you might have had to do
in {{{http://ant.apache.org}Ant}} to accomplish the same {{{../../ant/build-a1.xml}thing}}.
@@ -365,7 +365,7 @@
If you take a look at the POM for your project you will notice the <<<packaging>>> element is set to <<<jar>>>.
This is how Maven knows to produce a JAR file from the above command (we'll talk more about this later).
- You can now take a look in the the <<<$\{basedir\}/target>>> directory and you will see the generated JAR file.
+ You can now take a look in the <<<$\{basedir\}/target>>> directory and you will see the generated JAR file.
Now you'll want to install the artifact you've generated (the JAR file) in your local repository
(<<<~/.m2/repository>>> is the default location). For more information on repositories you can refer to our
@@ -438,7 +438,7 @@
[]
You have walked through the process for setting up, building, testing, packaging, and installing a typical Maven project.
- This is likely the vast majority of what projects will be doing with Maven and if you'ved noticed, everything you've been
+ This is likely the vast majority of what projects will be doing with Maven and if you've noticed, everything you've been
able to do up to this point has been driven by an 18-line file, namely the project's model or POM. If you look at
a typical Ant {{{../../ant/build-a1.xml}build file}} that provides the same functionality that we've achieved thus
far you'll notice it's already twice the size of the POM and we're just getting started! There is far more
@@ -465,7 +465,7 @@
+----+
- This will remove the<<<target>>> directory with all the build data before starting so that it is fresh.
+ This will remove the <<<target>>> directory with all the build data before starting so that it is fresh.
Perhaps you'd like to generate an IntelliJ IDEA descriptor for the project?
@@ -528,10 +528,10 @@
* {How do add resources to my JAR?}
- Another common usecase that can be satisfied which requires no changes to the POM that we have
+ Another common use case that can be satisfied which requires no changes to the POM that we have
above is packaging resources in the JAR file. For this common task, Maven again relies on the
{{{../introduction/introduction-to-the-standard-directory-layout.html}Standard Directory Layout}}, which means by using
- standard Maven coventions you can package resources within JARs simply by placing those resources in a standard
+ standard Maven conventions you can package resources within JARs simply by placing those resources in a standard
directory structure.
You see below in our example we have added the directory <<<$\{basedir\}/src/main/resources>>> into which we place
@@ -854,7 +854,7 @@
works in a bit more detail. For a more thorough introduction, please refer to our
{{{../introduction/introduction-to-dependency-management.html}Introduction to Dependency Management}}.
- The <<<dependencies>>> section of the pom.xml lists all of the external dependencies that particular needs
+ The <<<dependencies>>> section of the pom.xml lists all of the external dependencies that our project needs
in order to build (whether it needs that dependency at compile time, test time, run time, or whatever). Right
now, our project is depending on JUnit only (I took out all of the resource filtering stuff for clarity):
@@ -1070,7 +1070,7 @@
* {How do I create documentation?}
To get you jump started with Maven's documentation system you can use the archetype mechanism to generate a site
- for you without your existing project using the following command:
+ for your existing project using the following command:
+----+
@@ -1132,7 +1132,7 @@
The Xdoc format is the same as {{{http://maven.apache.org/maven-1.x/using/site.html} used in Maven 1.0}}. However, <<<navigation.xml>>>
has been replaced by the site descriptor (see below).
- The APT format, "Almost Plain Text", is a wiki-like format that allows you to write simple, structured documents (like this)
+ The APT format, "Almost Plain Text", is a wiki-like format that allows you to write simple, structured documents (like this one)
very quickly. A full reference of the {{{../mini/guide-apt-format.html} APT Format}} is available.
The FML format is the FAQ format, also used in Maven 1.0.
@@ -1172,7 +1172,7 @@
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>>> goal independantly.
+ You must presently run the <<<site>>> goal independently.
---------------
mvn site-deploy
@@ -1229,7 +1229,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.
@@ -1244,7 +1244,7 @@
+- pic1.jpg
--------------------
- The file <<<site.css>>> will be added to the default XHTML output, so can be used to adjust the default Maven stylesheets if desired.
+ The file <<<site.css>>> will be added to the default XHTML output, so it can be used to adjust the default Maven stylesheets if desired.
The file <<<pic1.jpg>>> will be available via a relative reference to the <<<images>>> directory from any page in your site.
@@ -1317,17 +1317,17 @@
+- site_fr.xml (French site descriptor)
--------------------
- With one site descriptor by language, translated site can evolve independently.
+ With one site descriptor by language, a translated site can evolve independently.
* {How do I build other types of projects?}
- Note that the lifecycle applies to any project type. For example, back in the base direcotry we can create a
+ Note that the lifecycle applies to any project type. For example, back in the base directory we can create a
simple web application:
-------------------
mvn archetype:create \
-DgroupId=com.mycompany.app -DartifactId=my-webapp \
- -DarchetypeArtifactId=maven-archetype-webapp</source>
+ -DarchetypeArtifactId=maven-archetype-webapp
-------------------
Note that these must all be on a single line. This will create a directory called
@@ -1354,7 +1354,7 @@
</project>
-------------------
- Note the <<<\>packaging\>>>> element - this tells Maven to build as a WAR. Change into the webapp project's directory
+ Note the <<<\<packaging\>>>> element - this tells Maven to build as a WAR. Change into the webapp project's directory
and try:
-------------------