You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@labs.apache.org by th...@apache.org on 2008/02/22 14:41:28 UTC
svn commit: r630204 -
/labs/droids/trunk/src/documentation/content/xdocs/sample.xml
Author: thorsten
Date: Fri Feb 22 05:41:24 2008
New Revision: 630204
URL: http://svn.apache.org/viewvc?rev=630204&view=rev
Log:
Adding information how to use the droids target in your project.
Modified:
labs/droids/trunk/src/documentation/content/xdocs/sample.xml
Modified: labs/droids/trunk/src/documentation/content/xdocs/sample.xml
URL: http://svn.apache.org/viewvc/labs/droids/trunk/src/documentation/content/xdocs/sample.xml?rev=630204&r1=630203&r2=630204&view=diff
==============================================================================
--- labs/droids/trunk/src/documentation/content/xdocs/sample.xml (original)
+++ labs/droids/trunk/src/documentation/content/xdocs/sample.xml Fri Feb 22 05:41:24 2008
@@ -18,7 +18,7 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
- <title>How to use Apache Droids in your spring based project</title>
+ <title>How to build and use Apache Droids?</title>
</header>
<body>
<section id="Download">
@@ -32,7 +32,7 @@
<p>Before building droids, create a file called build.properties to customize your Droid.
All properties that you can override can be found in the file default.properties.</p>
<p>The normal case is to implement the following properties with your custom values:</p>
- <source># The initial url to crawl (is likely the only property you do not want from default)
+ <source><![CDATA[# The initial url to crawl (is likely the only property you do not want from default)
droids.initial.url=http://target-x.de/about.html
# The droid you want to use
@@ -42,16 +42,16 @@
droids.filter.regex=${basedir}/regex-urlfilter.txt
# the root output dir for saving a crawl
-droids.handler.save.dir=${basedir}/export/</source>
+droids.handler.save.dir=${basedir}/export/]]></source>
<p>
<strong>After</strong> you create the above file you can go ahead and build droids
like follows. The command will first download all libaries that we need with the help
of Apache Ivy and then generate a jar.</p>
- <source>ant ivy.resolve droids.jar
+ <source><![CDATA[ant ivy.resolve droids.jar
...
[jar] Building jar: /home/thorsten/src/testing/droids/build/droids-initial.jar
BUILD SUCCESSFUL
-Total time: 22 seconds</source>
+Total time: 22 seconds]]></source>
</section>
<section id="BuildClean">
<title>Build afer an update</title>
@@ -68,6 +68,20 @@
regex file "droids.filter.regex" to exclude/include follow up links, the default
Droid will save the crawl to "droids.filter.regex" after you invoke:</p>
<source>ant droids.crawl</source>
+ <p>To use this target in your ant based application you can add the following snippet to
+ your build file and do not forget to implemented the
+ <strong>PROPERTIES</strong> such as e.g. droids.name!</p>
+ <source><![CDATA[<target name="droids.crawl" description="--> Will invoke the crawling.">
+ <java classname="org.apache.droids.Cli" fork="true" dir="${build.dir}"
+ maxmemory="${droids.maxmemory}" failonerror="true"
+ resultproperty="buildResult">
+ <arg value="${droids.name}"/>
+ <arg value="${droids.spring.context}"/>
+ <classpath>
+ <path refid="droids.classpath"/>
+ </classpath>
+ </java>
+</target>]]></source>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@labs.apache.org
For additional commands, e-mail: commits-help@labs.apache.org