In fact, it is not documented at all.
Sebastien
-Message d'origine-
De : [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]
Envoyé : jeudi 18 mars 2004 01:06
À : Maven Users List
Objet : RE : More visual project descriptor documentation
There currently is a complete project.xml as part of the documentation.
See http://maven.apache.org/start/integrate.html
It's not terribly well documented though.
--
dIon Gillard, Multitask Consulting
Sébastien BRUNOT [EMAIL PROTECTED] wrote on 18/03/2004 03:54:51 AM:
Hi,
Another idea could be the release of a sample COMPLETE project.xml
documented. The documentation need to be completed first (for example
: what is the connection string for a subversion repository ?). Here
is my personal file for that (named project.xml.template) :
BEGINING OF THE FILE
==
==
===
?xml version=1.0 encoding=ISO-8859-1?
project
!-- the version of maven's project object model --
pomVersion3/pomVersion
!-- a unique name for this project --
idSampleJ2EE/id
!-- a short but descriptive name for the project --
nameA Sample J2EE project to compare ant versus maven build
process/name
!-- The version of the project under development, e.g.
1.
1, 1.2, 2.0-SNAPSHOT --
currentVersion1.0-SNAPSHOT/currentVersion
!-- details about the organization that 'owns' the project --
organization
!-- The full name of the organization. --
nameOcto Technology/name
!-- The URL to the organization's home page. --
urlhttp://www.octo.com//url
!-- The URL to the organization's logo image. This can be an
URL
relative to the base directory of the generated
web
site, (e.g., /images/org-logo.png) or an absolute URL
(e.g., http:
//my.corp/logo.png). This value is used
when generating the
project documentation. --
logohttp://images/octo-logo.jpg/logo
/organization
!-- the year the project started --
inceptionYear2003/inceptionYear
!-- The Java package name of the project. This value is used when
generating JavaDoc. --
packagecom.octo.j2ee.sample/package
!-- The URL to the project's logo image. This can be an URL
relative
to the base directory of the generated web site,
(e.
g., /images/project-logo.png) or an absolute URL (e.g.,
http://my.
corp/project-logo.png). This is used when
generating the
project documentation.--
logo/images/project-logo.jpg/logo
!-- Optional. This is the Id of the Gump repository that this
project
is part of (assuming it participates in the Gump
integration effort).--
gumpRepositoryId/
!-- Optional. A detailed description of the project. This element
is
usually specified as CDATA to enable the use of HTML
tags
within the description. This description is used to generate
the
front page of the project's web site.--
description
This project is a sample J2EE project that is build with maven.
The following maven sub projects are used : TO BE CONTINUED
/description
!-- a short description of what the project does --
shortDescription
How to use maven for building a j2ee project.
/shortDescription
!-- the url to the project home page --
urlhttp://localhost/samplej2ee/url
!-- Optional. The URL to the project's issue tracking system. --
issueTrackingUrl/
!-- Optional. The hostname of the web server that hosts the
project's
web site. This is used when the web site is deployed. --
siteAddresslocalhost/siteAddress
!-- Optional. The directory on the web server where the public
web
site for this project resides. This is used when the web site is
deployed. --
siteDirectoryC:/Documents and Settings/sbrunot/Mes
documents/www/samplej2ee/siteDirectory
!-- Optional. The server server where the final distributions
will be
published. This is used when the distributions are deployed.
If this isn't defined, the central repository is used
instead as
determined by maven.repo.central and maven.repo.central.
directory
--
distributionDirectory/
!-- Information relating to the source configuration management
system used by this project. --
repository
!-- Optional. The source configuration management system URL
that
describes the repository and how to connect to the repository.
This is used by Maven when building versions from specific
ID.
The format of this element is as follows:
scm:provider:
provider-parameters
For cvs, the format for pserver
repositories should be:
scm:cvs:pserver:[EMAIL PROTECTED]:
/cvs/root:module-name
For local networked repositories (eg.
pserver to local machine)
scm:cvs:lserver:[EMAIL PROTECTED]:
/cvs/root:module-name
For ssh access:
scm:
cvs:ext:[EMAIL PROTECTED]:/cvs/root:module-nameRemember that
CVS will expect
an
