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/09/04 13:22:47 UTC
svn commit: r691967 - in /labs/droids/trunk/src/documentation:
content/xdocs/images/droidsOverview.svg content/xdocs/index.xml
resources/dia/ resources/dia/droidsOverview.dia
Author: thorsten
Date: Thu Sep 4 04:22:46 2008
New Revision: 691967
URL: http://svn.apache.org/viewvc?rev=691967&view=rev
Log:
adding more documentation and some graphics to explain the architecture.
Added:
labs/droids/trunk/src/documentation/content/xdocs/images/droidsOverview.svg (with props)
labs/droids/trunk/src/documentation/resources/dia/
labs/droids/trunk/src/documentation/resources/dia/droidsOverview.dia (with props)
Modified:
labs/droids/trunk/src/documentation/content/xdocs/index.xml
Added: labs/droids/trunk/src/documentation/content/xdocs/images/droidsOverview.svg
URL: http://svn.apache.org/viewvc/labs/droids/trunk/src/documentation/content/xdocs/images/droidsOverview.svg?rev=691967&view=auto
==============================================================================
--- labs/droids/trunk/src/documentation/content/xdocs/images/droidsOverview.svg (added)
+++ labs/droids/trunk/src/documentation/content/xdocs/images/droidsOverview.svg Thu Sep 4 04:22:46 2008
@@ -0,0 +1,323 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created by diasvg.py -->
+<svg
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:cc="http://creativecommons.org/ns#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ width="33.800cm"
+ height="12.250cm"
+ viewBox="1.050 -0.050 34.850 12.200"
+ id="svg2"
+ sodipodi:version="0.32"
+ inkscape:version="0.46"
+ sodipodi:docname="droidsOverview.svg"
+ inkscape:output_extension="org.inkscape.output.svg.inkscape">
+ <metadata
+ id="metadata69">
+ <rdf:RDF>
+ <cc:Work
+ rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type
+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <defs
+ id="defs67">
+ <inkscape:perspective
+ sodipodi:type="inkscape:persp3d"
+ inkscape:vp_x="0 : 217.02756 : 1"
+ inkscape:vp_y="0 : 1000 : 0"
+ inkscape:vp_z="1197.6378 : 217.02756 : 1"
+ inkscape:persp3d-origin="598.81891 : 144.68504 : 1"
+ id="perspective71" />
+ </defs>
+ <sodipodi:namedview
+ inkscape:window-height="949"
+ inkscape:window-width="1279"
+ inkscape:pageshadow="2"
+ inkscape:pageopacity="0.0"
+ guidetolerance="10.0"
+ gridtolerance="10.0"
+ objecttolerance="10.0"
+ borderopacity="1.0"
+ bordercolor="#666666"
+ pagecolor="#ffffff"
+ id="base"
+ showgrid="false"
+ inkscape:zoom="0.45172254"
+ inkscape:cx="729.78415"
+ inkscape:cy="217.02756"
+ inkscape:window-x="0"
+ inkscape:window-y="25"
+ inkscape:current-layer="svg2" />
+ <rect
+ x="1.100"
+ y="-0.000"
+ width="6.600"
+ height="3.800"
+ fill="#FFFFFF"
+ stroke="none"
+ stroke-width="0"
+ id="rect4" />
+ <rect
+ x="1.100"
+ y="-0.000"
+ width="6.600"
+ height="3.800"
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="rect6" />
+ <text
+ x="2.4702404"
+ y="2.25"
+ font-size="1.50"
+ font-style="normal"
+ font-weight="700"
+ id="text8"
+ style="font-size:1.5px;font-style:normal;font-weight:700;text-anchor:start;fill:#000000;font-family:sans">Core</text>
+ <rect
+ x="14.500"
+ y="0.100"
+ width="6.850"
+ height="3.750"
+ fill="#FFFFFF"
+ stroke="none"
+ stroke-width="0"
+ id="rect10" />
+ <rect
+ x="14.500"
+ y="0.100"
+ width="6.850"
+ height="3.750"
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="rect12" />
+ <text
+ x="15.693024"
+ y="1.9680001"
+ font-size="1.50"
+ font-style="normal"
+ font-weight="700"
+ id="text14"
+ style="font-size:1.5px;font-style:normal;font-weight:700;text-anchor:start;fill:#000000;font-family:sans">droid</text>
+ <line
+ x1="7.924"
+ y1="1.902"
+ x2="14.276"
+ y2="1.973"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="line16" />
+ <polyline
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ points="8.315,1.657 7.812,1.901 8.309,2.157 "
+ id="polyline18" />
+ <polyline
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ points="13.885,2.218 14.388,1.974 13.891,1.718 "
+ id="polyline20" />
+ <text
+ x="9.900"
+ y="1.400"
+ fill="#000000"
+ text-anchor="start"
+ font-size="0.80"
+ font-family="sans"
+ font-style="normal"
+ font-weight="400"
+ id="text22">
+invokes</text>
+ <text
+ x="10.000"
+ y="2.850"
+ fill="#000000"
+ text-anchor="start"
+ font-size="0.80"
+ font-family="sans"
+ font-style="normal"
+ font-weight="400"
+ id="text24">
+reports</text>
+ <text
+ x="14.972141"
+ y="3.3394177"
+ font-size="0.80"
+ font-style="normal"
+ font-weight="400"
+ id="text26"
+ style="font-size:0.80000001px;font-style:normal;font-weight:400;line-height:100%;text-anchor:start;fill:#000000;font-family:sans"
+ sodipodi:linespacing="100%">
+ <tspan
+ style="text-align:start;line-height:100%;writing-mode:lr-tb;text-anchor:start"
+ id="tspan2448">defaultCrawler</tspan>
+ </text>
+ <rect
+ x="28.100"
+ y="0.100"
+ width="6.700"
+ height="3.750"
+ fill="#FFFFFF"
+ stroke="none"
+ stroke-width="0"
+ id="rect28" />
+ <rect
+ x="28.100"
+ y="0.100"
+ width="6.700"
+ height="3.750"
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="rect30" />
+ <text
+ x="28.582569"
+ y="1.918"
+ font-size="1.50"
+ font-style="normal"
+ font-weight="700"
+ id="text32"
+ style="font-size:1.5px;font-style:normal;font-weight:700;text-anchor:start;fill:#000000;font-family:sans">worker</text>
+ <text
+ x="28.519075"
+ y="3.2218356"
+ font-size="0.80"
+ font-style="normal"
+ font-weight="400"
+ id="text34"
+ style="font-size:0.80000001px;font-style:normal;font-weight:400;text-anchor:start;fill:#000000;font-family:sans">defaultWorker</text>
+ <line
+ x1="21.574"
+ y1="1.975"
+ x2="27.876"
+ y2="1.975"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="line36" />
+ <polyline
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ points="21.962,1.725 21.462,1.975 21.962,2.225 "
+ id="polyline38" />
+ <polyline
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ points="27.488,2.225 27.988,1.975 27.488,1.725 "
+ id="polyline40" />
+ <text
+ x="23.541"
+ y="1.517"
+ fill="#000000"
+ text-anchor="start"
+ font-size="0.80"
+ font-family="sans"
+ font-style="normal"
+ font-weight="400"
+ id="text42">
+invokes</text>
+ <text
+ x="23.641"
+ y="2.967"
+ fill="#000000"
+ text-anchor="start"
+ font-size="0.80"
+ font-family="sans"
+ font-style="normal"
+ font-weight="400"
+ id="text44">
+reports</text>
+ <rect
+ x="14.050"
+ y="8.550"
+ width="7.800"
+ height="3.600"
+ fill="#FFFFFF"
+ stroke="none"
+ stroke-width="0"
+ id="rect46" />
+ <rect
+ x="14.050"
+ y="8.550"
+ width="7.800"
+ height="3.600"
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="rect48" />
+ <text
+ x="14.911987"
+ y="10.235329"
+ font-size="1.50"
+ font-style="normal"
+ font-weight="700"
+ id="text50"
+ style="font-size:1.5px;font-style:normal;font-weight:700;text-anchor:start;fill:#000000;font-family:sans">plugins</text>
+ <line
+ x1="31.450"
+ y1="3.850"
+ x2="22.035"
+ y2="10.225"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="line52" />
+ <polyline
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ points="22.217,9.800 21.943,10.287 22.497,10.214 "
+ id="polyline54" />
+ <text
+ x="25.000"
+ y="6.800"
+ fill="#000000"
+ text-anchor="start"
+ font-size="0.80"
+ font-family="sans"
+ font-style="normal"
+ font-weight="400"
+ id="text56">
+uses</text>
+ <text
+ x="14.306746"
+ y="11.743254"
+ font-size="0.80"
+ font-style="normal"
+ font-weight="400"
+ id="text58"
+ style="font-size:0.80000001px;font-style:normal;font-weight:400;text-anchor:start;fill:#000000;font-family:sans">Parser, Handler, ...</text>
+ <line
+ x1="14.050"
+ y1="10.350"
+ x2="4.585"
+ y2="3.926"
+ stroke="#000000"
+ stroke-width="0.100"
+ id="line60" />
+ <polyline
+ fill="none"
+ stroke="#000000"
+ stroke-width="0.100"
+ points="5.047,3.937 4.493,3.863 4.766,4.350 "
+ id="polyline62" />
+ <text
+ x="8.1000004"
+ y="6"
+ font-size="0.80"
+ font-style="normal"
+ font-weight="400"
+ id="text64"
+ style="font-size:0.80000001px;font-style:normal;font-weight:400;text-anchor:start;fill:#000000;font-family:sans">register with Factories</text>
+</svg>
Propchange: labs/droids/trunk/src/documentation/content/xdocs/images/droidsOverview.svg
------------------------------------------------------------------------------
svn:eol-style = native
Modified: labs/droids/trunk/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/labs/droids/trunk/src/documentation/content/xdocs/index.xml?rev=691967&r1=691966&r2=691967&view=diff
==============================================================================
--- labs/droids/trunk/src/documentation/content/xdocs/index.xml (original)
+++ labs/droids/trunk/src/documentation/content/xdocs/index.xml Thu Sep 4 04:22:46 2008
@@ -51,6 +51,54 @@
Spring instead. The main reason is that Spring has become a standard and helps to make
Droids as extensible as possible.</p>
</section>
+
+ <section>
+ <title>Feature list</title>
+ <ul>
+ <li>
+ <strong>Customizable.</strong>
+ Completely controlled by its default.properties which can be
+ easily be overridden by creating a file build.properties and
+ overriding the default properties that are needed.
+ </li>
+ <li>
+ <strong>Spring based.</strong>
+ The properties mentioned above get picked up by the build process
+ which inject them in the spring configuration.
+ </li>
+ <li>
+ <strong>Extensible.</strong>
+ The spring configuration makes usage of the cocoon-configurator and
+ its dynamic registry support (making extending droids a pleasure).
+ </li>
+ <li>
+ <strong>Multi-threaded.</strong>
+ The architecture is that a robot (e.g. DefaultDroid) controls
+ various worker (threads) that are doing the actual work.
+ </li>
+ <li>
+ <strong>Honor robots.txt.</strong>
+ By default droids honors the robot.txt. However you can turn on the
+hostile mode of a droid (droids.protocol.http.force=true).
+ </li>
+ <li><strong>Crawl throttling.</strong>
+ You can configure the amount of concurrent threads that a droid can
+distribute to their workers (droids.maxThreads=5) and the delay time
+between the requests (droids.delay.request=500).
+You can use one of the different delay components:<ul>
+<li>SimpleDelayTimer</li>
+<li>RandomDelayTimer</li>
+<li>GaussianRandomDelayTime</li>
+</ul>
+</li>
+ </ul>
+</section>
+
+<section>
+<title>Architecture</title>
+<p>The following graph shows the basic architecture of droids with the help of the first implementation (defaultCrawler).</p>
+<figure src="images/droidsOverview.png" alt="Overview" width="400" />
+</section>
<section>
<title>Requirements</title>
Added: labs/droids/trunk/src/documentation/resources/dia/droidsOverview.dia
URL: http://svn.apache.org/viewvc/labs/droids/trunk/src/documentation/resources/dia/droidsOverview.dia?rev=691967&view=auto
==============================================================================
Binary file - no diff available.
Propchange: labs/droids/trunk/src/documentation/resources/dia/droidsOverview.dia
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@labs.apache.org
For additional commands, e-mail: commits-help@labs.apache.org