commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nutty...@apache.org
Subject svn commit: r483142 - in /jakarta/commons/sandbox/pipeline/trunk/src/site: apt/usage.apt site.xml
Date Wed, 06 Dec 2006 16:44:40 GMT
Author: nuttycom
Date: Wed Dec  6 08:44:39 2006
New Revision: 483142

URL: http://svn.apache.org/viewvc?view=rev&rev=483142
Log:
Added simple usage docs on how to find the artifacts.

Added:
    jakarta/commons/sandbox/pipeline/trunk/src/site/apt/usage.apt
Modified:
    jakarta/commons/sandbox/pipeline/trunk/src/site/site.xml

Added: jakarta/commons/sandbox/pipeline/trunk/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/jakarta/commons/sandbox/pipeline/trunk/src/site/apt/usage.apt?view=auto&rev=483142
==============================================================================
--- jakarta/commons/sandbox/pipeline/trunk/src/site/apt/usage.apt (added)
+++ jakarta/commons/sandbox/pipeline/trunk/src/site/apt/usage.apt Wed Dec  6 08:44:39 2006
@@ -0,0 +1,42 @@
+                    ----------------------
+                    Using Commons-Pipeline
+                    ----------------------
+
+Obtaining Commons-Pipeline
+
+  If you are using Maven (version 2.0 and above) the easiest way to 
+incorporate Commons-Pipeline into your project is to add the following 
+entries in the appropriate sections of your project's pom.xml file: 
+
++---+
+  <repositories>
+    <repository>
+      <id>apache.snapshots</id>
+      <name>Snapshot Repository</name>
+      <url>http://cvs.apache.org/maven-snapshot-repository</url>
+    </repository>
+  </repositories>
+  <dependencies>
+    <dependency>
+      <groupId>org.apache.commons</groupId>
+      <artifactId>commons-pipeline</artifactId>
+      <version>1.0-SNAPSHOT</version>
+    </dependency>
+  </dependencies>
++---+
+
+  If you are not using Maven for your project, nightly builds are available
+from {{http://people.apache.org/builds/jakarta-commons/nightly/commons-pipeline/}}.
+
+Usage
+
+  Ordinarily, a processing pipeline will be embedded in an application; however,
+it is also possible to use a simple XML file to configure a pipeline instance
+that can be run directly from the command line with the syntax:
+
+---
+java org.apache.commons.pipeline.config.DigesterPipelineFactory my_pipeline_conf.xml 
+---
+
+  See {{{config_digester.html}Configuration Using Digester}} for how to set up a 
+pipeline configuration file. 

Modified: jakarta/commons/sandbox/pipeline/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/jakarta/commons/sandbox/pipeline/trunk/src/site/site.xml?view=diff&rev=483142&r1=483141&r2=483142
==============================================================================
--- jakarta/commons/sandbox/pipeline/trunk/src/site/site.xml (original)
+++ jakarta/commons/sandbox/pipeline/trunk/src/site/site.xml Wed Dec  6 08:44:39 2006
@@ -8,6 +8,7 @@
   <body>
     <menu name="Commons Pipeline">
       <item name="Overview" href="index.html"/>      
+      <item name="Usage" href="usage.html"/>      
       <item name="Configuration using Digester" href="config_digester.html"/>     

       <item name="FAQ" href="faq.html"/>
     </menu>



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message