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 2013/10/16 12:18:15 UTC
svn commit: r882827 - in /websites/staging/stanbol/trunk/content: ./
docs/trunk/components/enhancer/index.html
docs/trunk/contentenhancement.html docs/trunk/production-mode/index.html
Author: buildbot
Date: Wed Oct 16 10:18:15 2013
New Revision: 882827
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/index.html
websites/staging/stanbol/trunk/content/docs/trunk/contentenhancement.html
websites/staging/stanbol/trunk/content/docs/trunk/production-mode/index.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Oct 16 10:18:15 2013
@@ -1 +1 @@
-1529485
+1532706
Modified: websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/index.html (original)
+++ websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/index.html Wed Oct 16 10:18:15 2013
@@ -100,14 +100,14 @@
</li>
<li><a href="#List_of_Engines">List of Available Enhancement Engines</a></li>
</ul>
-<p>Reader should note that this is the technical documentation of the Stanbol Enhancer intended for Developer. For more practical - usage case oriented - introduction to the Stanbol Enhancer as well as other components place have look at the available <a href="../scenarios.html">Usage Scenarios</a>.</p>
+<p>Reader should note that this is the technical documentation of the Stanbol Enhancer intended for Developer. For more practical - usage case oriented - introduction to the Stanbol Enhancer as well as other components please have look at the available <a href="../scenarios.html">Usage Scenarios</a>.</p>
<p><a name="Using_Stanbol_Enhancer"></a></p>
<h2 id="using-the-stanbol-enhancer">Using the Stanbol Enhancer</h2>
<p>The figure below provides an overview of the RESTful as well as the Java API provided by the Stanbol Enhancer
<p style="text-align: center;"><img alt="Stanbol Enhancer Overview" src="enhanceroverview-s.png" title="Overview of RESTful Services and Java API provided by the Stanbol Enhancer" /></p></p>
<p><a name="RESTful_API"></a></p>
<h3 id="restful-api">RESTful API</h3>
-<p>The content to be analyzed should be sent in a POST request with the mime-type specified in the Content-type header. The parsed content is than processed by the targeted <a href="chains">Enhancement Chain</a>. The response will hold the RDF enhancement serialized in the format specified in the Accept header. The following figure visualizes this process.
+<p>The content to be analyzed should be sent in a POST request with the mime-type specified in the Content-type header. The parsed content is then processed by the targeted <a href="chains">Enhancement Chain</a>. The response will hold the RDF enhancement serialized in the format specified in the Accept header. The following figure visualizes this process.
<p style="text-align: center;"><img alt="Enhancing Content with the Stanbol Enhancer" src="enhancer-overview.png" title="The Stanbol Enhancer uses a Chain of Enhancement Engines to extract Entities from parsed Content and returns results as RDF." /></p></p>
<p>You can test that easily from the command line 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>
Modified: websites/staging/stanbol/trunk/content/docs/trunk/contentenhancement.html
==============================================================================
--- websites/staging/stanbol/trunk/content/docs/trunk/contentenhancement.html (original)
+++ websites/staging/stanbol/trunk/content/docs/trunk/contentenhancement.html Wed Oct 16 10:18:15 2013
@@ -106,10 +106,10 @@
<p>The following script sends the contents of the text-examples folder to the Stanbol Enhancer. However it could also be used to index the contents of any folder on the local file system. If you want to keep the Enhancement results you can pipe the results of the curl command (e.g. to files)</p>
-<div class="codehilite"><pre><span class="k">for</span> <span class="n">file</span> <span class="n">in</span> <span class="n">enhancer</span><span class="sr">/data/</span><span class="n">text</span><span class="o">-</span><span class="n">examples</span><span class="o">/*.*</span><span class="p">;</span>
-<span class="k">do</span>
- <span class="n">curl</span> <span class="o">-</span><span class="n">X</span> <span class="n">POST</span> <span class="o">-</span><span class="n">H</span> <span class="s">"Accept: text/turtle"</span> <span class="o">-</span><span class="n">H</span> <span class="s">"Content-type: text/plain"</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">T</span> <span class="nv">$file</span> <span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="o">/</span><span class="n">enhancer</span><span class="p">;</span>
+<div class="codehilite"><pre><span class="k">for</span> <span class="n">file</span> <span class="n">in</span> <span class="n">enhancer</span><span class="o">/</span><span class="n">data</span><span class="o">/</span><span class="n">text</span><span class="o">-</span><span class="n">examples</span><span class="o">/*.*</span><span class="p">;</span>
+<span class="n">do</span>
+ <span class="n">curl</span> <span class="o">-</span><span class="n">X</span> <span class="n">POST</span> <span class="o">-</span><span class="n">H</span> "<span class="n">Accept</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">turtle</span>" <span class="o">-</span><span class="n">H</span> "<span class="n">Content</span><span class="o">-</span><span class="n">type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">plain</span>" <span class="o">\</span>
+ <span class="o">-</span><span class="n">T</span> $<span class="n">file</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span>8080<span class="o">/</span><span class="n">enhancer</span><span class="p">;</span>
<span class="n">done</span>
</pre></div>
@@ -139,7 +139,7 @@
<li><a href="components/enhancer/engines/tikaengine.html">tika</a> - assuming we want to send MS Word dokuments to Zemanta</li>
<li><a href="components/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 enhancement 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="components/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="components/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>
@@ -149,11 +149,11 @@
<p>Note, that it is also possible to enhance content by using a single <a href="components/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="components/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">components</span><span class="sr">/enhancer/c</span><span class="n">hains</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">components</span><span class="sr">/enhancer/</span><span class="n">engines</span><span class="p">)</span>
+<span class="n">GET</span> <span class="o">/</span><span class="n">enhancer</span><span class="o">/</span><span class="n">chain</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">components</span><span class="o">/</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="o">/</span><span class="n">enhancer</span><span class="o">/</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">components</span><span class="o">/</span><span class="n">enhancer</span><span class="o">/</span><span class="n">engines</span><span class="p">)</span>
<span class="n">POST</span> <span class="o">/</span><span class="n">enhancer</span> <span class="o">-</span> <span class="n">enhances</span> <span class="n">parsed</span> <span class="n">content</span> <span class="n">by</span> <span class="n">using</span> <span class="n">the</span> <span class="n">default</span> <span class="n">Enhancement</span> <span class="n">Chain</span>
-<span class="n">POST</span> <span class="sr">/enhancer/c</span><span class="n">hain</span><span class="o">/</span><span class="p">{</span><span class="n">chain</span><span class="o">-</span><span class="n">name</span><span class="p">}</span> <span class="o">-</span> <span class="n">enhances</span> <span class="n">parsed</span> <span class="n">content</span> <span class="n">by</span> <span class="n">using</span> <span class="n">the</span> <span class="n">Enhancement</span> <span class="n">Chain</span> <span class="n">with</span> <span class="n">the</span> <span class="n">given</span> <span class="n">name</span>
-<span class="n">POST</span> <span class="sr">/enhancer/</span><span class="n">engine</span><span class="o">/</span><span class="p">{</span><span class="n">engine</span><span class="o">-</span><span class="n">name</span><span class="p">}</span> <span class="o">-</span> <span class="n">enhances</span> <span class="n">parsed</span> <span class="n">content</span> <span class="n">by</span> <span class="n">using</span> <span class="n">only</span> <span class="n">the</span> <span class="n">referenced</span> <span class="n">Enhancement</span> <span class="n">Engine</span>
+<span class="n">POST</span> <span class="o">/</span><span class="n">enhancer</span><span class="o">/</span><span class="n">chain</span><span class="o">/</span><span class="p">{</span><span class="n">chain</span><span class="o">-</span><span class="n">name</span><span class="p">}</span> <span class="o">-</span> <span class="n">enhances</span> <span class="n">parsed</span> <span class="n">content</span> <span class="n">by</span> <span class="n">using</span> <span class="n">the</span> <span class="n">Enhancement</span> <span class="n">Chain</span> <span class="n">with</span> <span class="n">the</span> <span class="n">given</span> <span class="n">name</span>
+<span class="n">POST</span> <span class="o">/</span><span class="n">enhancer</span><span class="o">/</span><span class="n">engine</span><span class="o">/</span><span class="p">{</span><span class="n">engine</span><span class="o">-</span><span class="n">name</span><span class="p">}</span> <span class="o">-</span> <span class="n">enhances</span> <span class="n">parsed</span> <span class="n">content</span> <span class="n">by</span> <span class="n">using</span> <span class="n">only</span> <span class="n">the</span> <span class="n">referenced</span> <span class="n">Enhancement</span> <span class="n">Engine</span>
</pre></div>
Modified: websites/staging/stanbol/trunk/content/docs/trunk/production-mode/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/docs/trunk/production-mode/index.html (original)
+++ websites/staging/stanbol/trunk/content/docs/trunk/production-mode/index.html Wed Oct 16 10:18:15 2013
@@ -92,7 +92,7 @@
<p>This document provide some informations when running Apache Stanbol in production mode.</p>
<ul>
<li>
-<p><a href="your-launcher.html">Create your launcher</a>: The Apache Stanbol stack does many things which results in a big launcher when all is included. Comming to production not all Stanbol features are needed and the requirement to get a "just what I need" come into play. This document give some pointers to get your own custom launcher configuration.</p>
+<p><a href="your-launcher.html">Create your launcher</a>: The Apache Stanbol stack does many things which results in a big launcher when all is included. Coming to production not all Stanbol features are needed and the requirement to get a "just what I need" come into play. This document give some pointers to get your own custom launcher configuration.</p>
</li>
<li>
<p><a href="file-bundle-configuration.html">Automatic bundle configuration</a>: Apache Stanbol is a highly configurable product, thanks to the Apache Felix system console and the underlying OSGi technology. But how to safely keep this configuration from old to new versions? How to get a configured server from the first launch? </p>