You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by le...@apache.org on 2004/07/24 16:31:01 UTC
cvs commit: jakarta-commons/attributes/site/xdocs maven_demo.xml
leosutic 2004/07/24 07:31:01
Modified: attributes/site/xdocs maven_demo.xml
Log:
Completed the demo.
Revision Changes Path
1.2 +80 -3 jakarta-commons/attributes/site/xdocs/maven_demo.xml
Index: maven_demo.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/attributes/site/xdocs/maven_demo.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- maven_demo.xml 6 Jul 2004 20:43:00 -0000 1.1
+++ maven_demo.xml 24 Jul 2004 14:31:01 -0000 1.2
@@ -30,17 +30,94 @@
Maven. Don't worry about 90% here seemingly being pure unexplainable
magic - the purpose of this part of the tutorial is to show you
what steps you must do to make the Commons Attributes package work.
- In the walkthrough we'll focus more on just what happens, and how
+ In the reference we'll focus more on just what happens, and how
the all features work.
</p>
</section>
- <section name="Under Construction">
+ <section name="The Demo Files">
<p>
- Working on it... /LS
+ All files required for this demo can be found in <a href="maven_demo.zip">maven_demo.zip</a>.
</p>
+ </section>
+
+ <section name="Project Setup">
+
+ <p>
+ In order to get attributes working in your project you need to do three things:
+ (1) declare dependencies, (2) install the commons-attributes plugin and (3) set project
+ properties that will enable the plugin for your project.
+ </p>
+
+ <subsection name="Declaring Dependencies">
+ <p>
+ Dependencies are declared as you would expect in your project.xml:
+ </p>
+ <source><![CDATA[<dependency>
+ <id>commons-attributes</id>
+ <artifactId>commons-attributes-api</artifactId>
+ <version>2.1</version>
+</dependency>
+
+<dependency>
+ <id>commons-attributes</id>
+ <artifactId>commons-attributes-compiler</artifactId>
+ <version>2.1</version>
+</dependency>]]></source>
+ </subsection>
+
+ <subsection name="Installing the Plugin">
+ <p>
+ You can install the plugin by checking out the sources and doing:
+ </p>
+
+ <source><![CDATA[$ maven install
+$ maven install-plugin]]></source>
+
+ <p>
+ Alternatively, you can download the plugin and put it in your Maven
+ plugin directory.
+ </p>
+ </subsection>
+
+ <subsection name="Project Properties">
+
+ <p>Since Maven will unconditionally apply all plugins to every project being compiled
+ it is neccessary to explicitly enable the attribute compiler and/or indexer. This
+ is simply to keep them from being run on projects that do not want anything to do
+ with Commons-Attributes. The compiler and/or indexer are enabled by two project
+ properties that you can set in your project.properties file or in your maven.xml
+ file:
+ </p>
+
+ <source><![CDATA[######################################################################
+# Commons-Attributes
+######################################################################
+org.apache.commons.attributes.enable=true
+org.apache.commons.attributes.index.enable=true]]></source>
+
+ <p>
+ The first property will enable the attribute precompilation step. The second will
+ enable the attribute indexing step that takes place after the jar:jar target.
+ Both properties can be set independently of each other, although it makes little
+ sense to enable indexing if compilation isn't enables as well.
+ </p>
+ </subsection>
+
</section>
+
+ <section name="Running the Demo">
+
+ <p>
+ You should be able to unzip the demo files, cd into the directory and execute
+ "maven run", like this:
+ </p>
+
+ <source><![CDATA[$ unzip maven_demo.zip
+$ cd maven_demo
+$ maven run]]></source>
+ </section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org