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 2011/09/30 14:31:54 UTC
svn commit: r1177628 - in
/maven/archetype/trunk/maven-archetype-plugin/src/site/apt: ./ examples/
specification/
Author: dennisl
Date: Fri Sep 30 12:31:54 2011
New Revision: 1177628
URL: http://svn.apache.org/viewvc?rev=1177628&view=rev
Log:
Fix typos in the documentation.
Modified:
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-multi-module-project.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-with-property-file.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/generate-batch.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/index.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-catalog.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-metadata.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/create-from-project.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/generate.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/specification.apt
maven/archetype/trunk/maven-archetype-plugin/src/site/apt/usage.apt
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-multi-module-project.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-multi-module-project.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-multi-module-project.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-multi-module-project.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 10 September 2008
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,12 +29,12 @@
Create an archetype from a multi-module project
Creating an archetype for a multi-module project is as simple as
- {{{../advanced-usage.html}creating one for a mono-module project}}.
+ {{{../advanced-usage.html}creating one for a single-module project}}.
Just move to the root directory of a multi-module project and call
- <<<mvn archetype:create-from-project>>>. In the archetype used as example,
- some files need to be non filtered. This achieved by giving the archetype
- plugin some value in the <<<archetype.filteredExtensions>>> property.
+ <<<mvn archetype:create-from-project>>>. In the archetype used as an example,
+ some files need to be non filtered. This is achieved by giving the archetype
+ plugin some values in the <<<archetype.filteredExtensions>>> property.
+--
$ mvn archetype:create-from-project -Darchetype.filteredExtensions=java
@@ -238,15 +238,15 @@ package: com.company
+--
As one can see, Velocity, the internal processor of archetype files,
- complains not finding some properties. One should not worry about. What is
+ complains about not finding some properties. One should not worry about that. What is
more interesting, is that the archetype plugin has renamed the original
- project module to '''__rootArtifactId__'''. And during the generation that
- named is converted to the provided artifactId.
+ project module to "__rootArtifactId__". And during the generation that
+ name is converted to the provided artifactId.
- The resulting project is shown there after.
+ The resulting directory tree of the project is shown here.
+--
- tree
+$ tree
.
|____project
| |____pom.xml
@@ -411,7 +411,7 @@ package: com.company
| | | | | |____log4j.xml
+--
- which can be compared to the original tree of the project from which the
+ This can be compared to the original tree of the project from which the
archetype is originating.
+--
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-with-property-file.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-with-property-file.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-with-property-file.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/create-with-property-file.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 16 September 2008
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -30,7 +30,7 @@ Create an archetype with a property file
Creating an archetype using a property file is possible by defining a text
file containing the properties that will lead the archetype creation, and by
- calling the archetype plugin with the command line property
+ calling the Archetype Plugin with the command line property
<<<archetype.properties>>> giving it the path to the property file.
The directory above the would be archetype project:
@@ -261,11 +261,11 @@ public class App
+--
The languages and the filtered extensions are used even if that don't make
- any sense. All the properties defined in the property file can be used in
+ any sense. All the properties defined in the property file can be used
as command line properties.
When undefined, the <<<archetype.languages>>> and <<<archetype.filteredExtensions>>>
- properties are given sensible default:
+ properties are given sensible default values:
* <<<archetype.languages>>> have: <<<java, xml, txt, groovy, cs, mdo, aj,
jsp, gsp, vm, html, xhtml, properties, .classpath, .project>>>. Notice
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/generate-batch.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/generate-batch.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/generate-batch.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/examples/generate-batch.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 04 February 2008
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,7 +29,7 @@
Generate project in batch mode
It is possible to get rid of the interactivity of the archetype plugin
- by defining the <<<interactive>>> property to <<<false>>> or by using the -B
+ by setting the <<<interactive>>> property to <<<false>>> or by using the -B
flag.
A couple of meaningful properties are then required.
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/index.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/index.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/index.apt Fri Sep 30 12:31:54 2011
@@ -4,7 +4,7 @@
Raphaël Piéroni
Hervé Boutemy
------
- 2011-08-21
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -89,7 +89,7 @@ Maven Archetype Plugin
* {{{./examples/generate-alternative-catalog.html}Generate project using an alternative catalog}}
- * {{{./examples/create-multi-module-project.html}Create an archetype from a multi module project}}
+ * {{{./examples/create-multi-module-project.html}Create an archetype from a multi-module project}}
* {{{./examples/create-with-property-file.html}Create an archetype with a property file}}
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-catalog.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-catalog.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-catalog.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-catalog.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 2011-08-22
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -29,7 +29,7 @@
How does the Archetype Plugin know about archetypes?
- Knowledge about archetypes are stored in catalogs.
+ Knowledge about archetypes is stored in catalogs.
The catalogs are xml files: see the {{{../../archetype-models/archetype-catalog/archetype-catalog.html}reference documentation}}.
@@ -41,7 +41,7 @@ How does the Archetype Plugin know about
* Catalog file explained
- A catalog is a xml file with such content:
+ A catalog is an xml file with such content:
+---
<?xml version="1.0" encoding="UTF-8"?>
@@ -88,9 +88,9 @@ How does the Archetype Plugin know about
* <<<1:>>> The index of the archetype in the aggregated list (starting from
1).
- * <<<internal>>> The name of the catalog where the archetype is originating.
+ * <<<internal>>> The name of the catalog where the archetype originates from.
- * <<<appfuse-basic-jsf>>> The artifactId of the archetype
+ * <<<appfuse-basic-jsf>>> The artifactId of the archetype.
* <<<(AppFuse archetype...)>>> The description of the archetype as found in
the catalog.
@@ -106,7 +106,7 @@ How does the Archetype Plugin know about
* Location of catalog files
- The Archetype Plugin knows by default its internal catalog. It also knows
+ The Archetype Plugin knows by default about its internal catalog. It also knows
about the <<<local>>> and <<<remote>>> catalogs.
<<<local>>> represents the <<<~/.m2/archetype-catalog.xml>>> catalog file.
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-metadata.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-metadata.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-metadata.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype-metadata.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 2011-08-22
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -27,10 +27,10 @@
~~ http://maven.apache.org/doxia/references/apt-format.html
-How is metadata on an archetype stored?
+How is metadata about an archetype stored?
The metadata about an archetype is stored in the <<<archetype-metadata.xml>>> file
- located in the directory <<<META-INF/maven>>> of its jar file: see the
+ located in the directory <<<META-INF/maven>>> of its JAR file, see the
{{{../../archetype-models/archetype-descriptor/archetype-descriptor.html}reference documentation}}.
The metadata file stores the additional properties, with corresponding
@@ -70,8 +70,8 @@ How is metadata on an archetype stored?
(<<<filtered=true>>>)
* the files will be generated in the <<<src/main/java>>> directory of the
- generated project in the same directory as in the jar file, but with
- that directory prepended by the package property.
+ generated project in the same directory as in the JAR file, but with
+ that directory prepended by the <<<package>>> property.
[]
@@ -100,25 +100,25 @@ How is metadata on an archetype stored?
</archetype-descriptor>
+---
- Here two additional properties are defined: <<<property-without-default>>>
- and <<<property-with-default>>>.
+ Here two additional properties are defined: <<<property-with-default>>>
+ and <<<property-without-default>>>.
- Be aware that the property keys can not contain any dots as they are
+ <<Note:>> The property keys can not contain any dots as they are
Velocity properties.
* Defining specific filesets
The filesets contained in the <<<archetype-metadata.xml>>> file defines the way
- the project's files located in the jar file are used by the Archetype Plugin
+ the project's files located in the JAR file are used by the Archetype Plugin
to generate a project.
Filesets must define the directory where the files will be searched for
which is also the directory where the project's files will be generated.
- The first is the directory inside the archetype jar file, the second is the
+ The first is the directory inside the archetype JAR file, the second is the
directory in the generated project's tree.
- Filesets also defines the inclusion/exclusion of files "<Ã la>" ant.
+ Filesets also defines the inclusion/exclusion of files "<Ã la>" Ant.
This provide a powerful way to describe a large set of files to be selected
for the generation process.
@@ -153,7 +153,7 @@ How is metadata on an archetype stored?
<<<src/test/java>>> directory of the archetype resources, except the
<<<AllTest.java>>> file that is located at the root of this directory.
- This filset is also packaged and filtered.
+ This fileset is also packaged and filtered.
* Defining multiple modules in the archetype metadata
@@ -161,7 +161,7 @@ How is metadata on an archetype stored?
Inner modules of an archetype are used to create a multi-module Maven
project from a single archetype.
- Modules in the <<<archetype-metadata.xml>>> file are defined like:
+ Modules in the <<<archetype-metadata.xml>>> file are defined like this:
+---
<archetype-descriptor name="multi-module">
@@ -182,8 +182,8 @@ How is metadata on an archetype stored?
named <<<SubProject>>>. This module is located in the <<<sub-project>>>
directory of the archetype. It also has the artifactId <<<subproject>>>.
- The attributes name, <<<id>>> and <<<dir>>>, of the module are used to determine the
- directory where to generate that module's files, they also are used to
+ The attributes <<<name>>>, <<<id>>> and <<<dir>>> of the module are used to determine the
+ directory where the generated module's files will appear. They also are used to
determine the artifactId of the Maven project corresponding to this
module.
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/archetype.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 10 February 2008
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -47,15 +47,15 @@ What is an archetype?
* <<<version>>> which will be the version of the project
- * <<<package>>> which will be the base package of all source files of the project
+ * <<<package>>> which will be the base package for all source files of the project
[]
-* A jar file
+* A JAR file
- The minimal content of the jar file is:
+ The minimal content of the JAR file is:
+---
.
@@ -69,22 +69,20 @@ What is an archetype?
[[1]] The metadata file that defines:
- * the default values of the common properties,
+ * the default values of the common properties
- * a set of additional properties with their default values,
+ * a set of additional properties with their default values
- * a set of archetype resources;
+ * a set of archetype resources
[]
- [[2]] The resource files defined by the archetype metadata,
+ [[2]] The resource files defined by the archetype metadata
- [[3]] The POM file of a Maven project.
+ [[3]] The POM file of a Maven project
[]
-* Note
-
- The common properties should be renamed to <<<${target.groupId}>>>, ...
- to avoid name clash.
\ No newline at end of file
+ <<Note:>> The common properties should be renamed to <<<${target.groupId}>>>, ...
+ to avoid name clash.
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/create-from-project.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/create-from-project.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/create-from-project.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/create-from-project.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 2011-08-22
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -48,7 +48,7 @@ What is done during the creation of an a
Then it creates the archetype's descriptor.
- Finishing by creating the pom for the archetype as a project.
+ Finishing by creating the POM for the archetype as a project.
* Archetype installation
@@ -68,15 +68,15 @@ What is done during the creation of an a
* Advanced batch mode
In batch mode, the additional properties can only be defined using a property
- file. This file can also contain the other properties, both the commons and
+ file. This file can also contain the other properties, both the common and
<<<filteredExtensions>>> and <<<languages>>>.
* Fileset resolution
In each module's directory and excluding submodules trees, the Archetype
- Plugin sorts the files by languages, fileteredExtensions and sensible
+ Plugin sorts the files by languages, filteredExtensions and sensible
default base paths (src/main/<languages>, src/main/<siblings>,
src/test/<languages>, src/test/<siblings>, ...).
- This defines a tri-dimensional matrix. Each sorted group (matrix' cases)
+ This defines a three-dimensional matrix. Each sorted group (matrix' cases)
becomes a resolved fileset.
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/generate.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/generate.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/generate.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/generate.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 10 February 2008
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -32,7 +32,7 @@ What is done during the creation of a pr
* Archetype selection
First, the Archetype Plugin asks the user to select an archetype from a list
- of known archetypes. Archetypes are known using archetype catalogs.
+ of known archetypes. Archetypes are found in archetype catalogs.
* Archetype configuration
@@ -40,7 +40,7 @@ What is done during the creation of a pr
four main required properties, which are the project's groupId, artifactId,
version and package.
- It also ask for values of the additional required properties defined in the
+ It also asks for values for the additional required properties defined in the
archetype's metadata file.
* Project generation
@@ -63,11 +63,11 @@ What is done during the creation of a pr
* Batch mode
- It is possible to call the Archetype Plugin to generate project in batch
+ It is possible to call the Archetype Plugin to generate a project in batch
mode (to get rid of the prompting). This is achieved by providing the
Archetype Plugin with all the needed values as system properties.
- * <<<archetypeCatalog>>> which defaults to internal specifies the catalog(s)
+ * <<<archetypeCatalog>>> which specifies the catalog(s).
The valid catalogs are: <<<internal>>> (the default), <<<local>>>, <<<remote>>>,
<<<file://path>>>, <<<http://url>>>.
@@ -82,7 +82,7 @@ What is done during the creation of a pr
<<<archetype-catalog.xml>>> file located in path directory)
* <<<http://url>>> uses the catalog file defined by url (or the
- <<<archetype-catalog.xml>>> file located in url web directory)
+ <<<archetype-catalog.xml>>> file located in URL directory)
[]
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/specification.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/specification.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/specification.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/specification/specification.apt Fri Sep 30 12:31:54 2011
@@ -3,7 +3,7 @@
------
Raphaël Piéroni
------
- 10 February 2008
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -34,7 +34,7 @@ Specification
* {{{./archetype.html}What is an archetype?}}
- * {{{./archetype-metadata.html}How is metadata on an archetype stored?}}
+ * {{{./archetype-metadata.html}How is metadata about an archetype stored?}}
* {{{./generate.html}What is done during the creation of a project?}}
Modified: maven/archetype/trunk/maven-archetype-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/archetype/trunk/maven-archetype-plugin/src/site/apt/usage.apt?rev=1177628&r1=1177627&r2=1177628&view=diff
==============================================================================
--- maven/archetype/trunk/maven-archetype-plugin/src/site/apt/usage.apt (original)
+++ maven/archetype/trunk/maven-archetype-plugin/src/site/apt/usage.apt Fri Sep 30 12:31:54 2011
@@ -5,7 +5,7 @@
Olivier Lamy
Hervé Boutemy
------
- 2011-08-31
+ 2011-09-30
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -54,7 +54,7 @@ Usage
the creation of the project.
In the following example, we selected the quickstart archetype (default value,
- which is 15 here but may vary depending on repository content)
+ which is 15 here but may vary depending on the repository content)
and set <<<groupId>>> to <<<com.company>>>, <<<artifactId>>> to <<<project>>>,
<<<version>>> to <<<1.0>>> and <<<package>>> to <<<com.company.project>>>.
@@ -160,7 +160,7 @@ project
Filtering to reduce archetype list
- As of 2.1, you can reduce the list of displayed archetypes.
+ As of version 2.1, you can reduce the list of displayed archetypes.
The filter use the following format: <<<[groupId:]artifactId>>>.
If you use single word without <<<:>>>, only artifactId will be checked.
The filtering applied is a case sensitive contains on the artifactId (and groupId if set).
@@ -175,13 +175,13 @@ $ mvn archetype:generate -Dfilter=org.ap
The displayed list will contain only archetypes with a groupId containing <<<org.apache>>> AND an artifactId containing <<<struts>>>
- [[2]] Through the prompter:
+ [[2]] Through the prompt:
+---
$ mvn archetype:generate
+---
- The full list is displayed and in the prompt response, you will be able to answer a filter.
+ The full list is displayed and in the prompt response, you will be able to answer with a filter.
+---
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): org.apache:struts