You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by bu...@apache.org on 2012/04/11 10:56:16 UTC
svn commit: r812321 [2/4] - in /websites/staging/stanbol/trunk/content: ./
stanbol/ stanbol/docs/0.9.0-incubating/
stanbol/docs/0.9.0-incubating/cmsadapter/
stanbol/docs/0.9.0-incubating/contenthub/
stanbol/docs/0.9.0-incubating/enhancer/ stanbol/docs/...
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/index.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -93,7 +96,7 @@ http://{host}:{port}/{stanbol-path}/engi
<p>To enhance a ContentItem with the default chain the "enhanceContent(ContentItem ci)" can be used.</p>
-<h2 id="chain_interface">Chain Interface</h2>
+<h2 id="chain-interface">Chain Interface</h2>
<p>The Chain interface is very simplistic. It defines just the following three methods:</p>
<div class="codehilite"><pre><span class="cm">/** Getter for the name of the Chain */</span>
<span class="o">+</span> <span class="n">getName</span><span class="o">()</span> <span class="o">:</span> <span class="n">String</span>
@@ -116,17 +119,17 @@ http://{host}:{port}/{stanbol-path}/engi
<p>Components that need to know the details about a Chain need to process the <a href="executionplan.html">ExecutionPlan</a> returned by the <code>getExecutionPlan()</code> method. The <a href="executionplan.html">ExecutionPlan</a> is represented as an RDF graph following the ExecutionPlan ontology. It formally describes how a ContentItem must be processed by the EnhancementJobManager. For details see the documentation for the <a href="executionplan.html">ExecutionPlan</a>.</p>
<p>For any Chain implementation it is important that the returned Graph holding the execution plan MUST BE read-only AND final. This means, that a change in the configuration of a Chain MUST NOT change the graph returned by calls to the getExecutionPlan method.</p>
<p>Because the configuration of a Chain might change at any time, the EnhancementJobManager implementation MUST retrieve the execution plan once and then use this instance for the whole enhancement process. Because of the above requirement that the execution plan is stored in a read-only and final Graph this ensures that the plan can not change even for long lasting enhancement processes. Therefore any change to the configuration of a chain will not influence the ongoing enhancement processes.</p>
-<h2 id="enhancement_chain_management">Enhancement Chain Management</h2>
+<h2 id="enhancement-chain-management">Enhancement Chain Management</h2>
<p>This section describes how Enhancement Chains are managed by the Stanbol Enhancer and how they can be selected/accessed. It also describes how the "default" Chain is determined.</p>
<p>For every Stanbol Enhancer a single Chain MUST BE present. If this is not the case enhance requests MUST throw a ChainException with an according error message. However typically multiple EnhancementChains will be configured. </p>
-<h3 id="chain_name_conflicts">Chain Name Conflicts</h3>
+<h3 id="chain-name-conflicts">Chain Name Conflicts</h3>
<p>Chains are identified by the value of the "stanbol.enhancer.chain.name" property - the name of the chain. If more than one Chain do use the same name, then the normal OSGI procedure to select the default service is used. This means that</p>
<ol>
<li>the Chain with the highest "service.ranking" and</li>
<li>the Chain with the lowest "service.id"</li>
</ol>
<p>will be selected on requests for a given Chain name. Via the RESTful service API there is no possibility to call the other chains for a given name. However the ChainManager interface allows to access all registered services for a given name.</p>
-<h3 id="default_chain">Default Chain</h3>
+<h3 id="default-chain">Default Chain</h3>
<p>The second important concept of the Chain management is the definition of the "default chain". The default Chain is used for enhancement requests that do not specify a Chain. This is true for requests to the "/engines" and "/enhancer" RESTful services as well as API calls to the "EnhancementJobManager.enhanceContent(ContentItem ci)" method.</p>
<p>The default Chain is determined by the following rules:</p>
<ol>
@@ -136,9 +139,9 @@ http://{host}:{port}/{stanbol-path}/engi
</ol>
<p>If no chain is active a ChainException with an according message MUST BE thrown.</p>
<p>All Stanbol launchers are configured with the <a href="defaultchain.html">Default Chain</a> enabled. This registers itself with the name "default" and the lowest possible service ranking - Integer.MIN_VALUE. This default provides a Chain that considers all currently active <a href="../engines">EnhancementEngines</a> and sorts them based on their ordering information (see the <a href="weightedchain.html#calculation_of_the_executionplan">Calculation of the Execution Plan based on the EnhancementEngine Ordering</a> for details).</p>
-<h3 id="chainmanager_interface">ChainManager interface</h3>
+<h3 id="chainmanager-interface">ChainManager interface</h3>
<p>The <a href="chainmanager.html">ChainManager</a> is the management interface for EnhancementChains that can be used by components to lookup chains based on their name. It also provides a getter for the default chain. There is also an OSGI ServiceTracker like implementation that can be used to track only chains with specific names and to get even notified on any change of such chains.</p>
-<h2 id="chain_implementations">Chain implementations</h2>
+<h2 id="chain-implementations">Chain implementations</h2>
<p>The following Chain implementations are included within the default Stanbol Enhancer distribution:</p>
<ul>
<li><strong><a href="defaultchain.html">DefaultChain</a></strong>: This implementation includes all currently active EnhancementEngines. If enabled it registers itself under the name "default" with the service ranking Integer.MIN_VALUE. This makes this chain to the default chain as long users do not deactivate it or register an other chain with the name "default".</li>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/listchain.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -77,7 +80,7 @@
</pre></div>
-<h2 id="calculation_of_the_executionplan">Calculation of the ExecutionPlan</h2>
+<h2 id="calculation-of-the-executionplan">Calculation of the ExecutionPlan</h2>
<p>The ExecutionPlan is created based on the exact order of the <a href="../engines">EnhancementEngines</a> provided by the "stanbol.enhancer.chain.list.enginelist" property. The configuration MUST contain at least a single engine. In addition no engine MUST be mentioned twice.</p>
</div>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -69,7 +72,7 @@
<p><img alt="Configuration dialog for the WeightedCahin" src="enhancer-weightedchain-config.png" title="Screenshot of the configuration dialog for a WeightedChain with two required and one optional engine" /></p>
-<h2 id="calculation_of_the_executionplan">Calculation of the ExecutionPlan</h2>
+<h2 id="calculation-of-the-executionplan">Calculation of the ExecutionPlan</h2>
<p>It is important to note that the ordering of the list has no influence on the ExecutionPlan because the order of execution of the configured <a href="../engines">EnhancementEngines</a> is calculated only by using the value of the "org.apache.stanbol.enhancer.engine.order" property provided by the EnhancementEngine:</p>
<ul>
<li>Engines with a lower order are executed before engines with a higher value</li>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemfactory.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemfactory.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemfactory.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementenginemanager.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -58,7 +61,7 @@
<div id="content">
<h1 class="title">Enhancement Engine Manager</h1>
<p>The EnhancementEngineManager provides name based access to all active <a href="index.html">EnhancementEngine</a>s and their ServiceReferences. This interface is typically used by components that need to lookup EnhancementEngines based on their name. However the EngineTracker implementation can also be used to track specific EnhancementEngines.</p>
-<h3 id="enhancementenginemanager_interface">EnhancementEngineManager interface</h3>
+<h3 id="enhancementenginemanager-interface">EnhancementEngineManager interface</h3>
<p>This is the Java API providing access to registered EnhancementEngines in the ways as described above. This interface includes the following methods:</p>
<div class="codehilite"><pre><span class="cm">/** Getter for all names with active engines */</span>
<span class="n">getActiveEngineNames</span><span class="o">()</span> <span class="o">:</span> <span class="n">Set</span><span class="o"><</span><span class="n">String</span><span class="o">></span>
@@ -81,7 +84,7 @@
<p>There are two implementations of this interface available:</p>
-<h4 id="enhancementenginemanager_service">EnhancementEngineManager Service</h4>
+<h4 id="enhancementenginemanager-service">EnhancementEngineManager Service</h4>
<p>This is an implementation of the EnhancementEngineManager interface that is registered as OSGI service. It can be used e.g. by using the @Reference annotation</p>
<div class="codehilite"><pre><span class="nd">@Reference</span>
<span class="n">EnhancementEngineManager</span> <span class="n">engineManager</span>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/geonamesengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -58,7 +61,7 @@
<div id="content">
<h1 class="title">The Geonames Enhancement Engine</h1>
<p>This engine creates fise:EntityAnnotations based on the http://geonames.org dataset. It does not directly work on the parsed content, but processes named entities extracted by some NLP (natural language processing) engine. This engine creates EntityAnnotations for Features found for named entities in the geonames.org data set. In addition it adds EntityAnnotations for the continent, country and administrative regions for entities with an high confidence level.</p>
-<h2 id="processed_annotations_input">Processed Annotations (Input)</h2>
+<h2 id="processed-annotations-input">Processed Annotations (Input)</h2>
<p>This engine consumes fise:TextAnnotations of type dbpedia:Place. More concretely it filters for enhancements which confirm to the following two requirements and consumes the text selected by the TextAnnotations:</p>
<div class="codehilite"><pre>?textAnnotation rdf:type fise:TextAnnotation .
?textAnnotation dc:type dbpedia:Place
@@ -87,9 +90,9 @@
<p>Typically such enhancements are created by engines that provide named entity extraction based on some natural language processing framework.</p>
-<h2 id="created_enhancements_output">Created Enhancements (Output)</h2>
+<h2 id="created-enhancements-output">Created Enhancements (Output)</h2>
<p>The LocationEnhancementEngine creates two types of EntityAnnotations. First it suggests Entities for processed TextAnnotations and second it creates EntityAnnotations for the hierarchy of regions the suggested Entities are located in. Suggested Entities are connected with the "dc:relation" attribute to the TextAnnotation they enhance. EntityAnnotations representing the hierarchydefine a dc:requires attribute to the EntityAnnotation.</p>
-<h3 id="entity_suggestions">Entity Suggestions</h3>
+<h3 id="entity-suggestions">Entity Suggestions</h3>
<p>Entity suggestions are EntityEnhancements that suggest Features of the geonames.org dataset for an processed TextAnnotation. This suggestions are currently only calculated based on the fise:selected-text of the TextAnnotation. </p>
<p>The following example shows three EntityAnnotations for the TextAnnotation used in the above example. See the fise:relation statements at the end of each of the two EntityAnnotations.</p>
<p>The first Entity found in the geonames.orf dataset is the capital city in Austria with an confidence level of 1.0:</p>
@@ -143,11 +146,11 @@ urn:enhancement:entity-enhancement:id3
</pre></div>
-<h2 id="entity_hierarchy_enhancements">Entity Hierarchy Enhancements</h2>
+<h2 id="entity-hierarchy-enhancements">Entity Hierarchy Enhancements</h2>
<p>Entity Hierarchy Enhancements describe the regions that contain suggested Features based on the geonames.org dataset. Enhancements describing this hierarchy are added for all suggested entities with a confidence level above the value of "eu.iksproject.fise.engines.geonames.locationEnhancementEngine.min-hierarchy-score". </p>
<p>The default value for this property is 0.7. The hierarchy web service provided by geonames.org is used to calculate the regions.
The following example shows the entity hierarchy enhancements for the suggested entity for Vienna (Autria). <em>Please note the dc:requires relation to this EntityAnnotation at the end of each of the following enhancement.</em></p>
-<h3 id="continent_europe">Continent: Europe</h3>
+<h3 id="continent-europe">Continent: Europe</h3>
<p>First the enhancement for the continent Europe:</p>
<div class="codehilite"><pre>urn:enhancement:entity-hierarchy-enhancement:id1
a fise:EntityAnnotation , fise:Enhancement ;
@@ -166,7 +169,7 @@ The following example shows the entity h
</pre></div>
-<h3 id="country_austria">Country: Austria</h3>
+<h3 id="country-austria">Country: Austria</h3>
<p>Next the enhancement for the country "Austria", classified as an independent political entry within geonames.org</p>
<div class="codehilite"><pre>urn:enhancement:entity-hierarchy-enhancement:id2
a fise:EntityAnnotation , fise:Enhancement ;
@@ -185,7 +188,7 @@ The following example shows the entity h
</pre></div>
-<h3 id="aadm1_-_a_county">A.ADM1 - A county</h3>
+<h3 id="aadm1-a-county">A.ADM1 - A county</h3>
<p>Now three enhancements describing the different hierarchies of administrative regions within Austria. First the "Bundesland", next the "Stadtteil" and last the "Gemeindebezirk".</p>
<div class="codehilite"><pre>urn:enhancement:entity-hierarchy-enhancement:id3
a fise:EntityAnnotation , fise:Enhancement ;
@@ -204,7 +207,7 @@ The following example shows the entity h
</pre></div>
-<h3 id="aadm2_-_a_city">A.ADM2 - A city</h3>
+<h3 id="aadm2-a-city">A.ADM2 - A city</h3>
<div class="codehilite"><pre>urn:enhancement:entity-hierarchy-enhancement:id4
a fise:EntityAnnotation , fise:Enhancement ;
fise:confidence
@@ -222,7 +225,7 @@ The following example shows the entity h
</pre></div>
-<h3 id="aadm3_-_a_village">A.ADM3 - A village</h3>
+<h3 id="aadm3-a-village">A.ADM3 - A village</h3>
<div class="codehilite"><pre>urn:enhancement:entity-hierarchy-enhancement:id5
a fise:EntityAnnotation , fise:Enhancement ;
fise:confidence
@@ -255,7 +258,7 @@ The following example shows the entity h
<li>User Name: Thats the name of the account (can be empty if the configured server does not require user authentication</li>
<li>Token: The token is usually the password of the user account.</li>
</ul>
-<h3 id="howto_setup_a_free_user_account">HOWTO setup a free user account:</h3>
+<h3 id="howto-setup-a-free-user-account">HOWTO setup a free user account:</h3>
<p>Such an account is required to be able to use the http://api.geonames.org/ server
that should support better performance and higher uptime than the default
free server available at http://ws.geonames.org/.</p>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/index.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -69,7 +72,7 @@
<p>When using the Java API, enhancement engines can be linked up as OSGI services. The <a href="enhancementenginemanager.html">Enhancement Engine Manager</a> service is designed to ease this by providing an API that allows to access enhancement engine by their name.</p>
-<h2 id="enhancement_engine_interface">Enhancement Engine Interface</h2>
+<h2 id="enhancement-engine-interface">Enhancement Engine Interface</h2>
<p>The interface for enhancement engines contains the following three methods:</p>
<div class="codehilite"><pre><span class="cm">/** Getter for the value of the "stanbol.enhancer.engine.name" property */</span>
<span class="o">+</span> <span class="n">getName</span><span class="o">()</span> <span class="o">:</span> <span class="n">String</span>
@@ -104,7 +107,7 @@
<li>some engines might also need to update/delete existing metadata.</li>
</ul>
<p>Both the <code>canEnhance(..)</code> and <code>computeEnhancements(..)</code> methods MUST be called by the <a href="../enhancementjobmanager.html">Enhancement Job Manager</a> after all the executions of all enhancement engines this one depends on are completed. This dependencies are defined by the <a href="../chains/executionplan.html">Execution Plan</a> used by the enhancement job manager to enhance the content item. Implementors of enhancement engines can therefore trust that all metadata expected to be added by other enhancement engines are already present within the metadata of the parsed content items when <code>canEnhance(..)</code> or <code>computeEnhancements(..)</code> is called.</p>
-<h3 id="services_properties_interface">Services Properties Interface</h3>
+<h3 id="services-properties-interface">Services Properties Interface</h3>
<p>This interface is implemented by most of the current enhancement engines. It allows engines to expose additional properties to other components. This interface defines a single method</p>
<div class="codehilite"><pre><span class="cm">/** Getter for the ServiceProperties */</span>
<span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span><span class="n">Object</span><span class="o">></span> <span class="n">getServiceProperties</span><span class="o">();</span>
@@ -112,7 +115,7 @@
<p>but also predefines the property <code>ENHANCEMENT_ENGINE_ORDERING = "org.apache.stanbol.enhancer.engine.order"</code> that can be used by enhancement engine implementations to specify their typical ordering within the enhancement process.</p>
-<h3 id="engine_ordering_information">Engine Ordering Information</h3>
+<h3 id="engine-ordering-information">Engine Ordering Information</h3>
<p>By implementing the ServicesProperties interface, enhancement engines do have the possibility to expose additional metadata to other components. The services properties interface defines only a single method</p>
<div class="codehilite"><pre><span class="cm">/** Getter for the ServiceProperties */</span>
<span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span><span class="n">Object</span><span class="o">></span> <span class="n">getServiceProperties</span><span class="o">();</span>
@@ -131,7 +134,7 @@
<p>The engine ordering information as described here are used by the <a href="../chains/defaultchain.html">Default Chain</a> and the <a href="../chains/weightedchain.html">Weighted Chain</a> to calculate the <a href="../chains/executionplan.html">Execution Plan</a>.</p>
<p>Basically this features allows the implementor of an enhancement engine to define the correct position of his engine within an typical enhancement chain and therefore ensure that users who add this engine to an enhancer installation to immediately use this engine with the <a href="../chains/defaultchain.html">Default Chain</a>.</p>
<p>However, the engine ordering is not the only possibility for users to control the execution order. Enhancement chain implementations such as the <a href="../chains/listchain.html">List Chain</a> and the <a href="../chains/graphchain.html">Graph Chain</a> do also allow to directly define the oder of execution. For these chains the ordering information provided by enhancement engines are ignored.</p>
-<h2 id="enhancement_engine_management">Enhancement Engine Management</h2>
+<h2 id="enhancement-engine-management">Enhancement Engine Management</h2>
<p>This section describes how enhancement engines are managed by the Apache Stanbol Enhancer and how they can be selected/accessed through the <a href="../enhancementjobmanager.html">Enhancement Job Manager</a> and executed in an <a href="../chains">Enhancement Chain</a>.</p>
<p>Enhancement engines are registered as OSGi services and managed by using the following service properties:</p>
<ul>
@@ -145,7 +148,7 @@ _TODO:_ To correctly construct this grap
-->
<p>Other components such as enhancement chains do refer to engines by their name. The actual enhancement engine instance is only looked up shortly before the execution.</p>
-<h3 id="enhancement_engine_name_conflicts">Enhancement Engine Name Conflicts</h3>
+<h3 id="enhancement-engine-name-conflicts">Enhancement Engine Name Conflicts</h3>
<p>As enhancement engines are identified by the value of the "stanbol.enhancer.engine.name" property - the name - there might be cases where multiple enhancement engine are registered with the same name. In such cases the normal OSGi procedure to select the default service instance of several possible matches is used. This means that</p>
<ol>
<li>the enhancement engine with the highest "service.ranking" and</li>
@@ -153,9 +156,9 @@ _TODO:_ To correctly construct this grap
</ol>
<p>will be selected on requests for a enhancement engine with a given name. Requests on the RESTful service API will always answer with the enhancement engine selected as default. When using the Java API there are also means to retrieve all enhancement engines for a given name via the <a href="enhancementenginemanager.html">Enhancement Engine Manager</a> interface.</p>
<p>Out of a user perspective there is one major use case for configuring multiple enhancement engines with the same name. This is to allow the definition of fallback engines if the main one becomes unavailable. E.g. lets assume that a user has a local cache of geonames.org loaded into the <a href="../../entityhub/">Entityhub</a> and configures an <a href="keywordlinkingengine.html">Named Entity Linking</a> engine to perform semantic lifting of extracted locations. However Apache Stanbol also provides the <a href="geonamesengine.html">geonames.org Engine</a> that provides a similar functionality by directly accessing <a href="http://geonames.org">geonames.org</a>. By configuring both engines for the same name, but specifying a higher service ranking for the one using the local cache one can ensure that the local cache is used for the enhancement under normal circumstances. However in case the local cache becomes unavailable the other engine using the remote service will be us
ed for enhancement.</p>
-<h3 id="enhancement_engine_manager_interface">Enhancement Engine Manager Interface</h3>
+<h3 id="enhancement-engine-manager-interface">Enhancement Engine Manager Interface</h3>
<p>The <a href="enhancementenginemanager.html">Enhancement Engine Manager</a> is the management interface for enhancement engines that can be used by components to lookup enhancement engines based on their name. There is also OSGI ServiceTracker like implementation that can be used to track only enhancement engines registered for a specific set of names. </p>
-<h2 id="enhancement_engine_implementations">Enhancement Engine Implementations</h2>
+<h2 id="enhancement-engine-implementations">Enhancement Engine Implementations</h2>
<p>A list of enhancement engine implementations maintained directly by the Apache Stanbol community can be found <a href="list.html">here</a>.
However the enhancement engine interface is designed in a way that it should be possible for advanced Apache Stanbol users to implement own enhancement engine implementations fulfilling their special needs.</p>
<p>The Apache Stanbol community would be very happy if users decide to share thoughts about possible enhancement engines or even would like to contribute additional engines to the Apache Stanbol project.</p>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/keywordlinkingengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/langidengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -58,7 +61,7 @@
<div id="content">
<h1 class="title">The Language Identification Engine: detect the language of an text</h1>
<p>The <strong>LangId</strong> engine determines the language of text.</p>
-<h2 id="technical_description">Technical Description</h2>
+<h2 id="technical-description">Technical Description</h2>
<p>The provided engine is based on the language identifier of <a href="http://tika.apache.org/">Apache Tika</a>.
The text to be checked must be provided in plain text format in one of two forms:</p>
<ul>
@@ -105,7 +108,7 @@ The text to be checked must be provided
<li>Thai: th</li>
</ul>
<p>Additional language models can be created as Tika <a href="org.apache.tika.language.LanguageProfile">LanguageProfile</a>.</p>
-<h2 id="configuration_options">Configuration options</h2>
+<h2 id="configuration-options">Configuration options</h2>
<ul>
<li><code>org.apache.stanbol.enhancer.engines.langid.probe-length</code>: an integer specifying how many characters will be used for identification. A value of 0 or below means to use the complete text. Otherwise only a substring of the specified length taken from the middle of the text will be used. The default value is 400 characters.</li>
</ul>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/list.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/list.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/list.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/metaxaengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentityextractionengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/namedentitytaggingengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/opencalaisengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -59,7 +62,7 @@
<h1 class="title">The OpenCalais Enhancement Engine</h1>
<p>The <strong>OpenCalais Enhancement Engine</strong> provides an interface to the <a href="http://www.opencalais.com/">OpenCalais
Webservice</a> for Named Entity Recognition (NER).</p>
-<h2 id="technical_description">Technical description</h2>
+<h2 id="technical-description">Technical description</h2>
<p>The engine will send the text of content item to the OpenCalais service and
retrieve the NER annotations in RDF format. The OpenCalais annotations are
added to the content item's metadata as Stanbol text enhancement structures.</p>
@@ -76,7 +79,7 @@ item's metadata as value of the property
<li>French (fr)</li>
<li>Spanish (es)</li>
</ul>
-<h2 id="requirements_for_use_and_configuration_options">Requirements for use and configuration options</h2>
+<h2 id="requirements-for-use-and-configuration-options">Requirements for use and configuration options</h2>
<p>The use of this component requires an API key from OpenCalais. Without
providing an API key, the engine will not do anything. Such a key can be
obtained from <a href="http://www.opencalais.com/APIkey">http://www.opencalais.com/APIkey</a>.</p>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/refactorengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -59,7 +62,7 @@
<h1 class="title">The Refactor Engine</h1>
<p>It re-factors the RDF graphs of recognized entities to a target vocabulary. The engines is provided with a default set of rules (a recipe) for the refactoring which allows to produce an RDF graph according to the google vocabulary. That default recipe allows to produce google rich
snippets.</p>
-<h2 id="technical_description">Technical Description</h2>
+<h2 id="technical-description">Technical Description</h2>
<p>This enhancement engine requires the following components running:</p>
<ul>
<li>Stanbol Entityhub</li>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/tikaengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/tikaengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/tikaengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/zemantaengine.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -58,7 +61,7 @@
<div id="content">
<h1 class="title">EnhancementJobManager</h1>
<p>The EnhancementJobManager is the component responsible for the execution of the <a href="chains/executionplan.html">ExecutionPlan</a> as provided by the <a href="chains">Enhancement Chain</a> on the <a href="contentitem.html">ContentItem</a>.</p>
-<h2 id="enhancementjobmanager_interface">EnhancementJobManager interface</h2>
+<h2 id="enhancementjobmanager-interface">EnhancementJobManager interface</h2>
<p>The interface of the EnhancementJobManager is very simple:</p>
<div class="codehilite"><pre><span class="cm">/** Enhances the content item by using the default Chain */</span>
<span class="o">+</span> <span class="n">enhanceContent</span><span class="o">(</span><span class="n">ContentItem</span> <span class="n">ci</span><span class="o">)</span>
@@ -68,11 +71,11 @@
<p>Note: the parsed ContentItem will be changed during the enhancement process. <a href="engines">EnhancementEngines</a> will add extracted knowledge to the metadata of the content item. Also additional content parts may be added to the ContentItem.</p>
-<h2 id="enhancement_process">Enhancement Process</h2>
+<h2 id="enhancement-process">Enhancement Process</h2>
<p><span style="float:right"> <img alt="Enhancement Job Manager Overview" src="enhancementjobmanageroverview.png" title="The Enhancement Job Manager executes the ExecutionPlan provided by the Enhancement Chain and records the ExecutionMetadata" /></span> </p>
<p>While the <a href="chains/executionplan.html">ExecutionPlan</a> defines what EnhancementEngines are used and how they depend on each other, the EnhancementJobManager is responsible for the actual execution of the enhancement process based on this plan. This section provides detailed information about requirements and expectations that MUST BE considered.</p>
<p>The EnhancementJobManager is also responsible to create and update the <a href="executionmetadata.html">ExecutionMetadata</a> in the metadata of the processed <a href="contentitem.html">ContentItem</a>. Details about this are provided in the section "<a href="executionmetadata.html#creationmanagement_of_executionmetadata">Creation/Management of ExecutionMetadata</a>" of the ExecutionMetadata documentation.</p>
-<h3 id="initializing_the_enhancement_process">Initializing the Enhancement Process</h3>
+<h3 id="initializing-the-enhancement-process">Initializing the Enhancement Process</h3>
<p>Here one needs to distinguish two cases:</p>
<ol>
<li>Initialization of an new Enhancement process and</li>
@@ -81,7 +84,7 @@
<p>The two cases can be easily detected by the EnhancementJobManager by evaluating if a content part with the URI "http://stanbol.apache.org/ontology/enhancer/executionMetadata#ChainExecution" is present within the parsed <a href="contentitem.html">ContentItem</a>.</p>
<p>In the first case the <a href="chains/executionplan.html">ExecutionPlan</a> to be used by the enhancement process is provided by the Chain in a final graph that is guaranteed to be not changed. However because the configuration of a Chain might be changed at any time the EnhancementJobManager MUST retrieve the execution plan only once and use it during the entire enhancement process. In addition the ExecutionPlan MUST BE also added to the graph containing the <a href="executionmetadata.html">EnahcementMetadata</a>. In case of continuing on an previously aborted enhancement process the ExecutionPlan MUST BE initialized from the ExecutionMetadata provided by the ContentItem.</p>
<p>For details on how to initialize/load the execution metadata see the section "<a href="executionmetadata.html#creationmanagement_of_executionmetadata">Creation/Management of ExecutionMetadata</a>" of the ExecutionMetadata documentation.</p>
-<h3 id="engine_execution">Engine Execution</h3>
+<h3 id="engine-execution">Engine Execution</h3>
<p>The ExecutionPlan provides the necessary information which <a href="engines">EnhancementEngines</a> can be executed at any given state. The following code shows how to determine executable engines.
This code snippet assumes to be called after the execution of an EnhancementEngine has completed. Note that in a multi threaded environment access to the list of executed and running engines need to be synchronized.</p>
<div class="codehilite"><pre><span class="n">Collection</span><span class="o"><</span><span class="n">NonLiteral</span><span class="o">></span> <span class="n">executed</span><span class="o">;</span> <span class="c1">//already executed Engines</span>
@@ -112,12 +115,12 @@ This code snippet assumes to be called a
<p>If the execution of an EnhancementEngine completes, the JobManager needs to set the state of the execution to completed and update the execution metadata accordingly.</p>
<p>If a call to "computeEnhancement(ContentItem ci)" results in an Exception the EnhancementJobManager must mark the execution of the engine as failed with a decryption of the occurred exception. If the execution of the affected engine was optional, the enhancement process is continued. Otherwise the enhancement process needs to be stopped and the Error needs to rethrown by the "enhanceContent(..)" method.</p>
<p>For all the details on how to reflect state changes in the Execution metadata see <a href="executionmetadata.html#execution_state_management">this section</a> of the documentation of the ExecutionMetadata.</p>
-<h3 id="multi_threaded_enhancement_processes">Multi Threaded enhancement processes</h3>
+<h3 id="multi-threaded-enhancement-processes">Multi Threaded enhancement processes</h3>
<p>In case the EnhancementJobManager supports to simultaneously call <a href="engines">EnhancementEngines</a> for the same content item in multiple threads, it is important to correctly use the ReadWriteLock as provided by the ContentItem.getLock() method.</p>
<p>There are many good examples on how to correctly use "java.util.concurrent.ReadWriteLock" available on the web.</p>
-<h3 id="finalizing_the_enhancementprocess">Finalizing the EnhancementProcess</h3>
+<h3 id="finalizing-the-enhancementprocess">Finalizing the EnhancementProcess</h3>
<p>When the execution is completed (successfully or failed), the EnhancementJobManager need to ensure that the 'em:status' and the 'em:completed' of the 'em:ChainExecution' instance are set. If the execution failed also the 'em:statusMessage' should be available and contain a message that describes the problem.</p>
-<h2 id="enhancementjobmanager_implementations">EnhancementJobManager implementations</h2>
+<h2 id="enhancementjobmanager-implementations">EnhancementJobManager implementations</h2>
<p>EnhancementJobManager implementations need to register itself as OSGI services. By default the Stanbol Enhancer will use the implementation with the highest service ranking. The service ranking can be set by providing a configuration defining an integer value for the property "service.ranking"</p>
<h3 id="eventjobmanager">EventJobManager</h3>
<p>This implementation is provided by the "org.apache.stanbol.enhancer.jobmanager.event" module and is currently used as default. It registers itself (by default) with a service ranking of '0'.</p>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/ses_annotationontology.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/ses_annotationontology.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/ses_annotationontology.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -62,7 +65,7 @@
<p>This proposal is aimed to define the "Stanbol Enhancement Structure" intended to be used by future version of the Stanbol Enhancer to encode Knowledge extracted from analyzed Documents.</p>
<p>Currently the Stanbol Enhancer still uses the <a href="http://wiki.iks-project.eu/index.php/EnhancementStructure">FISE Enhancement Structure</a> that dates back before the incubation of Stanbol to Apache. This proposal now suggest to base the "Stanbol Enhancement Structure" on the existing <a href="http://code.google.com/p/annotation-ontology/wiki/Homepage">Annotation-Ontology</a>.</p>
<p>The following two sections provide a short overview about the currently used FISE Enhancement Structure as well as the Annotation-Ontology. As this information is critical to understand the suggestion made in the later parts of this document.</p>
-<h3 id="fise_enhancement_structure">FISE Enhancement Structure</h3>
+<h3 id="fise-enhancement-structure">FISE Enhancement Structure</h3>
<p>The FISE Enhancement Structure defines three main Concepts:</p>
<ol>
<li><strong>FISE Enhancement</strong>: Defines Metadata about the creation process, type of the Enhancement as well as relations to other Enhancements.</li>
@@ -89,7 +92,7 @@
<p><img alt="Example of annotation on a whole document with AO" src="http://annotation-ontology.googlecode.com/svn/trunk/images/Document%20Annotation%20-%20AO%20Annotation%20Ontology%20-%20by%20Paolo%20Ciccarese.png" title="Example of annotation on a whole document with AO" /></p>
<p>Image Credit: Annotation-Ontology <a href="http://annotation-ontology.googlecode.com/svn/trunk/images/Document%20Annotation%20-%20AO%20Annotation%20Ontology%20-%20by%20Paolo%20Ciccarese.png">Link</a></p>
</blockquote>
-<h2 id="stanbol_enhancement_structure">Stanbol Enhancement Structure</h2>
+<h2 id="stanbol-enhancement-structure">Stanbol Enhancement Structure</h2>
<p>The following sections describe how the Stanbol Enhancement Structure can utilize the Annotation-Ontology to encode knowledge extracted from analyzed Content Items.</p>
<h3 id="contentitems">ContentItems</h3>
<p>Within the FISE Enhancement Structure the enhanced ContentItems where only referenced by the <strong>fise:extracted-from</strong> property. There was no specification on how to further define properties of the ContentItem. The Annotation-Ontology defines a much richer vocabulary for that.</p>
@@ -103,21 +106,21 @@
<p>Image Credit: Annotation Ontology <a href="http://annotation-ontology.googlecode.com/svn/trunk/images/Source%20Document%202%20-%20AO%20Annotation%20Ontology%20-%20by%20Paolo%20Ciccarese.png">Link</a></p>
</blockquote>
<p>As an example: If a Web-Crawler crawls a site on the Web and stores a local copy for indexing, than the <strong>Annotated Document</strong> would use the URL of the document on the Web. The <strong>Source Document</strong> would be the ID of the locally cached version used for the enhancement process.</p>
-<h4 id="content_adapter_and_source_documents">Content Adapter and Source Documents:</h4>
+<h4 id="content-adapter-and-source-documents">Content Adapter and Source Documents:</h4>
<p>The Content Adapter pattern was suggested to be used to convert parsed documents to different Content Formats such as extracting the Plain Text of parsed HTML or PDF documents.</p>
<p>The possibility to distinguish between the <em>Annotated Document</em> and the <em>Source Document</em> nicely supports this, because while Enhancement Engines can state that an Annotation is about the <em>Annotated Document</em> they can still state the exact <em>Source Document</em> that was used for processing. This allows e.g. to clearly state that the indexes of a text selection are based on the plain text version of the <em>Annotated Document</em>. </p>
-<h3 id="content_selectors">Content Selectors</h3>
+<h3 id="content-selectors">Content Selectors</h3>
<p>The FISE Enhancement Structure defined a single "Content Selector" the <em>FISE Text Annotation</em>. The Annotation-Ontology uses a much richer Structure that even provides the possibility to extensions for defining specific selections on different content types.</p>
<p>With the Annotation-Ontology each Selector can link to both the <em>Annotated Document</em> and the <em>Source Document</em>. In the following an Example for an Image Selection</p>
<blockquote>
<p><img alt="Image Selector" src="http://annotation-ontology.googlecode.com/svn/trunk/images/Image%20InitEndCorner%20Selector%20-%20AO%20Annotation%20Ontology%20-%20by%20Paolo%20Ciccarese.png" title="Image Selector Example" /></p>
<p>Image Credits: Annotation-Ontology <a href="http://annotation-ontology.googlecode.com/svn/trunk/images/Image%20InitEndCorner%20Selector%20-%20AO%20Annotation%20Ontology%20-%20by%20Paolo%20Ciccarese.png">Link</a>.</p>
</blockquote>
-<h4 id="text_selectors">Text Selectors</h4>
+<h4 id="text-selectors">Text Selectors</h4>
<p>The currently used FISE TextAnnotation differs from text selects of the Annotation-Ontology mainly in that it defines both the actual annotation AND the selection within the text. Therefore when adopting the "Annotation -> Selector" model or the Annotation-Ontology all Annotation related properties of the FISE TextAnnotation must be separated from the properties describing the selection.</p>
<p>The Annotation-Ontology defines two text selectors: (1) the "OffsetRangeSelector" that uses char offset within the text to define a selection and (2) the "PrefixPostfixSelector" that uses a prefix, suffix and the selected text to define the selection based on the context. The Stanbol Enhancer currently uses both (context and offset) to define selection. However currently only single property "context" is used instead of the prefix, suffix model of the "PrefixPostfixSelector". In general the prefix, postfix based context definition as used by the Annotation-Ontology is better, because is allows to uniquely determine the selected part of the text even if the selected text appears multiple times within a given context. With the currently used model it is not possible to do that if the selected text appears several times in the provided context. </p>
<p>The suggestion is to keep both (offset and context) based definition of text selection but switch to the prefix, suffix model for defining the context. Therefore stanbol:TextSelector will be defined as sub-class of both "OffsetRangeSelector" and "PrefixPostfixSelector".</p>
-<h4 id="multi_media_selectors_and_the_media_fragments_standard">Multi Media Selectors and the Media Fragments Standard</h4>
+<h4 id="multi-media-selectors-and-the-media-fragments-standard">Multi Media Selectors and the Media Fragments Standard</h4>
<p>The <a href="http://www.w3.org/2008/WebVideo/Fragments/">Media Fragments Working Group</a> of the W3C is currently working on a Recommendation on how to encode Fragments of Resources within so called <a href="http://www.w3.org/2008/WebVideo/Fragments/WD-media-fragments-spec/">Media Fragments URIs</a>.</p>
<p>This specification defines how to encode the <a href="http://www.w3.org/2008/WebVideo/Fragments/WD-media-fragments-spec/#naming-time">Temporal</a>, <a href="http://www.w3.org/2008/WebVideo/Fragments/WD-media-fragments-spec/#naming-space">Spatial</a>, <a href="http://www.w3.org/2008/WebVideo/Fragments/WD-media-fragments-spec/#naming-track">Track</a> and <a href="http://www.w3.org/2008/WebVideo/Fragments/WD-media-fragments-spec/#naming-id">ID</a> dimensions within Document URIs but also defines processing rules (e.g. for Browsers) and the semantics.</p>
<p>The proposal here is to use this specification for encoding selections within multi media files within the Annotation-Ontology. This will most likely require the definition of an MediaFragmentSelector as extension.</p>
@@ -130,7 +133,7 @@
<li>Each Annotation-Resource MUST BE linked to the <em>Annotated Document</em> by using the <strong>ao:annotatesResource</strong> property. The <em>Source Document</em> can be referenced by using the <strong>ao:onSourceDocument</strong>. It is also possible to link multiple Documents with an annotation.</li>
</ul>
<p>The following sub-sections will provide an overview how Text Annotations, Entity Annotations and Category Annotations as used by Stanbol can be expressed using the Annotation-Ontology</p>
-<h4 id="text_annotations">Text Annotations</h4>
+<h4 id="text-annotations">Text Annotations</h4>
<p>Text Annotations are Annotations as typically created by NER (Named Entity Recognition) engines. Such Annotations select a part of a Text and assign a type (Person, Organization, Place ...) to that.</p>
<p>The text selection can be expressed by using an "PrefixPostfixSelector". The type and the confidence of the detected named entity need to be properties of the Annotation class.</p>
<div class="codehilite"><pre><span class="err">stanbol:TextAnnotation</span> <span class="err">rdfs:subClassOf</span> <span class="err">ao:Annotation</span>
@@ -138,15 +141,15 @@
</pre></div>
-<h4 id="entity_annotations">Entity Annotations</h4>
+<h4 id="entity-annotations">Entity Annotations</h4>
<p>Entity Annotations are similar to "Qualifier" annotations as defined to the Annotaiton-Ontology. The <em>ao:hasTopic</em> relation is used to link the annotation with the related topic.</p>
<div class="codehilite"><pre><span class="err">stanbol:EntityAnnotation</span> <span class="err">rdfs:subClassof</span> <span class="err">aot:Qualifier,</span> <span class="err">ao:Annotation</span>
</pre></div>
-<h4 id="category_anotations">Category Anotations</h4>
+<h4 id="category-anotations">Category Anotations</h4>
<p>Category Annotations are typically about the whole or an specific section of an Document. Normal Selectors can be used for defining the categorized Section. If no Selector is present the categorization applies to the whole document. The "Qualifier" annotation could also be used as a base class for categorizations.</p>
-<h3 id="annotation_sets">Annotation Sets</h3>
+<h3 id="annotation-sets">Annotation Sets</h3>
<p>Within the Annotation-Ontologies Annotation Sets can be used to group several Annotations together. Although the FISE Enhancement Structure does not explicitly define a similar possibility the possibilities to define relations between FISE Enhancements are used for a similar purpose by the Stanbol Enhancer. Therefore the suggestion is to use this feature of the Annotation-Ontology to model for expressing sets of possible Categories, suggestions of Entities.</p>
<p>The following figure shows an Example for an Annotation Set with a single Annotation</p>
<blockquote>
@@ -156,7 +159,7 @@
<p>This suggests the use of Annotation Sets to formally describe situations where the Stanbol Enhancer need group several Annotations in order to provide users the possibility to select from a predefined set of options. Assigning an unique ID - the URI of the AnnotationSet instance - to such a collection of Annotations brings also the possibility for the consumer to provide explicit feedback to the Stanbol Enhancer (e.g. by accepting/rejecting Annotations part of the AnnotationSet, adding an additional Annotation to an set, ...)</p>
<p>Note that single Annotations might be part of several annotation sets. As an Example take an Text Annotation for that to sets of Entity suggestions are generated.</p>
<p>The suggestion is to create subclasses for common types of Annotation Sets uses by the Stanbol Enhancer</p>
-<h4 id="entity_suggestions">Entity Suggestions</h4>
+<h4 id="entity-suggestions">Entity Suggestions</h4>
<p>With the FISE Enhancement Structure this is expressed by a <em>fise:TextAnnotation</em> that is linked to several <em>fise:EntityAnnotation</em>s by the <em>dc:relation</em> property.</p>
<p>Expressing the same based on the Annotation-Ontology would be possible by</p>
<ul>
@@ -169,9 +172,9 @@
<ul>
<li>Allow multiple TextAnnotations: This would allow to suggest the same set of Entities to all TextAnnotations. However it would make it also more difficult to express if a user would accept a suggestion for one TextAnnotation but reject the same for an other. In addition Users might even accept different suggestions for different included TextAnnotation. (see also <em>Coreference Suggestions</em>)</li>
</ul>
-<h4 id="category_suggestions">Category Suggestions</h4>
+<h4 id="category-suggestions">Category Suggestions</h4>
<p>Typically categorizations can provide more than a single Category. So grouping such suggestions within an AnnotationSet gives Users the possibility to accept/reject one or more of such suggestions. In addition it would also allow to distinguish sets of categorizations calculated based on disjoint sets of categories (e.g. a categorization based on a UserProfile with a categorization based on general topics or a spatial categorization).</p>
-<h4 id="coreference_suggestion">Coreference Suggestion</h4>
+<h4 id="coreference-suggestion">Coreference Suggestion</h4>
<p>This would allow to link several Text Annotations to suggest a co-reference between those two. This kind of AnnotationSet is expected to be used by NLP (Natural Language Processing) frameworks that can detect co-references. It might be also of interest for Engines that suggest Entities but keep an Annotation Context and therefore want to link persons only referred by the given or family name to an other occurrence that uses both.</p>
<p>The type of the coreference could be captured by an special property of this annotation set type.</p>
</div>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/stanbolenhancementstructure.html Wed Apr 11 08:56:13 2012
@@ -32,7 +32,10 @@
<ul>
<li><a href="/stanbol/index.html">Home</a></li>
<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
-<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/doc/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
</ul>
<h1 id="project">Project</h1>
@@ -46,7 +49,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
@@ -89,7 +92,7 @@
<li>sb:Occurrences, sb:Annotations and Suggestions MUST include rdf:type information for all parent types. e.g. when adding a sb:TextOccurrences the rdf:type MUST include sb:TextOccurrence AND sb:Occurrences. Consumers are expected to NOT using any kind of reasoner therefore adding such additional information is the only way to ensure that queries for occurrences, annotations or suggestions provide the expected results.</li>
</ul>
<h2 id="specification">Specification</h2>
-<h3 id="namespaces_and_used_notations">Namespaces and used Notations</h3>
+<h3 id="namespaces-and-used-notations">Namespaces and used Notations</h3>
<p>While the Stanbol Enhancement Structure does define some Concepts and Properties it also uses a lot of existing things from other ontologies. To improve the readability of this specification namespace prefixes + local names are used instead of the full URLs by this specification.</p>
<p>All the namespace prefixes used within this specification are described by the following list: </p>
<ul>
@@ -114,7 +117,7 @@
<li>In case of <{code}> the URI identifies a resource that is created/defined by the enhancement results - meaning that the returned knowledge contains all information about that resource</li>
<li>{value}^^xsd:anyURI indicates that enhancement results will not provide additional knowledge about this resource. If the consumer needs more information about such resources he need to use other services to retrieve such knowledge or parse special parameters to tell Stanbol to explicitly include such knowledge in the response.</li>
</ul>
-<h3 id="contentitem_ltci">ContentItem <ci></h3>
+<h3 id="contentitem-wzxhzdk26ci">ContentItem <ci></h3>
<p>The ContentItem <ci> represents a content parsed to the Stanbol Enhancer. It is the central resource used to link all the enhancements created by the EnhancementEngines.</p>
<div class="codehilite"><pre><ci> rdf:type sb:ContentItem
[<ci> sb:embeds-knowledge {knowlegeGraphId}]
@@ -416,9 +419,9 @@ First we need to create an EntityAnnotat
<li>VideoOccurrence: Would be the combination of a time based and a visual occurrence
This kind of occurrences are currently not defined, because there is no Stanbol EnhancementEngine that could make use of it.</li>
</ul>
-<h2 id="use_cases_and_examples">Use Cases and Examples</h2>
+<h2 id="use-cases-and-examples">Use Cases and Examples</h2>
<p>This Sections describes uses cases how the Stanbol Enhancement Structure is used to enhance documents. It also provides examples of how users can use/query for enhancements based on the returned knowledge</p>
-<h3 id="simple_text_enhancement">Simple Text Enhancement</h3>
+<h3 id="simple-text-enhancement">Simple Text Enhancement</h3>
<p>An User types the text "Next week I will travel to Paris" and would like to have general Enhancements like Tags, Keywords and Categories</p>
<p>Lets assume that Paris was detected to describe a location and travel to be a keyword. There are also two known Entities with the name "Paris" and the type Location.
This would result in an enhancement graph as follows </p>
@@ -550,7 +553,7 @@ WHERE {
</pre></div>
-<h3 id="enhancement_of_metadata">Enhancement of Metadata</h3>
+<h3 id="enhancement-of-metadata">Enhancement of Metadata</h3>
<p>This example shows the the Enhancement Structure allows to create enhancements based on parsed Metadata.</p>
<p>Lets assume that a user parses a content item and an additional file providing Dublin Core metadata that include (among others)</p>
<ul>