dion 2003/07/16 18:19:33
Added: xdocs/misc glossary.xml tasks.xml index.xml articles.xml
powered.xml
Log:
Reorg docs
Revision Changes Path
1.1 maven/xdocs/misc/glossary.xml
Index: glossary.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
<author email="Stéphane Mor">Stéphane Mor</author>
<title>Glossary</title>
</properties>
<body>
<section name="Glossary">
<p>
This document describes some of the most common terms encountered while
using Maven. Those terms, that have an explicit meaning for Maven
developpers, can sometimes be confusing for newcomers.
</p>
<table>
<tr><th>Term</th><th>Description</th></tr>
<tr>
<td>Artifact</td>
<td>
An artifact is something that is either produced or used by a
project. Examples of artifacts produced by Maven for a project
include: JARs, source and binary distributions, WARs.
</td>
</tr>
<tr>
<td>Dependency</td>
<td>
A typical Java project relies on libraries to build and/or run.
Those are called "dependencies" inside Maven. Those dependencies are
usually other projects' JAR artifacts.
</td>
</tr>
<tr>
<td>Plugin</td>
<td>
Maven is organized in plugins. Every piece of functionality in
Maven is provided by a plugin. Plugins are Jelly scripts which are
given the POM to perform their task. Examples of plugins are: jar,
eclipse, war. You usually call a plugin with its name, such as
<code>maven jar</code>. Plugins can be added, removed, edited at
runtime.
</td>
</tr>
<tr>
<td>Project</td>
<td>
Maven thinks in terms of projects. Everything that you will build
are projects. Those projects follow a well defined "Project Object
Model". Projects can depend on other projects, in which case the
latter are called "dependencies".
</td>
</tr>
<tr>
<td>Project Object Model (POM)</td>
<td>
The Project Object Model, almost always referred as the POM, is the
document that Maven needs to work with your project. Its name is
"project.xml" and is located in the root directory of your project.
<p>
To learn how to build the POM for your project, please read
<a href="reference/project-descriptor.html">this document</a>.
</p>
</td>
</tr>
<tr>
<td>Repository</td>
<td>
A repository is an structured storage of project artifacts. Those
artifacts are organized under the following structure:
<code>$MAVEN_REPO/project id/artifact
type/project-version.extension</code>.
<p>
For instance, a Maven JAR artifact will be stored in a repository
under <code>/foo/maven/jars/maven-1.0_beta-8.jar</code>.
</p>
<p>
There are different repositories that Maven uses. The "remote
repository" is the global repository (or one of its mirrors) used
to download missing artifacts. The "central repository" is the one
used for a site-wide installation (for developpers of a company
for instance). The "local repository" is the one that you will
have on your computer. The local repository is filled with
dependencies coming from either the central repository or the
remote one.
</p>
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 maven/xdocs/misc/tasks.xml
Index: tasks.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Tasks</title>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
</properties>
<body>
<section name="Tasks">
<p>
</p>
<subsection name="Beta 9">
<p>
Try to fix as many issues as possible and get the documentation up to
scratch. We
are going to try and get this release out sooner rather than later.
</p>
<p>
<ul>
<li>
Plugins must have tests. There are a couple of plugins that are busted
because it's not possible to test them by hand. We need to
create a mechanism for test them for real reliablility. Velocity
was removed from the Maven core and as a result many Plugins are
now busted. Users will need HEAD for some plugins to work which
is not good.
</li>
</ul>
</p>
</subsection>
<subsection name="Beta 10">
<p>
<ul>
<li>
Implement arbitrary artifact type handling. Michal Maczka ([EMAIL
PROTECTED])
had a very good solution but we didn't get around to getting it
in. Sorry about that Michal, please be patient.
</li>
<li>
Switch to classworlds to allow real isolation in plugins and real
embedding of Maven in client applications. This will all revolve around
allowing a ClassWorld to be initialized with MavenSession. We would
truly
like to decouple MavenSession from the CLI front-end. Possibly using a
system property to pass in a set of JARs to populate the initial
ClassWorld.
From there we can create child ClassWorlds for the plugins to execute
in.
</li>
<li>
Add the use of checksums in the verification process. Throw an
ArtifactCorruptionException when the artifact cannot be
verified against the checksum. This mechanism has been implmented, but
we were having problems getting the checksums up to ibiblio reliably.
We need
to thoroughly test the Jelly script that we are using for deployment
and we
could probably also do with the shell scripts that can be run
periodically
on repositories to make sure the checksums are valid.
</li>
<li>
Release vs HEAD website (so the inconsistencies we have in our
current situation can be alleviated. This is a real problem that needs
to be solved. We simply need a way to flag an incremental HEAD site
update as opposed to a release update.
</li>
<li>
Addition of POM entries to allow anonymous checkout
</li>
<li>
Test the http auth mode for repositories. Code is there just haven't
tried it.
</li>
</ul>
</p>
</subsection>
<subsection name="Unassigned">
<p>
<ul>
<li>
Roadmap document. (jvz)
</li>
<li>
Write proposal for globally distributed JAR repository and distribution
repository. There are definite things to be learned from the Perl
folks.(jvz)
</li>
<li>
Need to restructure the mailing lists and object model so
that we can easily select the dev mailing list for continuous
integration problems. discovered when trying to apply the
nag feature of gump.
</li>
<li>
Status document (weekly report type thing).
</li>
<li>
Add maven:plugin-list target to list all known plugins from
remote repos. Each repo may optionally provide a plugins.list
file similar to the jars.list. A plugin is packaged as a jar file.
</li>
<li>
How to generally deal with example code and where it belongs
in the source tree and how it should be package in the
distribution.
</li>
<li>
Release generated page based on the distribution directory and some
standard text. just looking at things that can be culled from
the turbine site.
</li>
<li>
Same with the 'how do i contribute' blurb at the bottom of the t2
pages. those can be generated.
</li>
<li>
A little report displaying the use of dev JARs as opposed to
using released versions of products. Encourage projects to
try and use released versions of JARs.
</li>
<li>
Need a way to transform a POM across multiple versions
of Maven. For any number of reasons a project may decide to
hold back on upgrading Maven immediately and we need to make
sure that users can move safely upgrade across N versions.
</li>
</ul>
</p>
</subsection>
</section>
<section name="Complete">
<p>
<ul>
<li>
JXR task needs to be modified so that XML is produced so that it
can be transformed to into something that looks better.
</li>
<li>
Formalize how jarResources elements are moved from the project
directory layout into the classpath for testing and into the JAR
that is packaged with the distribution.
</li>
<li>
Generate xdoc from LICENSE.txt to show the project license and
then link to it from the project info menu. Suggestion by Markus
May that sounds good.
</li>
<li>
Add support for the various coding specifications so that those
properties
can be applied to things like checkstyle and to create a document
outlining the coding specification.
</li>
<li>
Maven:deploy-dist needs to work. (jvz)
</li>
<li>
Snapshot JARs need to be used for all versions of JARs that
aren't released. So we can get rid of the update-jars
functionalility.
</li>
<li>
Minimal reactor. This includes the dep graph, central repository
of deps and all that jazz.
</li>
<li>
POM inheritence mechanism. Will wait for the switch to betwixt.
</li>
<li>
Generation of a standard build.xml file.
</li>
<li>
Script execution. Remove the requirement of the Ant execution
environment. Along with this we'll get the exception handling
we've been looking for.
</li>
<li>
See if jxr can be configured to only generate one file.gif and
folder.gif, rather than one per source folder (dIon)
</li>
<li>
xref produces cross references for &lt;sourceDirectories&gt; and
&lt;testSourceDirectories&gt;. javadoc produces html for
&lt;sourceDirectories&gt; only.
</li>
<li>
When we are dealing with non-distributable JARs we may have to
give the user some additional info like telling them they have
to rename a JAR. So add another field which would contain a
message blurb to display to the user in these cases.
</li>
<li>
A process for moving things from the task list to a list of items
completed so they can be listed in documentation for a release
automatically.
</li>
<li>
Schema for project.xml (jvz)
</li>
<li>
Maven POM updater: a reliable way to transform the project.xml file when
changes are made. The coming changes to specification of tests will
change the structure of the project.xml file and it should be easy
for users to absorb these changes. They need to be notified, allowed
to choose the changes when they wish and have the changes
transparently applied.
</li>
<li>
Make a document that displays the list of currently registered
projects.
</li>
<li>
Add a maven:xml-validate target which will validate all xml source
against it's DTD (if present). Will most likely need a new element
in project.xml (&lt;xmlSourceDirectories&gt;) similar to source
directories. Any directory listed in an
&lt;xmlSourceDirectory&gt;
will be validated.
</li>
</ul>
</p>
</section>
</body>
</document>
1.1 maven/xdocs/misc/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Miscellaneous</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<section name="Miscellaneous">
<p>
These are various informational documents about Maven, including
<ul>
<li><a href="articles.html">Articles about Maven</a></li>
<li><a href="glossary.html">A glossary of terms used in this
documentation</a></li>
<li><a href="powered.html">Sites powered by Maven</a></li>
<li><a href="tasks.html">Tasks awaiting volunteers</a></li>
</ul>
</p>
</section>
</body>
</document>
1.1 maven/xdocs/misc/articles.xml
Index: articles.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
<title>Articles</title>
</properties>
<body>
<section name="Maven in the press">
<ul>
<li>
<a href="http://www.pivolis.com/pdf/J2EE_projects_Maven_V1.1.pdf";>
Building J2EE applications with Maven (Slides from TheServerSide
Symposium)
</a>.
</li>
<li>
<a href="http://www-106.ibm.com/developerworks/java/library/j-maven/";>
Project management: Maven makes it easy
</a>
</li>
<li>
<a href="http://www.javaworld.com/javaworld/jw-10-2002/jw-1011-maven.html";>
Maven ties together tools for better code management
</a>
</li>
<li>
<a href="http://radio.weblogs.com/0116794/2003/01/03.html";>
Weblog: Morgan Delagrange
</a>
</li>
<li>
<a href="http://www.javausergroup.at/events/maven.pdf";>
The Stairway to Maven by Siegfried G?SCHL
</a>
</li>
</ul>
</section>
<section name="Articles">
<ul>
<li>
<a href="http://www.stqemagazine.com/featured.asp?id=20";>
Learning to Love Unit Testing</a>
</li>
<li>
<a href="http://www.martinfowler.com/articles/continuousIntegration.html";>
Continuous Integration
</a>
</li>
<li>
<a
href="http://www-106.ibm.com/developerworks/webservices/library/co-single.html";>
Use your singletons wisely
</a>
</li>
</ul>
</section>
</body>
</document>
1.1 maven/xdocs/misc/powered.xml
Index: powered.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Powered By Maven</title>
<author email="[EMAIL PROTECTED]">Pete Kazmier</author>
</properties>
<body>
<section name="Powered By Maven">
<p>
This page contains a list of known projects successfully using
Maven. We would be very interested if you would drop us a note
if you are using Maven with your project and would like to be
added to this list.
</p>
<subsection name="Projects Using Maven">
<table>
<tr><th>Project</th><th>Overview</th></tr>
<tr>
<td><a href="http://arara.sourceforge.net/";>Arara Organizer</a></td>
<td>
An organizer application.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/bcel/";>BCEL</a></td>
<td>
Java Byte Code Engineering Library.
</td>
</tr>
<tr>
<td><a href="http://beep4j.org";>beep4j</a></td>
<td>
BEEP Framework for Java (RFC 3080/3081).
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/betwixt/";>Betwixt</a></td>
<td>
An XML introspection mechanism for mapping beans to XML in a
flexible way.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/cli/";>CLI</a></td>
<td>
A simple and easy to use API for working with the command line
arguments and options.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/dbcp/";>Commons DBCP</a></td>
<td>
Commons Database Connection Pooling.
</td>
</tr>
<tr>
<td><a
href="http://jakarta.apache.org/commons/sandbox/fileupload/";>Commons File
Upload</a></td>
<td>
File upload component that uses the Java Activation Framework.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/sandbox/net/";>Commons
Net</a></td>
<td>
Commons client network components.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/pool/";>Commons Pool</a></td>
<td>
Commons Pooling.
</td>
</tr>
<tr>
<td><a href="http://communitytools.warneronstine.com";>Community
Tools</a></td>
<td>
A Web-based community system, bringing together blogging, Slashdot-like
news, polling and other community tools.
</td>
</tr>
<tr>
<td><a href="http://projects.walding.com/dataforge/";>DataForge</a></td>
<td>
A pipeline based data extraction tool capable of querying a wide variety
of data sources.
</td>
</tr>
<tr>
<td><a href="http://drools.org";>drools</a></td>
<td>
Dynamic object-oriented RETE-based rules engine.
</td>
</tr>
<tr>
<td><a href="http://eyebrowse.tigris.org/";>Eyebrowse</a></td>
<td>
A web-based mailing list archive browser.
</td>
</tr>
<tr>
<td><a href="http://www.softcon-itec.de/maven/exudo/";>Exudo</a></td>
<td>
A JUnit extension for automated testing of web
applications. It uses an intelligent record/playback
approach to testing that filters test relevant content
from presentation detail. Exudo also has a JDBC testing
framework and an easy to use XML based test runner.
</td>
</tr>
<tr>
<td><a href="http://fpsstats.sourceforge.net/";>fpsstats</a></td>
<td>
A J2EE application that analyzes logs from many popular first shooter
games.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/turbine/fulcrum/";>Fulcrum</a></td>
<td>
A services framework that was decoupled from Turbine.
</td>
</tr>
<tr>
<td><a href="http://modules.geotools.org/";>GeoTools2</a></td>
<td>
Open Source GIS Toolkit project.
</td>
</tr>
<tr>
<td><a href="http://gsbase.sourceforge.net/";>gsbase</a></td>
<td>
A collection of java utility classes
</td>
</tr>
<tr>
<td><a href="http://jaad.sourceforge.net";>JAAD</a></td>
<td>
JAVA API for TIBCO/ActiveDatabase.
</td>
</tr>
<tr>
<td><a href="http://www.javablogs.com/";>Java.Blogs</a></td>
<td>
A portal of Java Web Logs
</td>
</tr>
<tr>
<td><a href="http://jaimbot.sourceforge.net";>JAIMBot (Java AIM
Bot)</a></td>
<td>
A modular architecture for providing services through an AIM client
</td>
</tr>
<tr>
<td><a href="http://jaxen.org";>Jaxen</a></td>
<td>
Universal Java XPath Engine.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/jelly/";>Jelly</a></td>
<td>
An XML based scripting and processing engine.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/jetspeed/";>Jetspeed</a></td>
<td>
Portal Framework.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/jexl/";>Jexl</a></td>
<td>
Jexl is an implementation of the JSTL Expression Language with
extensions.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/sandbox/jrcs/";>JRCS</a></td>
<td>
JRCS is a library for parsing and manipulation of RCS archive
files like the ones produced by the RCS (Revision Control
System) itself and by CVS (Concurrent Version System).
</td>
</tr>
<tr>
<td><a href="http://jsmime.sf.net/";>JSMIME</a></td>
<td>
JSMIME is a Java library to sign and/or encrypt E-Mails using the
SMIME standard using many different algorithms and key strengths.
</td>
</tr>
<tr>
<td><a href="http://junitpp.sf.net/";>JUNITPP</a></td>
<td>
This extension to the JUNIT framework allows a test data repository
and load/stress test from the command line.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/jxpath/";>JXPath</a></td>
<td>
A simple interpreter of an expression language called XPath.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/commons/latka/";>Latka</a></td>
<td>
Latka is a functional (end to end) testing tool.
</td>
</tr>
<tr>
<td><a href="http://maven.apache.org/";>Maven</a></td>
<td>
The future of all projects!
</td>
</tr>
<tr>
<td><a href="http://messageforge.sourceforge.net";>MessageForge</a></td>
<td>
Comprehensive messaging framework for TIBCO/RV, XML, SOAP, and JMS.
</td>
</tr>
<tr>
<td><a
href="http://jakarta.apache.org/commons/sandbox/messenger/";>Messenger</a></td>
<td>
A JMS (Java Message Service) framework which makes it very easy to
use JMS in Web Service and Web Application environments.
</td>
</tr>
<tr>
<td><a href="http://boss.bekk.no/boss/middlegen/";>Middlegen</a></td>
<td>
Database driven code generator.
Turns your database into EJBs and JDOs with the help of JDBC,
XDoclet and Velocity.
</td>
</tr>
<tr>
<td><a
href="http://millionenklick.sourceforge.net/intro.html";>Millionenklicker</a></td>
<td>
Millionenklick originally is a free game run by web.de at the URL
<a href="http://millionenklick.web.de";>http://millionenklick.web.de</a>,
where you can win up to one millionen euro daily - for free.
MillionenKlicker is a little program
fills in the online forms automagically and plays the game daily.
</td>
</tr>
<tr>
<td><a href="http://projects.walding.com/montage/";>Montage</a></td>
<td>
A Java Servlet Web Photoalbum with rich web-startable client (and
standard web interface).
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/ojb/";>ObjectBridge</a></td>
<td>
Persistence Layer.
</td>
</tr>
<tr>
<td><a href="http://openjms.sourceforge.net";>OpenJMS</a></td>
<td>
OpenJMS is an open source implementation of Sun Microsystems's
Java Message Service API 1.0.2 Specification
</td>
</tr>
<tr>
<td><a href="http://patterntesting.sf.net/";>PatternTesting</a></td>
<td>
A testing framework that allows to automatically verify that
Architecture/Design/Best practices recommendations are implemented
correctly in the code.
</td>
</tr>
<tr>
<td><a href="http://pmd.sf.net/";>PMD</a></td>
<td>
PMD - a static code analyzer. Finds unused variables and whatnot.
</td>
</tr>
<tr>
<td><a href="http://quilt.sourceforge.net/";>Quilt</a></td>
<td>
Test coverage tool.
</td>
</tr>
<tr>
<td><a href="http://raccoon.sf.net/";>Raccoon</a></td>
<td>
Framework to omplement TIBCO products in order to help us, the
people on the ground to use TIBCO at it's best and make life easy
for us.
</td>
</tr>
<tr>
<td><a href="http://rvtest.sourceforge.net";>RVTEST</a></td>
<td>
An extension to JUnit that allows for server, integration,
and load testing of TIBCO Rendezvous based applications.
</td>
</tr>
<tr>
<td><a href="http://scope.sourceforge.net";>Scope</a></td>
<td>
Scope is a framework built around an extensible implementation of the
Hierarchical Model-View-Controller (HMVC) pattern similar to the pattern
described in HMVC: The layered pattern for developing strong client
tiers.
</td>
</tr>
<tr>
<td><a href="http://www.softcon-itec.de/maven/sctree/";>ScTree</a></td>
<td>
An explorer-like tree control that can be embedded in
every HTML page. It receives its content from a simple XML
data source and transforms it into a functional HTML
control.
</td>
</tr>
<tr>
<td><a
href="http://www.softcon-itec.de/maven/scwebconf/";>ScWebconf</a></td>
<td>
A Configuration Managment Application for complex products
and services. It uses a pluggable rule engine that allows
for a more natural expression of business rules with
regards to business objects.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/turbine/stratum/";>Stratum</a></td>
<td>
A collection of reusable components from the Turbine projects.
</td>
</tr>
<tr>
<td><a href="http://tambora.zenplex.org/";>Tambora</a></td>
<td>
B2B application for the printing and publishing industry.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/turbine/torque/";>Torque</a></td>
<td>
A object-relational mapping tool that was decoupled from Turbine.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/turbine/";>Turbine</a></td>
<td>
A collection of projects dedicated to the development of web
applications using a model-view-controller model.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/turbine/turbine-2/";>Turbine
2</a></td>
<td>
Version 2 of the Turbine model-view-controller framework.
</td>
</tr>
<tr>
<td><a href="http://jakarta.apache.org/turbine/turbine-3/";>Turbine
3</a></td>
<td>
Version 3 of the Turbine model-view-controller framework.
</td>
</tr>
<tr>
<td><a href="http://xml.apache.org/xmlrpc/";>XMLRPC</a></td>
<td>
Java XMLRPC implementation.
</td>
</tr>
<tr>
<td><a href="http://mule.sourceforge.net/index.html";>Mule</a></td>
<td>
Mule is a simple yet robust and highly scalable broker
and services framework. It is designed as a light-weight,
event-driven component technology that handles
communication with disparate systems transparently
providing a simple component interface.
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
