Added: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/changes.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins-sandbox/trunk/modello/xdocs/changes.xml?view=auto&rev=493630
==============================================================================
--- maven/maven-1/plugins-sandbox/trunk/modello/xdocs/changes.xml (added)
+++ maven/maven-1/plugins-sandbox/trunk/modello/xdocs/changes.xml Sat Jan 6
17:46:26 2007
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+/*
+ * Copyright 2001-2007 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ -->
+<document>
+ <properties>
+ <title>Changes</title>
+ <author email="[EMAIL PROTECTED]">Arnaud Heritier</author>
+ </properties>
+ <body>
+ <release version="1.0-SNAPSHOT" date="In SVN">
+ <action dev="aheritier" type="add">New site report
(maven-modello-plugin) to generate the model documentation and the XML
schema.</action>
+ <action dev="aheritier" type="add">New goal modello:xsd</action>
+ <action dev="aheritier" type="add">New goals modello:jpox and
modello:jpox-metadata-class</action>
+ <action dev="aheritier" type="add">New goals modello:jdom, and
modello:jdom-writer</action>
+ <action dev="aheritier" type="add">New goals modello:dom4j,
modello:dom4j-reader and modello:dom4j-writer</action>
+ <action dev="aheritier" type="add">New goals modello:stax,
modello:stax-reader and modello:stax-writer</action>
+ <action dev="aheritier" type="add">Automatically verify required
properties.</action>
+ <action dev="aheritier" type="add">Add a test to validate generations
from modello plugins.</action>
+ <action dev="aheritier" type="add">New property maven.modello.plugins to
select plugins to call for the goal modello:modello</action>
+ <action dev="aheritier" type="update">The property
maven.modello.targetDirectory is replaced by
maven.modello.java.targetDirectory,maven.modello.xsd.targetDirectory, and
maven.modello.xdoc.targetDirectory</action>
+ <action dev="aheritier" type="update">The plugin is now based on modello
libraries 1.0-alpha-14.</action>
+ <action dev="aheritier" type="add">Add plugin documentation and refactor
web site.</action>
+ </release>
+ <release version="1.0-alpha-2" date="2005-09-07">
+ <action dev="brett" type="fix">Fix web site address</action>
+ </release>
+ <release version="1.0-alpha-1" date="2005-06-02">
+ <action dev="trygvis" type="add">New goals modello:jpox-store and
modello:jpox-jdo-mapping</action>
+ <action dev="trygvis" type="add">New goal modello:xdoc</action>
+ <action dev="trygvis" type="add">New goals modello:xpp3-reader and
modello:xpp3-writer</action>
+ <action dev="trygvis" type="add">New property
maven.modello.targetDirectory</action>
+ <action dev="trygvis" type="add">New property
maven.modello.version</action>
+ <action dev="trygvis" type="add">New property
maven.modello.packageWithVersion</action>
+ <action dev="trygvis" type="add">New property
maven.modello.model</action>
+ <action dev="brett" type="add">New goal modello:xpp3</action>
+ <action dev="brett" type="add">New goal modello:java</action>
+ <action dev="brett" type="add">New goals modello and
modello:modello</action>
+ <action dev="brett" type="add">New jelly tag modello:generate</action>
+ <action dev="brett" type="add">Initiate the plugin based on modello
libraries 1.0-alpha-2</action>
+ </release>
+ </body>
+</document>
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/changes.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/changes.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/goals.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins-sandbox/trunk/modello/xdocs/goals.xml?view=auto&rev=493630
==============================================================================
--- maven/maven-1/plugins-sandbox/trunk/modello/xdocs/goals.xml (added)
+++ maven/maven-1/plugins-sandbox/trunk/modello/xdocs/goals.xml Sat Jan 6
17:46:26 2007
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <title>Goals</title>
+ <author email="[EMAIL PROTECTED]">Arnaud Heritier</author>
+ </properties>
+ <body>
+ <section name="Goals">
+ <table>
+ <thead>
+ <tr>
+ <th>Goal</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><a name="modello"></a>modello</td>
+ <td>Default goal for the plugin. It calls
<code>modello:modello</code>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:modello"></a>modello:modello</td>
+ <td>Code generation based on the property
<code>maven.modello.plugins</code>. Each plugin listed in this property is
called as a goal <code>modello:<i>pluginName</i></code>. If
<code>maven.modello.plugins=java,stax,jpox</code> a call to
<code>modello(:modello)</code> will call goals <code>modello:java,
modello:stax, modello:jpox</code>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:java"></a>modello:java</td>
+ <td>Generates Java Pojos of the DataModel in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>.</td>
+ </tr>
+ <tr>
+ <th colspan="2">Java - XML Mappings</th>
+ </tr>
+ <tr>
+ <td><a name="modello:dom4j"></a>modello:dom4j</td>
+ <td>Generates classes in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to read/write the model from/into a xml file using <a
href="http://www.dom4j.org/"; target="_blank">Dom4j</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:dom4j-reader"></a>modello:dom4j-reader</td>
+ <td>Generates the class in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to read the model from a xml file using <a href="http://www.dom4j.org/";
target="_blank">Dom4j</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:dom4j-writer"></a>modello:dom4j-writer</td>
+ <td>Generates the class in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to write the model into a xml file using <a href="http://www.dom4j.org/";
target="_blank">Dom4j</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:jdom"></a>modello:jdom</td>
+ <td>Generates classes in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to write the model into a xml file using <a href="http://www.jdom.org/";
target="_blank">JDom</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:jdom-writer"></a>modello:jdom-writer</td>
+ <td>Generates classes in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to write the model into a xml file using <a href="http://www.jdom.org/";
target="_blank">JDom</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:stax"></a>modello:stax</td>
+ <td>Generates classes in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to read/write the model from/into a xml file using <a
href="http://stax.codehaus.org/"; target="_blank">STAX RI</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:stax-reader"></a>modello:stax-reader</td>
+ <td>Generates the class in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to read the model from a xml file using <a href="http://stax.codehaus.org/";
target="_blank">STAX RI</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:stax-writer"></a>modello:stax-writer</td>
+ <td>Generates the class in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to write the model into a xml file using <a href="http://stax.codehaus.org/";
target="_blank">STAX RI</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:xpp3"></a>modello:xpp3</td>
+ <td>Generates classes in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to read/write the model from/to a xml file using <a
href="http://www.extreme.indiana.edu/xgws/xsoap/xpp/";
target="_blank">Xpp3</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:xpp3-reader"></a>modello:xpp3-reader</td>
+ <td>Generates the class in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to read the model from a xml file using <a
href="http://www.extreme.indiana.edu/xgws/xsoap/xpp/";
target="_blank">Xpp3</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:xpp3-writer"></a>modello:xpp3-writer</td>
+ <td>Generates the class in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to write the model into a xml file using <a
href="http://www.extreme.indiana.edu/xgws/xsoap/xpp/";
target="_blank">Xpp3</a>.</td>
+ </tr>
+ <tr>
+ <th colspan="2">Java - Database Storage</th>
+ </tr>
+ <tr>
+ <td><a name="modello:jpox"></a>modello:jpox</td>
+ <td>Generates classes in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
to read/store the model in a database using <a href="http://www.jpox.org/";
target="_blank">JPox</a>.</td>
+ </tr>
+ <tr>
+ <td><a
name="modello:jpox-jdo-mapping"></a>modello:jpox-jdo-mapping</td>
+ <td>Generates in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
the JOD mapping for <a href="http://www.jpox.org/"; target="_blank">JPox</a>
(<code>package.jdo</code>).</td>
+ </tr>
+ <tr>
+ <td><a
name="modello:jpox-metadata-class"></a>modello:jpox-metadata-class</td>
+ <td>Generates in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
MetaData class for <a href="http://www.jpox.org/"; target="_blank">JPox</a>.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:jpox-store"></a>modello:jpox-store</td>
+ <td>Generates in the directory <a
href="properties.html"><code>${maven.modello.java.targetDirectory}</code></a>
the <a href="http://www.jpox.org/"; target="_blank">JPox</a> code to do the
persistence of the model in a DB.</td>
+ </tr>
+ <tr>
+ <th colspan="2">Documentation and validation</th>
+ </tr>
+ <tr>
+ <td><a name="modello:xsd"></a>modello:xsd</td>
+ <td>Generates an XML Schema in the directory <a
href="properties.html"><code>${maven.modello.xsd.targetDirectory}</code></a>
for the xml file used to store the model.</td>
+ </tr>
+ <tr>
+ <td><a name="modello:xdoc"></a>modello:xdoc</td>
+ <td>Generates a xdoc file in the directory <a
href="properties.html"><code>${maven.modello.xdoc.targetDirectory}</code></a>
to document the model.</td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/goals.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/goals.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/index.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins-sandbox/trunk/modello/xdocs/index.xml?view=auto&rev=493630
==============================================================================
--- maven/maven-1/plugins-sandbox/trunk/modello/xdocs/index.xml (added)
+++ maven/maven-1/plugins-sandbox/trunk/modello/xdocs/index.xml Sat Jan 6
17:46:26 2007
@@ -0,0 +1,73 @@
+<?xml version="1.0"?>
+<!--
+ /*
+ * Copyright 2001-2007 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+-->
+<document>
+ <properties>
+ <title>Overview</title>
+ <author email="[EMAIL PROTECTED]">Arnaud Heritier</author>
+ </properties>
+ <body>
+ <section name="Overview">
+ <subsection name="Modello">
+ <p><a href="http://modello.codehaus.org/"; target="_blank">Modello</a>
is a Data Model toolkit.</p>
+ <p>From a <a href="http://modello.codehaus.org/DataModel";
target="_blank">DataModel</a> defined in XML, Modello can generate any of the
following at compile time:</p>
+ <ul>
+ <li>Java Pojos of the <a
href="http://modello.codehaus.org/DataModel"; target="_blank">DataModel</a>.</li>
+ <li>Java Pojos to XML Writer. (provided via xpp3, stax, jdom or
dom4j)</li>
+ <li>XML to Java Pojos Reader. (provided via xpp3, stax or dom4j)</li>
+ <li>Java Model to JPOX Store.</li>
+ <li>Java Model to JPOX Mapping.</li>
+ <li>Xdoc documentation of the <a
href="http://modello.codehaus.org/DataModel"; target="_blank">DataModel</a>.</li>
+ <li>XML Schema to validate data.</li>
+ <li>and more in the future...</li>
+ </ul>
+ </subsection>
+ <subsection name="Maven 1 plugin for Modello">
+ <p>This plugin allows you to integrate modello services in your build
to automatically (or manually) generate the code and the documentation from the
DataModel.</p>
+ </subsection>
+ <subsection name="Others documents">
+ <table>
+ <tr>
+ <th>Document</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><a href="install.html">Installation</a></td>
+ <td>How to install this plugin?</td>
+ </tr>
+ <tr>
+ <td><a href="usage.html">Usage</a></td>
+ <td>How to use this plugin?</td>
+ </tr>
+ <tr>
+ <td><a href="goals.html">Goals</a></td>
+ <td>Goals documentation.</td>
+ </tr>
+ <tr>
+ <td><a href="properties.html">Properties</a></td>
+ <td>Properties documentation.</td>
+ </tr>
+ <tr>
+ <td><a href="changes-report.html">Changes</a></td>
+ <td>Changes in each release of this plugin.</td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/index.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/install.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins-sandbox/trunk/modello/xdocs/install.xml?view=auto&rev=493630
==============================================================================
--- maven/maven-1/plugins-sandbox/trunk/modello/xdocs/install.xml (added)
+++ maven/maven-1/plugins-sandbox/trunk/modello/xdocs/install.xml Sat Jan 6
17:46:26 2007
@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+<!--
+ /*
+ * Copyright 2001-2007 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+-->
+<document>
+ <properties>
+ <title>Installation</title>
+ <author email="[EMAIL PROTECTED]">Arnaud Heritier</author>
+ </properties>
+ <body>
+
+ <section name="How to install the plugin ?">
+ <p>This plugin isn't bundled in the maven 1 distribution thus you have
deploy it in your local installation of maven 1, or you have to define it in
your project dependencies (RECOMMENDED).</p>
+ <p>We suppose that <b><i>CURRENT_VERSION</i></b> is the version of the
plugin you want to use. The <a href="changes-report.html">changes</a> report
gives you the list of versions actually available.</p>
+ <p>If you want to use a SNAPSHOT of this plugin, you'll certainly have
to add the following remote repositories in your settings (property
<code>maven.repo.remote</code>) :</p>
+ <ul>
+ <li><code>http://snapshots.dist.codehaus.org/modello/</code> : To
acquire snapshots of modello.</li>
+ <li><code>http://people.apache.org/repo/m1-snapshot-repository/</code>
: To acquire snapshots of the modello plugin for m1.</li>
+ </ul>
+
+ <subsection name="In your maven installation">
+ <p>To install it locally, you just have to launch this command :</p>
+ <source>maven plugin:download -DgroupId=maven
-DartifactId=maven-modello-plugin -Dversion=CURRENT_VERSION</source>
+ <p>You have to do it on all installations of maven 1 which will be
used to build your project.</p>
+ </subsection>
+ <subsection name="In a given project">
+ <p>You can easily ask to maven to download/install/use this plugin in
your project. You just have to add in your project POM a dependency to this
plugin :</p>
+ <source><![CDATA[
+<dependency>
+ <groupId>maven</groupId>
+ <artifactId>maven-modello-plugin</artifactId>
+ <version>CURRENT_VERSION</version>
+ <type>plugin</type>
+</dependency>]]></source>
+ </subsection>
+ </section>
+
+ </body>
+</document>
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/install.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/install.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/navigation.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins-sandbox/trunk/modello/xdocs/navigation.xml?view=diff&rev=493630&r1=493629&r2=493630
==============================================================================
--- maven/maven-1/plugins-sandbox/trunk/modello/xdocs/navigation.xml (original)
+++ maven/maven-1/plugins-sandbox/trunk/modello/xdocs/navigation.xml Sat Jan 6
17:46:26 2007
@@ -27,6 +27,15 @@
<item name="Sandbox"
href="http://maven.apache.org/maven-1.x/plugins/sandbox/"/>
</breadcrumbs>
<links>
+ <item name="Modello" href="http://modello.codehaus.org/";
target="_blank"/>
</links>
+ <menu name="Maven Modello Plugin">
+ <item name="Overview" href="/index.html"/>
+ <item name="Installation" href="/install.html"/>
+ <item name="Usage" href="/usage.html"/>
+ <item name="Goals" href="/goals.html"/>
+ <item name="Properties" href="/properties.html"/>
+ <item name="Changes" href="/changes-report.html"/>
+ </menu>
</body>
</project>
Added: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/properties.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins-sandbox/trunk/modello/xdocs/properties.xml?view=auto&rev=493630
==============================================================================
--- maven/maven-1/plugins-sandbox/trunk/modello/xdocs/properties.xml (added)
+++ maven/maven-1/plugins-sandbox/trunk/modello/xdocs/properties.xml Sat Jan 6
17:46:26 2007
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+ <properties>
+ <title>Properties</title>
+ <author email="[EMAIL PROTECTED]">Arnaud Heritier</author>
+ </properties>
+ <body>
+ <section name="Maven Modello Plugin Settings">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>maven.modello.version</td>
+ <td>No</td>
+ <td>
+ <p>This property must be set to to tell to modello which version
of the model must be used.</p>
+ <p>Default value is <code>empty</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.modello.packageWithVersion</td>
+ <td>No</td>
+ <td>
+ <p>This property must be set to true or false to tell to modello
to generate a package name with the version of the model.</p>
+ <p>Default value is <code>empty</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.modello.package</td>
+ <td>Yes</td>
+ <td>
+ <p>Replaces the default package defined in the model.</p>
+ <p>Default value is <code>empty</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.modello.plugins</td>
+ <td>Yes</td>
+ <td>
+ <p>This is the list of modello plugins to use when the goal
<code>modello(:modello)</code> is used. Each plugin has it's own goal in this
plugin : <code>modello:java, modello:stax, modello:xpp3</code> (See the <a
href="goals.html">list of goals</a> to find all the possible values).</p>
+ <p>Default value is <code>java,xdoc</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.modello.xsd.targetDirectory</td>
+ <td>Yes</td>
+ <td>
+ <p>Directory in which is generated the xml schema to validate
instances of the model (goal <code>modello:xsd</code>).</p>
+ <p>Default value is <code>${maven.gen.docs}</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.modello.java.targetDirectory</td>
+ <td>Yes</td>
+ <td>
+ <p>Directory in which are generated java sources from modello
plugins : java, xpp3, ... .</p>
+ <p>Default value is
<code>${maven.build.dir}/generated-src/main/modello</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.modello.xdoc.targetDirectory</td>
+ <td>Yes</td>
+ <td>
+ <p>Directory in which is generated the xdoc to document the model
(goal <code>modello:xdoc</code>).</p>
+ <p>Default value is <code>${maven.gen.docs}</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.modello.model</td>
+ <td>Yes</td>
+ <td>
+ <p>The path to the modello model to use.</p>
+ <p>Default value is
<code>${basedir}/src/main/resources/model.mdo</code>.</p>
+ </td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/properties.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/properties.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/usage.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins-sandbox/trunk/modello/xdocs/usage.xml?view=auto&rev=493630
==============================================================================
--- maven/maven-1/plugins-sandbox/trunk/modello/xdocs/usage.xml (added)
+++ maven/maven-1/plugins-sandbox/trunk/modello/xdocs/usage.xml Sat Jan 6
17:46:26 2007
@@ -0,0 +1,57 @@
+<?xml version="1.0"?>
+<!--
+ /*
+ * Copyright 2001-2007 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+-->
+<document>
+ <properties>
+ <title>Usage</title>
+ <author email="[EMAIL PROTECTED]">Arnaud Heritier</author>
+ </properties>
+ <body>
+
+ <section name="How to use the plugin ?">
+ <subsection name="Prerequisites">
+ <ol>
+ <li>You have to <a href="http://modello.codehaus.org/DataModel";
target="_blank">define your own model</a> in your project in a file named
<code>${basedir}/src/main/resources/model.mdo</code> (property <a
href="properties.html"><code>maven.modello.model</code></a>). <b>NOTE :</b>
Actually the plugin allow to have only one model per project.</li>
+ <li>You have also to set the <a
href="properties.html">properties</a>
<code>maven.modello.packageWithVersion</code> and
<code>maven.modello.version</code>.</li>
+ </ol>
+ </subsection>
+ <subsection name="Manual usage">
+ <p>After having change your <a href="properties.html">properties</a>
to customize the behaviour of modello, you can call any <a
href="goals.html">goal</a> in this plugin. To have the full list of goals you
must call <code>maven -P modello</code>.</p>
+ </subsection>
+ <subsection name="Automated usage">
+ <p>You can automatically call modello in your build.</p>
+ <p>As a pregoal of <code>java:compile</code> to generate your code.
The modello goal uses the property <a
href="properties.html"><code>maven.modello.plugins</code></a> to know which
modello plugins it have to use.</p>
+ <source><![CDATA[
+<!-- Register Modello -->
+<preGoal name="java:compile">
+ <attainGoal name="modello"/>
+</preGoal>
+ ]]></source>
+ <p>As a report for the web site. It will automatically generate the
documentation and the xml schema for your model</p>
+ <source><![CDATA[
+<reports>
+ ...
+ <report>maven-modello-plugin</report>
+ ...
+</reports>
+ ]]></source>
+ </subsection>
+ </section>
+
+ </body>
+</document>
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/usage.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/maven-1/plugins-sandbox/trunk/modello/xdocs/usage.xml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
