svn commit: r638149 - /labs/droids/trunk/src/documentation/content/xdocs/default.xml

[th...@apache.org]

Author: thorsten
Date: Mon Mar 17 17:08:29 2008
New Revision: 638149

URL: http://svn.apache.org/viewvc?rev=638149&view=rev
Log:
Adding more information how to use the crawler from java.

Modified:
    labs/droids/trunk/src/documentation/content/xdocs/default.xml

Modified: labs/droids/trunk/src/documentation/content/xdocs/default.xml
URL: http://svn.apache.org/viewvc/labs/droids/trunk/src/documentation/content/xdocs/default.xml?rev=638149&r1=638148&r2=638149&view=diff
==============================================================================
--- labs/droids/trunk/src/documentation/content/xdocs/default.xml (original)
+++ labs/droids/trunk/src/documentation/content/xdocs/default.xml Mon Mar 17 17:08:29 2008
@@ -26,9 +26,9 @@
       <note>Please note that we do not crawl yet images, css and scripts linked in the pages,
         but this feature is on top of the TODO list (right next of the creation of a sample
         droid). We will try to implement it ASAP.</note>
-      <p>Remember the build.properties from the build process? This file controlls the 
-        behaviour of the default crawler. This properties can be overriden via custom
-        calls of the different methods in your custom java code.</p>
+      <p>Remember the build.properties from the build process? This file controlls the
+        behaviour of the default crawler. This properties can be overriden via custom calls
+        of the different methods in your custom java code.</p>
       <section>
         <title>Crawling</title>
         <p>If you have set the property "droids.initial.url" to your initial url and edited
@@ -45,11 +45,11 @@
   `-- search.html</source>
       </section>
       <section>
-          <title>Ant target</title>
-          <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.">
+        <title>Ant target</title>
+        <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">
@@ -60,8 +60,23 @@
     </classpath>
   </java>
 </target>]]>
-          </source>
-        </section>
+        </source>
+      </section>
+      <section>
+        <title>Java class</title>
+        <p>You can directly use the class
+          <code>org.apache.droids.Cli</code> by calling the
+          <code>main</code> method. There are two input parameters that you can use. </p>
+        <ol>
+          <li>The droid name is obligatory. In the default configuration that is
+            <code>default</code> </li>
+          <li>The second one is the location of the spring configuration you want to use. In
+            the default configuration that is
+            <code>classpath:/org/apache/droids/droids-core-context.xml</code>.
+            This parameter is not obligatory. and if it is not provided we fall back to the
+            above location.</li>
+        </ol>
+      </section>
     </section>
   </body>
 </document>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@labs.apache.org
For additional commands, e-mail: commits-help@labs.apache.org