You are viewing a plain text version of this content. The canonical link for it is here.
Posted to droids-commits@incubator.apache.org by to...@apache.org on 2012/09/07 15:08:35 UTC

svn commit: r1382057 - in /incubator/droids/trunk/src/site: apt/getting-started.apt apt/news.apt site.xml

Author: tobr
Date: Fri Sep  7 15:08:34 2012
New Revision: 1382057

URL: http://svn.apache.org/viewvc?rev=1382057&view=rev
Log:
updated site with examples

Modified:
    incubator/droids/trunk/src/site/apt/getting-started.apt
    incubator/droids/trunk/src/site/apt/news.apt
    incubator/droids/trunk/src/site/site.xml

Modified: incubator/droids/trunk/src/site/apt/getting-started.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/getting-started.apt?rev=1382057&r1=1382056&r2=1382057&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/getting-started.apt (original)
+++ incubator/droids/trunk/src/site/apt/getting-started.apt Fri Sep  7 15:08:34 2012
@@ -21,5 +21,36 @@
             ------
              DD.MM.YYYY
              
-Examples
+Getting Started
 
+  Here is an example to create a simple droid and crawl through some local files
+
++-------------------------------  
+    // first create a task queue, to store the tasks
+    Queue<FileTask> queue = new LinkedList<FileTask>();
+    // create a taskmaster, to control the tasks in the queue
+    TaskMaster<FileTask> taskMaster = new SequentialTaskMaster<FileTask>();
+    // we will use a predefined droid, that traverses through the local file system
+    SimpleWalkingDroid droid = new SimpleWalkingDroid(queue, taskMaster);
+    // now, we define the start point for the crawl
+    Collection<File> initialFiles = new LinkedList<File>();
+    initialFiles.add(new File("/home/user/Downloads"));
+    droid.setInitialFiles(initialFiles);
+    
+    try {
+      // initialize
+      droid.init();
+      // and start the droid
+      droid.start();
+      // this blocks the current thread until all other tasks have completed
+      droid.getTaskMaster().awaitTermination(0, TimeUnit.MILLISECONDS);
+    } catch (Exception e) {
+      e.printStackTrace();
+    }
++---------------------------------
+
+More Examples
+
+  More examples are available in the test cases. 
+  Here you can see the way to work with Droids. 
+  Our test cases demonstrate best practice code and if you want to develop your own droids you should look at them.
\ No newline at end of file

Modified: incubator/droids/trunk/src/site/apt/news.apt
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/apt/news.apt?rev=1382057&r1=1382056&r2=1382057&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/apt/news.apt (original)
+++ incubator/droids/trunk/src/site/apt/news.apt Fri Sep  7 15:08:34 2012
@@ -23,6 +23,12 @@
 
 News
 
+* 11 August 2012 - Release 0.2-incubating
+
+  We are proud to announce the second release of Apache Droids Incubating, version 0.2-incubating. 
+  Download is available through the {{{./download.html}download}} page or Maven central. 
+
+
 * 03 November 2011 - First Release
 
   The first release of Apache Droids Incubating has been made, version 0.1.0-incubating. You can get it from the {{{./download.html}download}} page. The binary artifacts are available on Maven Central for ease of use.

Modified: incubator/droids/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/droids/trunk/src/site/site.xml?rev=1382057&r1=1382056&r2=1382057&view=diff
==============================================================================
--- incubator/droids/trunk/src/site/site.xml (original)
+++ incubator/droids/trunk/src/site/site.xml Fri Sep  7 15:08:34 2012
@@ -13,7 +13,7 @@
 	<skin>
 		<groupId>org.apache.maven.skins</groupId>
 		<artifactId>maven-fluido-skin</artifactId>
-		<version>1.2.1</version>
+		<version>1.3.0</version>
 	</skin>
 	<bannerLeft>
 		<name>Apache Droids</name>
@@ -27,7 +27,7 @@
 	</bannerRight>
 	<body>
 		<links>
-			<item name="Apache" href="http://apache.org/" />
+			<item name="Apache" href="http://www.apache.org/" />
       <item name="Apache Incubator" href="https://incubator.apache.org/" />
 		</links>
 		<menu name="Apache Droids">