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/06/25 15:26:20 UTC
svn commit: r823116 - in /websites/staging/stanbol/trunk/content: ./
stanbol/docs/trunk/contentenhancement.html
stanbol/docs/trunk/enhancementusage.html stanbol/docs/trunk/index.html
stanbol/docs/trunk/scenarios.html
Author: buildbot
Date: Mon Jun 25 13:26:19 2012
New Revision: 823116
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/contentenhancement.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancementusage.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/scenarios.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Jun 25 13:26:19 2012
@@ -1 +1 @@
-1353519
+1353526
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/contentenhancement.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/contentenhancement.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/contentenhancement.html Mon Jun 25 13:26:19 2012
@@ -20,7 +20,7 @@
-->
<link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
- <title>Apache Stanbol - Using Apache Stanbol for enhancing textual content</title>
+ <title>Apache Stanbol - Basic Content Enhancement</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
<script type="text/javascript">
@@ -77,9 +77,9 @@
</div>
<div id="content">
- <h1 class="title">Using Apache Stanbol for enhancing textual content</h1>
- <p>For enhancing content you simply post plain text content to the Enhancement Engines and you will get back enhancement data. The enhancement process is stateless, so neither your content item, nor the enhancements will be stored. </p>
-<p>You can test this via the <a href="http://localhost:8080/enhancer">Web interface</a> of the Stanbol Enhancer - http://{host}:{port}/enhancer or from the console using the CURL command.</p>
+ <h1 class="title">Basic Content Enhancement</h1>
+ <p>For enhancing content you simply post plain text content to the enhancement engines and you will get back enhancement data. The enhancement process is stateless, so neither your content item, nor the enhancements will be stored. </p>
+<p>You can test this via the <a href="http://localhost:8080/enhancer">Web interface</a> of the Apache Stanbol Enhancer - http://{host}:{port}/enhancer or from the console using the CURL command.</p>
<div class="codehilite"><pre>curl -X POST -H <span class="s2">"Accept: text/turtle"</span> -H <span class="s2">"Content-type: text/plain"</span> <span class="se">\</span>
--data <span class="s2">"The Stanbol enhancer can detect famous cities such as Paris \</span>
<span class="s2">and people such as Bob Marley."</span> http://localhost:8080/engines
@@ -95,34 +95,34 @@
</pre></div>
-<p>The Stanbol Enhancer can also enhancer non-plain-text files. In this case <a href="http://tika.apache.org">Apache Tika</a> - via the <a href="enhancer/engines/tikaengine.html">Tika Engine</a> is used to extract the plain text from those files (see the <a href="http://tika.apache.org">Apache Tika</a> documentation for supported file formats).</p>
+<p>The Apache Stanbol Enhancer can also enhancer non-plain-text files. In this case <a href="http://tika.apache.org">Apache Tika</a> - via the <a href="enhancer/engines/tikaengine.html">Tika Engine</a> is used to extract the plain text from those files (see the <a href="http://tika.apache.org">Apache Tika</a> documentation for supported file formats).</p>
<h2 id="configuring-and-using-enhancement-chains">Configuring and Using Enhancement Chains</h2>
-<p>The Stanbol Enhancer supports multiple <a href="enhancer/chains">Enhancement Chains</a>. This feature allows to configure use multiple processing chains for parsed content within the same Stanbol Instance.</p>
-<p>Chains are build based on an <a href="enhancer/chains/executionpla.html">Execution Plan</a> referencing one or more <a href="enhancer/engines">Enhancement Engines</a> by there name. Users can create and modify EnhancementChains by using the <a href="http://localhost:8080/system/console/configMgr">Configuration Tab</a> of the Apache Felix Webconsole - http://{host}:{port}/system/console/configMgr. There are three different implementations: (1) the self sorting <a href="enhancer/chains/weightedchain.html">Weighted Chain</a>, (2) the <a href="enhancer/chains/listchain.html">List Chain</a> and (3) the <a href="enhancer/chains/graphchain.html">Graph Chain</a> that allows the direct configuration of the execution graph. There is also a (4) <a href="enhancer/chains/defaultchain.html">Default Chain</a> that includes all currently active Enhancement Engines. While this engine is enabled by default most users might want to deactivate it as soon as they have configured there own cha
ins.</p>
-<p>To configure Enhancement Engine it is essential to understand the intension of the different <a href="enhancer/engines">Enhancement Engine</a> implementations. The <a href="enhancer/engines/list.html">List of all Enhancement Engines</a> managed by the Apache Stanbol Community is available <a href="enhancer/engines/list.html">here</a>. See the documentation of the listed Engines for detailed information.</p>
-<p>The list groups engines by categories: Preprocessing Engines_ typically perform operations on a content scope. This includes plain-text extraction, metadata extraction, language detection. This is followed by Engines that analyses the parsed content. This category currently includes all Natural Language Processing related engines but also would include Image-, Audio- and Viedo- processing. The third category consist of Engines that consume extracted features from the content and perform some kind of semantic lifting on it - e.g. linking extracted features with Entities/Concepts contained in Controlled Vocabularies. Finally Post-Processing Engines can be used to adjust rankings, filter out unwanted enhancements or do other kind of transformations on the Enhancement results.</p>
-<p>A typical Text Processing Enhancement Chain might look like that:</p>
+<p>The Apache Stanbol Enhancer supports multiple <a href="enhancer/chains">enhancement chains</a>. This feature allows to configure use multiple processing chains for parsed content within the same Apache Stanbol instance.</p>
+<p>Chains are build based on an <a href="enhancer/chains/executionpla.html">execution plan</a> referencing one or more <a href="enhancer/engines">enhancement engines</a> by there name. Users can create and modify enhancement chains by using the <a href="http://localhost:8080/system/console/configMgr">Configuration Tab</a> of the Apache Felix web console - http://{host}:{port}/system/console/configMgr. There are three different implementations: (1) the self sorting <a href="enhancer/chains/weightedchain.html">weighted chain</a>, (2) the <a href="enhancer/chains/listchain.html">list chain</a> and (3) the <a href="enhancer/chains/graphchain.html">graph chain</a> that allows the direct configuration of the execution graph. There is also a (4) <a href="enhancer/chains/defaultchain.html">default chain</a> that includes all currently active enhancement engines. While this engine is enabled by default most users might want to deactivate it as soon as they have configured there own c
hains.</p>
+<p>To configure enhancement engines it is essential to understand the intension of the different <a href="enhancer/engines">enhancement engine</a> implementations. The <a href="enhancer/engines/list.html">list of available enhancement engines</a> managed by the Apache Stanbol community is available <a href="enhancer/engines/list.html">here</a>. See the documentation of the listed engines for detailed information.</p>
+<p>The list groups engines by categories: Preprocessing engines typically perform operations on a content scope. This includes plain-text extraction, metadata extraction, language detection. This is followed by engines that analyses the parsed content. This category currently includes all Natural Language Processing (NLP) related engines but also would include image-, audio- and video- processing. The third category consist of engines that consume extracted features from the content and perform some kind of semantic lifting on it - e.g. linking extracted features with entities/concepts contained in controlled vocabularies. Finally post-processing engines can be used to adjust rankings, filter out unwanted enhancements or do other kind of transformations on the enhancement results.</p>
+<p>A typical text processing enhancement chain might look like that:</p>
<ul>
<li><a href="enhancer/engines/tikaengine.html">tika</a> - to convert parsed content to "text/plain"</li>
<li><a href="enhancer/engines/langidengine.html">langid</a> - to detect the language of the parsed text</li>
-<li><a href="enhancer/engines/namedentityextractionengine.html">ner</a> - to extract named entities (Persons, Organizations, Places) from the parsed text</li>
-<li><a href="enhancer/engines/namedentitytaggingengine.html">dbpediaLinking</a> - link extracted named entities with Entities defined by <a href="http://dbpedia.org">dbpedia.org</a></li>
-<li><a href="enhancer/engines/keywordlinkingengine.html">myCustomVocExtraction</a> - Keyword Extraction based on a custom built vocabulary - as described by this <a href="customvocabulary.html">usage scenario</a>.</li>
+<li><a href="enhancer/engines/namedentityextractionengine.html">ner</a> - to extract named entities (persons, organizations, places) from the parsed text</li>
+<li><a href="enhancer/engines/namedentitytaggingengine.html">dbpediaLinking</a> - link extracted named entities with entities defined by <a href="http://dbpedia.org">dbpedia.org</a></li>
+<li><a href="enhancer/engines/keywordlinkingengine.html">myCustomVocExtraction</a> - keyword extraction based on a custom built vocabulary - as described by this <a href="customvocabulary.html">usage scenario</a>.</li>
</ul>
-<p>An other Enhancement Chain using an External service</p>
+<p>And here is another enhancement chain using an external service</p>
<ul>
<li><a href="enhancer/engines/tikaengine.html">tika</a> - assuming we want to send MS Word dokuments to Zemanta</li>
-<li><a href="enhancer/engines/zemantaengine.html">zemanta</a> - this wraps <a href="http://www.zemanta.com/">Zemanta.com/</a> as Stanbol Enhancement Engine</li>
+<li><a href="enhancer/engines/zemantaengine.html">zemanta</a> - this wraps <a href="http://www.zemanta.com/">Zemanta.com/</a> as an Apache Stanbol Enhancement Engine</li>
</ul>
-<p><em>Tips for configuring Enhancment Chains:</em> </p>
+<p><em>Tips for configuring enhancment chains:</em> </p>
<ul>
<li><a href="http://localhost:8080/enhancer/engine">http://{host}:{port}/enhancer/chain</a> provides a list of all configured <a href="enhancer/chains">Enhancement Chains</a>. It also includes direct links to their configurations.</li>
<li>As one needs to use the names of active <a href="enhancer/engines">Enhancement Engines</a> for the configuration of Enhancement Chains it is very useful to open <a href="http://localhost:8080/enhancer/engine">http://{host}:{port}/enhancer/engine</a> in an other browser window.</li>
</ul>
-<p>After configuring all the Enhancement Engines and combining them to Enhancement Chains it is important to understand how to inspect and call the configured components via the RESTful API of the Stanbol Enhancer.</p>
+<p>After configuring all the enhancement engines and combining them to enhancement chains it is important to understand how to inspect and call the configured components via the RESTful API of the Apache Stanbol Enhancer.</p>
<p>Enhancement requests directly issued to <code>/enhancer</code> (or the old deprecated <code>/engines</code>) endpoint are processed by using the Enhancement Chain with the name "default" or if none with that name the one with the highest "service.ranking" (see <a href="enhancer/chains/#default-chain">here</a> for details). To process content with a specific chain requests need to be issued against <code>/enhancer/chain/{chain-name}</code>. </p>
-<p>Note that it is also possible to enhance content by using a single <a href="enhancer/engines">Enhancement Engine</a>. For that request can be sent to <code>enhancer/engine/{engine-name}</code>. A typical example would be parsing text directly to the <a href="enhancer/engine/langidengine.html">Language Identification Engine</a> to use the Stanbol Enhancer to detect the language of the parsed content.</p>
-<p>To sum up the RESTful API of the Stanbol Enhancer is structured like follows</p>
+<p>Note, that it is also possible to enhance content by using a single <a href="enhancer/engines">enhancement engine</a>. For that, request can be sent to <code>enhancer/engine/{engine-name}</code>. A typical example would be parsing text directly to the <a href="enhancer/engine/langidengine.html">Language Identification Engine</a> to use the Apache Stanbol Enhancer to detect the language of the parsed content.</p>
+<p>To sum up the RESTful API of the Apache Stanbol Enhancer is structured like follows</p>
<div class="codehilite"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">enhancer</span> <span class="o">-</span> <span class="n">returns</span> <span class="n">the</span> <span class="n">configuration</span> <span class="n">of</span> <span class="n">the</span> <span class="n">Stanbol</span> <span class="n">Enhancer</span>
<span class="n">GET</span> <span class="sr">/enhancer/c</span><span class="n">hain</span> <span class="o">-</span> <span class="n">returns</span> <span class="n">the</span> <span class="n">configuration</span> <span class="n">of</span> <span class="n">all</span> <span class="n">active</span> <span class="p">[</span><span class="n">Enhancement</span> <span class="n">Chains</span><span class="p">](</span><span class="n">enhancer</span><span class="o">/</span><span class="n">chains</span><span class="p">)</span>
<span class="n">GET</span> <span class="sr">/enhancer/</span><span class="n">engine</span> <span class="o">-</span> <span class="n">returns</span> <span class="n">the</span> <span class="n">configuration</span> <span class="n">of</span> <span class="n">all</span> <span class="n">active</span> <span class="p">[</span><span class="n">Enhancement</span> <span class="n">Engines</span><span class="p">](</span><span class="n">enhancer</span><span class="o">/</span><span class="n">engines</span><span class="p">)</span>
@@ -132,9 +132,9 @@
</pre></div>
-<p>See the <a href="enhancer/enhancerrest.html">Documentation</a> of the the RESTful API for all services and parameters of the Stanbol Enhancer.</p>
-<h2 id="using-an-index-of-linked-open-data-locally">Using an index of linked open data locally</h2>
-<p>Both the <a href="enhancer/engines/namedentitytaggingengine.html">Named Entity Tagging Engine</a> and the <a href="enhancer/engines/keywordlinkingengine.html">Keyword Linking Engine</a> require to be configured with a dataset containing Entities to link/extract for parsed content. As those Engines typically need to make a lot of requests against those datasets it is important to make those data locally available - a feature of the <a href="entityhub">Apache Stanbol Entityhub</a></p>
+<p>See the <a href="enhancer/enhancerrest.html">documentation</a> of the the RESTful API for all services and parameters of the Apache Stanbol Enhancer.</p>
+<h2 id="using-a-local-index-of-a-linked-open-data-source">Using a Local Index of a Linked Open Data Source</h2>
+<p>Both the <a href="enhancer/engines/namedentitytaggingengine.html">Named Entity Tagging Engine</a> and the <a href="enhancer/engines/keywordlinkingengine.html">Keyword Linking Engine</a> require to be configured with a dataset containing entities to link/extract for parsed content. As those engines typically need to make a lot of requests against those datasets it is important to make those data locally available - a feature of the <a href="entityhub">Apache Stanbol Entityhub</a></p>
<p>Because of this Apache Stanbol allows to create/install local indexes of datasets. A detailed description on how to create those indexes is described by this <a href="customvocabulary.html">user scenario</a>. A set of pre-computed indexes can be downloaded from the <a href="http://dev.iks-project.eu/downloads/stanbol-indices/">IKS development server</a>.</p>
<p>Indexes always consist of two parts:</p>
<ul>
@@ -153,7 +153,7 @@
</ul>
<p><em>NOTE:</em> In case of "dbpedia" the OSGI bundle with the configuration does not need to be installed as the default configuration of the Apache Stanbol launcher does already include the configuration of the necessary components.</p>
<h2 id="processing-the-enhancement-results">Processing the Enhancement Results</h2>
-<p>The final step in using the Stanbol Enhancer is about processing the Enhancement Results. As this is a central part developers of client applications this is described by an own <a href="enhancementusage.html">Usage Scenario</a></p>
+<p>The final step in using the Apache Stanbol Enhancer is about processing the enhancement results. As this is a central part developers of client applications this is described in another <a href="enhancementusage.html">usage scenario</a></p>
</div>
<div id="footer">
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancementusage.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancementusage.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancementusage.html Mon Jun 25 13:26:19 2012
@@ -20,7 +20,7 @@
-->
<link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
- <title>Apache Stanbol - Making use of Apache Stanbol enhancements</title>
+ <title>Apache Stanbol - Making use of Apache Stanbol Enhancements</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
<script type="text/javascript">
@@ -77,7 +77,7 @@
</div>
<div id="content">
- <h1 class="title">Making use of Apache Stanbol enhancements</h1>
+ <h1 class="title">Making use of Apache Stanbol Enhancements</h1>
<p>This document describes how to implement client side, i.e. user interface components by using the <a href="enhancer/engines/enhancementstructure.html">enhancement results</a> returned by the <a href="enhancer">Apachee Stanbol Enhancer</a>. It does so by using three different scenarios:</p>
<ul>
<li><strong>Entity Tagging</strong> - replacing text based tags such as "Bob Marley" with entities - <a href="dbpedia.org/resource/Bob_Marley">dbpedia:Bob_Marley</a> - to improve content search and categorization. As added value this can also be used for mashups with already available information about linked entities and search engine optimization by <a href="http://schema.org/docs/datamodel.html">including metadata</a> of tagged entities within the content.</li>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html Mon Jun 25 13:26:19 2012
@@ -82,6 +82,7 @@
<ul>
<li><a href="scenarios.html">Usage Scenarios</a><ul>
<li><a href="contentenhancement.html">Basic Content Enhancement</a></li>
+<li><a href="enhancementusage.html">Making use of Apache Stanbol Enhancements</a></li>
<li><a href="customvocabulary.html">Working with Custom Vocabularies</a></li>
<li><a href="multilingual.html">Working with Multiple Languages</a></li>
</ul>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/scenarios.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/scenarios.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/scenarios.html Mon Jun 25 13:26:19 2012
@@ -83,27 +83,18 @@
<figcaption>Figure 1: Traditional CMS using Apache Stanbol via its HTTP RESTful interface</figcaption></p>
<p>The following usage scenarios explain in more detail how to use various services from a CMS.</p>
<ul>
-<li>
-<p><a href="contentenhancement.html">Basic Content Enhancement</a>: Analyze textual content, enhance with it with named entities (person, place, organization), suggest links to open data sources.</p>
-</li>
-<li>
-<p><a href="customvocabulary.html">Working with Custom Vocabularies</a>: Use locally defined entities (e.g. thesaurus concepts) from an organization's context.</p>
-</li>
+<li><a href="contentenhancement.html">Basic Content Enhancement</a>: Analyze textual content, enhance with it with named entities (person, place, organization), suggest links to open data sources.</li>
+<li><a href="enhancementusage.html">Making use of Apache Stanbol Enhancements</a> Describes how to work with enhancements provided by the Apache Stanbol Enhancer.</li>
+<li><a href="customvocabulary.html">Working with Custom Vocabularies</a>: Use locally defined entities (e.g. thesaurus concepts) from an organization's context.</li>
<li>
<p><a href="multilingual.html">Working with Multiple Languages</a>: Get enhancements for textual content in multiple languages (EN, DE, SV, DA, PT and NL).</p>
</li>
<li>
<p>Semantic Search in Portals: Store/index enhancements and content items. For a portal this would facilitate semantic search applications.</p>
</li>
-<li>
-<p>Refactoring Enhancements for SEO: Refactor the enhancement result, its property names and ontology types according your target ontology.</p>
-</li>
-<li>
-<p>Transforming CMS repository structures into ontologies.</p>
-</li>
-<li>
-<p>Provide repository structures as thesaurus or domain ontology, e.g. categories.</p>
-</li>
+<li>Refactoring Enhancements for SEO: Refactor the enhancement result, its property names and ontology types according your target ontology.</li>
+<li>Transforming CMS repository structures into ontologies.</li>
+<li>Provide repository structures as thesaurus or domain ontology, e.g. categories.</li>
</ul>
<hr />
<p><em>Back to <a href="index.html">Documentation</a></em></p>