You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by sm...@apache.org on 2003/02/26 11:08:43 UTC
cvs commit: jakarta-turbine-maven/xdocs glossary.xml
smor 2003/02/26 02:08:43
Modified: xdocs glossary.xml
Log:
Added some terms to the glossary
Revision Changes Path
1.2 +83 -1 jakarta-turbine-maven/xdocs/glossary.xml
Index: glossary.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/glossary.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- glossary.xml 21 Mar 2002 19:15:03 -0000 1.1
+++ glossary.xml 26 Feb 2003 10:08:43 -0000 1.2
@@ -1,13 +1,95 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<author email="jason@zenplex.com">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. Right now, the
+ only artifact type that a project can use is JARs. This should
+ change soon to include others (DTD, XSD, EJBs, etc).
+ </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>