svn commit: r1235263 - /incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/

[rwesten]

Author: rwesten
Date: Tue Jan 24 14:26:17 2012
New Revision: 1235263

URL: http://svn.apache.org/viewvc?rev=1235263&view=rev
Log:
Updates to the WeightedChain documentation

Added:
    
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-allactive.png
   (with props)
    
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-optionalinactive.png
   (with props)
    
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-requiredinactive.png
   (with props)
Modified:
    
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-config.png
    
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext

Added: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-allactive.png
URL: 
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-allactive.png?rev=1235263&view=auto
==============================================================================
Binary file - no diff available.

Propchange: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-allactive.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-config.png
URL: 
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-config.png?rev=1235263&r1=1235262&r2=1235263&view=diff
==============================================================================
Binary files - no diff available.

Added: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-optionalinactive.png
URL: 
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-optionalinactive.png?rev=1235263&view=auto
==============================================================================
Binary file - no diff available.

Propchange: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-optionalinactive.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-requiredinactive.png
URL: 
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-requiredinactive.png?rev=1235263&view=auto
==============================================================================
Binary file - no diff available.

Propchange: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-requiredinactive.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext
URL: 
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext?rev=1235263&r1=1235262&r2=1235263&view=diff
==============================================================================
--- 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext
 (original)
+++ 
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.mdtext
 Tue Jan 24 14:26:17 2012
@@ -28,3 +28,16 @@ It is important to note that the orderin
 
 The WeightedCahin follows exactly the same algorithm as the WeightedJobManager 
used to decide the execution order of all active EnhancementEngines. However 
the WeightedChain will only consider configured chains and ignore others.
 
+The following image shows the ExecutionPlan as calculated based on the above 
configuration
+
+![ExecutionPlan for the keyword chain](enhancer-weightedchain-allactive.png 
"The ExecutionPlan is calculated based on the 'order' information of the 
Enhancement Engines. In this case first 'metaxa' is used to convert any type of 
content to plain text; second the 'langid' engine is used to detect the 
language and third the Words mentioned in the text are used to lookup entities 
in DBpedia.org")
+
+If some of the Enhancement Engines are not available this will be visualized 
as follows. If you parse content by using the RESTful interface similar 
information will be available via the the Execution Metadata included in the 
metadata of the enhanced content item.
+
+![Optional Engine is inactive](enhancer-weightedchain-optionalinactive.png 
"The optional 'metaxa' engine is inactive. The engine can still be executed 
however content other than plain text will bot get enhanced")
+
+This shows that the optional engine 'metaxa' is currently not available. The 
chain can be still used however the functionality provided by this optional 
engine will not be available. In this case only requests for plain text files 
could be processed.
+
+The following figure shows a situation where a required engine is not active. 
Requests to this chain will fail until all required engines are active.
+
+![Requried Engine is inactive](enhancer-weightedchain-requiredinactive.png 
"The required 'langid' engine is not active. Because of this requests to this 
chain will fail.")