Thanks Dennis for fixing the site Raphaël
2008/4/16, [EMAIL PROTECTED] <[EMAIL PROTECTED]>: > Author: dennisl > Date: Wed Apr 16 14:46:20 2008 > New Revision: 648866 > > URL: http://svn.apache.org/viewvc?rev=648866&view=rev > Log: > o Fix typos. > o Add some formatting. > > Modified: > maven/archetype/trunk/archetype-plugin/src/site/apt/advanced-usage.apt > maven/archetype/trunk/archetype-plugin/src/site/apt/index.apt > > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-catalog.apt > > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-metadata.apt > > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype.apt > > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/generate.apt > maven/archetype/trunk/archetype-plugin/src/site/apt/usage.apt > > Modified: > maven/archetype/trunk/archetype-plugin/src/site/apt/advanced-usage.apt > URL: > http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-plugin/src/site/apt/advanced-usage.apt?rev=648866&r1=648865&r2=648866&view=diff > > ============================================================================== > --- maven/archetype/trunk/archetype-plugin/src/site/apt/advanced-usage.apt > (original) > +++ maven/archetype/trunk/archetype-plugin/src/site/apt/advanced-usage.apt > Wed Apr 16 14:46:20 2008 > @@ -140,12 +140,12 @@ > > Configuration > > - The <<<create-from-project>>> mojo enable the user to provide some > sensible > + The <<<create-from-project>>> goal enable the user to provide some > sensible > configuration using the system properties or a property file. > > The system properties permits the user to define the groupId, artifactId, > version of the created archetype. They also permits to override the > resolved > package and to create a partial archetype. > > - When used, the property file takes precedence on the system properties. > + When used, the property file takes precedence over the system > properties. > It is also the only way to define additional properties in the archetype. > > Modified: maven/archetype/trunk/archetype-plugin/src/site/apt/index.apt > URL: > http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-plugin/src/site/apt/index.apt?rev=648866&r1=648865&r2=648866&view=diff > > ============================================================================== > --- maven/archetype/trunk/archetype-plugin/src/site/apt/index.apt (original) > +++ maven/archetype/trunk/archetype-plugin/src/site/apt/index.apt Wed Apr 16 > 14:46:20 2008 > @@ -41,8 +41,9 @@ > {{{usage.html}Instructions on how to use the Archetype Plugin to create a > project}} > can be found on the usage page. > > - The Archetype Plugin is embedded in IDE {{{#}eclipse}}, {{{#}netbeans}}, > - {{{#}idea}}. > +~~ TODO: The links in the following paragraph doesn't work > + The Archetype Plugin is embedded in IDEs {{{#}Eclipse}}, {{{#}NetBeans}}, > + {{{#}IDEA}}. > > {{{advanced-usage.html}Instruction on how to use the Archetype Plugin to > create an archetype from an existing project}} > can be found on the advanced usage page. > @@ -50,10 +51,10 @@ > > * Goals Overview > > - The archetype plugin has two goals: > + The archetype plugin has four goals: > > * {{{create-mojo.html}archetype:create}} creates a Maven 2 project from an > - archetype. It use the behaviour of the Archetype plugin Version > 1.0-alpha-7. > + archetype. It use the behaviour of the Archetype Plugin version > 1.0-alpha-7. > > * {{{generate-mojo.html}archetype:generate}} ask the user to choose an > archetype > from the archetype catalog, and retrieves it from the remote repository. > @@ -63,7 +64,7 @@ > an archetype from an existing project. > > * {{{crawl-mojo.html}archetype:crawl}} search a repository > - for archetype and updates a catalog. > + for archetypes and updates a catalog. > > [] > > @@ -73,16 +74,18 @@ > The following examples show how to use the Archetype Plugin in more > advanced > usecases: > > - * {{{examples/create-batch.html}create projects in batch mode}} > + * {{{examples/create-batch.html}Create projects in batch mode}} > > - * {{{#}create a sub module from an archetype}} > +~~ TODO: The link on the following line doesn't work > + * {{{#}Create a sub module from an archetype}} > > - * {{{#}select the archetype from another catalog}} > +~~ TODO: The link on the following line doesn't work > + * {{{#}Select the archetype from another catalog}} > > [] > > > - * Specification > +* Specification > > The specification page contains > {{{specification/specification.html}the specification of the main parts > of the Archetype Plugin}}. > > Modified: > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-catalog.apt > URL: > http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-catalog.apt?rev=648866&r1=648865&r2=648866&view=diff > > ============================================================================== > --- > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-catalog.apt > (original) > +++ > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-catalog.apt > Wed Apr 16 14:46:20 2008 > @@ -27,21 +27,21 @@ > ~~ http://maven.apache.org/guides/mini/guide-apt-format.html > > > -How the Archetype Plugin know about archetype? > +How the Archetype Plugin knows about archetypes? > > Knowledge about archetypes are stored in catalogs. > > The catalogs are xml files. > > The Archetype Plugin comes bundled with an internal catalog. > - The one used by default. > + This one is used by default. > > The Archetype Plugin can use catalogs from local filesystem and from HTTP > - connexions. > + connections. > > * Catalog file explained > > - Catalogs are xml file with such content: > + A catalog is an xml file with such content: > > +--- > <?xml version="1.0" encoding="UTF-8"?> > @@ -66,7 +66,7 @@ > [[3]] The version of the archetype. <<<RELEASE>>> is a valid version. > <<REQUIRED>> > > [[4]] The repository where to find the archetype. <<OPTIONAL>>. When > - ommited, the archetype is searched in the repository where the > catalog > + ommitted, the archetype is searched for in the repository where > the catalog > comes from. > > [[5]] The description of the archetype. <<OPTIONAL>> > @@ -76,7 +76,7 @@ > > During the creation of a project from an archetype, the Archetype Plugin > ask the user to choose an archetype from a list containing the archetypes > - from each of the provided catalogs (Yes there may be many). > + from each of the provided catalogs (Yes, there may be many). > > For each archetype in the list the Archetype Plugin shows a line like: > > @@ -100,12 +100,12 @@ > At the end of the <<<create-from-project>>> behaviour, the Archetype > Plugin > install/deploy the archetype, and update the local/remote catalog. > > - The <<<crawl-repository>>> mojo is used to create a catalog file by > crawling > + The <<<crawl-repository>>> goal is used to create a catalog file by > crawling > a Maven 2 repository located in the filesystem. > > * Location of catalog files > > - The Archetype Plugin knows by default its internal catalog. It also know > + The Archetype Plugin knows by default its internal catalog. It also > knows > about the <<<local>>> and <<<remote>>> catalogs. > > <<<local>>> represents the catalog file > <<<~/.m2/archetype-catalog.xml>>>. > @@ -113,6 +113,6 @@ > <<<remote>>> represents the catalog file > <<<http://repo1.maven.org/maven2/archetype-catalog.xml>>>. > > The Archetype Plugin can also read catalogs from filesystem/HTTP by > - providing the path/URL of a catalog file or of a directory contaings the > + providing the path/URL of a catalog file or of a directory containing > the > <<<archetype-catalog.xml>>> file. > > > Modified: > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-metadata.apt > URL: > http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-metadata.apt?rev=648866&r1=648865&r2=648866&view=diff > > ============================================================================== > --- > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-metadata.apt > (original) > +++ > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype-metadata.apt > Wed Apr 16 14:46:20 2008 > @@ -29,18 +29,18 @@ > > How metadata on an archetype is stored? > > - The metadata about an archetype is stored in the archetype-metadata.xml > file > - located in the directory META-INF/maven of it's jar file. > + The metadata about an archetype is stored in the > <<<archetype-metadata.xml>>> file > + located in the directory <<<META-INF/maven>>> of its jar file. > > - The metadata file stores the additionnal properties, with corresponding > + The metadata file stores the additional properties, with corresponding > default values. > > - It also stores the project's files generation in filesets. > + It also stores the project's generated files in filesets. > > - Finnaly it also stores inner modules of the archetype, which enable the > - creation of multi-modules projects with a single archetype. > + Finally it also stores inner modules of the archetype, which enable the > + creation of multi-module projects using a single archetype. > > - A minimal archetype-metadata.xml file looks like: > + A minimal <<<archetype-metadata.xml>>> file looks like: > > +--- > <?xml version="1.0" encoding="UTF-8"?> > @@ -62,13 +62,13 @@ > > * the archetype defines a single fileset: > > - * the fileset will take all the files in > archetype-resources/src/main/java > + * the fileset will take all the files in > <<<archetype-resources/src/main/java>>> > that match the <<<**/*.java>>> pattern > > - * the selected files will be generated using the velocity engine > + * the selected files will be generated using the Velocity engine > (<<<filtered=true>>>) > > - * the files will be generated in the src/main/java directory of the > + * 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. > > @@ -77,15 +77,15 @@ > [] > > > - * Defining additional properties > +* Defining additional properties > > - The main properties that are used by the velocity engine during > project's file generation are groupId, artifactId, version, package. > + The main properties that are used by the Velocity engine during a > project's file generation are groupId, artifactId, version and package. > > - It is possible to define additionnal properties that must be valued > before the file generation. > + It is possible to define additional properties that must be valued > before the file generation. > > - These additionnal properties can be provided with default values, which > enable not to ask the user for there values. > + These additional properties can be provided with default values, which > enable not to ask the user for there values. > > - Additionnal properties are defined in the archetype-metadata.xml file > with: > + Additional properties are defined in the <<<archetype-metadata.xml>>> > file with: > > +--- > <archetype-descriptor name="basic"> > @@ -99,16 +99,16 @@ > </archetype-descriptor> > +--- > > - Here two additionnal properties are defined: > <<<property-without-default>>> > + Here two additional properties are defined: > <<<property-without-default>>> > and <<<property-with-default>>>. > > - Be aware that the property keys can not contain any dot as there are > - velocity properties. > + Be aware that 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 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 > to generate a project. > > @@ -118,19 +118,19 @@ > directory in the generated project's tree. > > Filesets also defines the inclusion/exclusion of files "Ã la " ant. > - This provide a powerfull way to describe a large set of files to be > selected > + This provide a powerful way to describe a large set of files to be > selected > for the generation process. > > Filesets can be filtered, which means the selected files will be used > as Velocity templates. They can be non-filtered, which means the selected > - files will be binary copied. > + files will be copied without modification. > > Filesets can be packaged, which means the selected files will be > generated/copied in a directory structure that is prepended by the > package > property. They can be non-packaged, which means that the selected files > will be generated/copied without that prepend. > > - A fileset is defined in the archetype-metadata.xml with this fragment: > + A fileset is defined in the <<<archetype-metadata.xml>>> with this > fragment: > > +--- > ... > @@ -141,7 +141,7 @@ > <include>**/*.java</include> > </includes> > <excludes> > - <excludeAllTest.java</include> > + <exclude>AllTest.java</exclude> > </excludes> > </fileSet> > </fileSets> > @@ -149,7 +149,7 @@ > +--- > > This example shows a fileset that will select all the java files in the > - <<<src/test/java>>> directory of the archetype resources, but the > + <<<src/test/java>>> directory of the archetype resources, except the > <<<AllTest.java>>> file that is located at the root of this directory. > > This filset also is packaged and filtered. > @@ -160,7 +160,7 @@ > Inner modules of an archetype are used to create a multi module Maven 2 > 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: > > +--- > <archetype-descriptor name="multi-module"> > @@ -182,23 +182,23 @@ > 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 togenerated that module files, they also are used to > + directory where to generate that module's files, they also are used to > determine the artifactId of the Maven 2 project corresponding to this > module. > > > -* Putting all together > +* Putting it all together > > - The <<<requiredProperties>>> is only allowed as a child of > - archetype-descriptor. > + The <<<\<requiredProperties\>>>> element is only allowed as a child of > + <<<\<archetype-descriptor\>>>>. > > - Modules are allowed in archetype-descriptor and in modules (no limit is > + Modules are allowed in <<<\<archetype-descriptor\>>>> and in > <<<\<modules\>>>> (no limit is > given). > > - archetype-descriptor and modules must define at least one fileset each > to > + <<<\<archetype-descriptor\>>>> and <<<\<modules\>>>> must define at > least one <<<\<fileSet\>>>> each to > be valid. > > - It is possible to define default values to main required properties by > + It is possible to define default values for required properties by > defining say the groupId and giving it a default: > > +--- > @@ -207,10 +207,11 @@ > <requiredProperty key="groupId"> > <defaultValue>com.company.department</defaultValue> > </requiredProperty> > + </requiredProperties> > +--- > > Filesets can be defined from the root directory of the module/project by > - having a blank in its directory element: > + having an empty <<<\<directory\>>>> element: > > +--- > ... > > Modified: > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype.apt > URL: > http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype.apt?rev=648866&r1=648865&r2=648866&view=diff > > ============================================================================== > --- > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype.apt > (original) > +++ > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/archetype.apt > Wed Apr 16 14:46:20 2008 > @@ -31,12 +31,12 @@ > > * A Maven 2 project 'en devenir' > > - I.e. a abstract representation of a kind of project > - that can be instanciated into a concrete customised > + I.e. an abstract representation of a kind of project > + that can be instantiated into a concrete customised > Maven 2 project. > > An archetype knows which files will be part of the > - instanciated project and which properties to fill > + instantiated project and which properties to fill > to properly customise the project. > > Each archetype defines a set of common properties: > @@ -77,14 +77,14 @@ > > [] > > - [[2]] The resources files defined by the archetype metadata, > + [[2]] The resource files defined by the archetype metadata, > > - [[3]] The pom file of a Maven 2 project. > + [[3]] The POM file of a Maven 2 project. > > [] > > > * Note > > - The common properties should be renamed to ${target.groupId}, ... > + The common properties should be renamed to <<<${target.groupId}>>>, ... > to avoid name clash. > > Modified: > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/generate.apt > URL: > http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-plugin/src/site/apt/specification/generate.apt?rev=648866&r1=648865&r2=648866&view=diff > > ============================================================================== > --- > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/generate.apt > (original) > +++ > maven/archetype/trunk/archetype-plugin/src/site/apt/specification/generate.apt > Wed Apr 16 14:46:20 2008 > @@ -48,17 +48,17 @@ > Finally, the Archetype Plugin generates the Maven 2 project from the > selected/configured archetype. > > - The archetype used to generate the project can be mono or multi module. > + The archetype used to generate the project can be single or multi > module. > > The archetype used to generate the project can be partial, which means it > - enhance an existing project instead of creating a new one. > + enhances an existing project instead of creating a new one. > > - If the Archetype Plugin is called from an existing project, using an > + If the Archetype Plugin is called from an existing project, using a > complete (not partial) archetype, then it generates a sub module in the > existing project. > > If the Archetype Plugin is configured to create a project in an existing > - directory, it first check for the existence of a pom.xml file before > + directory, it first check for the existence of a <<<pom.xml>>> file > before > failing the generation. > > * Batch mode > @@ -78,10 +78,10 @@ > file > > * <<<file://path>>> uses the catalog file defined by path (or the > - archetype-catalog.xml file located in path directory) > + <<<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 web directory) > > [] > > @@ -92,7 +92,7 @@ > * <<<archetypeVersion>>> specifies the version of the archetype to use > > * <<<archetypeRepository>>> specifies the repository in which the > archetype > - reside > + resides > > * <<<groupId>>> specifies the groupId of the generated project > > @@ -109,4 +109,4 @@ > > * Behind a Proxy > > - Beeing behind a proxy is automatically configured by Maven > + Being behind a proxy is automatically configured by Maven. > > Modified: maven/archetype/trunk/archetype-plugin/src/site/apt/usage.apt > URL: > http://svn.apache.org/viewvc/maven/archetype/trunk/archetype-plugin/src/site/apt/usage.apt?rev=648866&r1=648865&r2=648866&view=diff > > ============================================================================== > --- maven/archetype/trunk/archetype-plugin/src/site/apt/usage.apt (original) > +++ maven/archetype/trunk/archetype-plugin/src/site/apt/usage.apt Wed Apr 16 > 14:46:20 2008 > @@ -27,7 +27,7 @@ > ~~ http://maven.apache.org/guides/mini/guide-apt-format.html > > > -Projet creation > +Project creation > > Creating a project from an archetype involves three steps: > > @@ -44,11 +44,11 @@ > Calling <<<archetype:generate>>> the plugin will first ask to choose > the archetype from the internal catalog. Just enter the number of the > archetype. > > - It then ask to enter the values for the groupId, the artifactId > - and the version of the project to create and the basic package > + It then asks you to enter the values for the groupId, the artifactId > + and the version of the project to create and the base package > for the sources. > > - It then ask for the confirmation of the configuration and perform > + It then asks for confirmation of the configuration and performs > the creation of the project. > > In the following example, we selected the quickstart archetype (numbered > 15) > @@ -167,6 +167,8 @@ > Backward compatibility > > For backward compatibility with the Archetype Plugin version 1.0-alpha-7, > - we keeped the old create goal which can be called using > - <<<mvn archetype:create>>>. See {{{#}the old documentation}} for further > + we kept the old <<<create>>> goal which can be called using > + <<<mvn archetype:create>>>. > +~~ TODO: The link on the following line doesn't work > + See {{{#}the old documentation}} for further > reading. > > >
