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/02/15 17:55:59 UTC
svn commit: r804925 - in /websites/staging/stanbol/trunk: ./
content/stanbol/css/stanbol.css
content/stanbol/docs/trunk/enhancer/enhanceroverview-s.png
content/stanbol/docs/trunk/enhancer/index.html
Author: buildbot
Date: Wed Feb 15 16:55:59 2012
New Revision: 804925
Log:
Staging update by buildbot for stanbol
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhanceroverview-s.png (with props)
Modified:
websites/staging/stanbol/trunk/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/css/stanbol.css
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html
Propchange: websites/staging/stanbol/trunk/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Feb 15 16:55:59 2012
@@ -1 +1 @@
-1244435
+1244590
Modified: websites/staging/stanbol/trunk/content/stanbol/css/stanbol.css
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/css/stanbol.css (original)
+++ websites/staging/stanbol/trunk/content/stanbol/css/stanbol.css Wed Feb 15 16:55:59 2012
@@ -20,7 +20,7 @@ h1,h2,h3,h4,h5,h6 {
@media screen
{
#content {
- margin: 30px 50px 100px 250px;
+ margin: 30px 50px 10px 250px;
padding: 0 30px 40px;
background-color: #fff;
}
@@ -41,6 +41,9 @@ h1,h2,h3,h4,h5,h6 {
#navigation {
display: none;
}
+ #footer {
+ background-color: #fff;
+ }
}
#content h1,h2,h3,h4,h5,h6 {
color: #6f3f00;
@@ -111,7 +114,7 @@ h1,h2,h3,h4,h5,h6 {
background-color:#404040;
color:#717171;
font-size: 80%;
- margin: 0 100px 0 300px;
+ margin: 0 50px 0 250px;
padding: 10px 30px;
}
Added: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhanceroverview-s.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhanceroverview-s.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
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 Feb 15 16:55:59 2012
@@ -60,15 +60,23 @@
<p>The Apache Stanbol Enhancer provides both a RESTful and a Java API that allows caller to Extract features from parsed Content. In more detail the parsed Content is processed by <a href="engines">Enhancement Engines</a> as defined by the called <a href="chains/enhancementchain.html">Enhancement Chain</a>.</p>
<h2 id="using_the_stanbol_enhancer">Using the Stanbol Enhancer</h2>
<p>The following figure provides an overview about the RESTful as well as the Java API provided by the Stanbol Enhancer</p>
-<p><img alt="Stanbol Enhancer Overview" src="enhanceroverview.png" title="Overview about the RESTful Services and Java API provided by the Stanbol Enhancer" /></p>
+<p><img alt="Stanbol Enhancer Overview" src="enhanceroverview-s.png" title="Overview about the RESTful Services and Java API provided by the Stanbol Enhancer" /></p>
<h3 id="restful_service">RESTful service:</h3>
<p>The content to analyze should be sent in a POST request with the mimetype specified in the Content-type header. The response will hold the RDF enhancement serialized in the format specified in the Accept header:</p>
<div class="codehilite"><pre><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">data</span> <span class="s">"John Smith was born in London."</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="o">--</span><span class="n">data</span> <span class="s">"John Smith was born in London."</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>
</pre></div>
-<p>See the documentation provided by the Stanbol Web UI (e.g. "http://localhost:8080/enhancer" assuming that Apache Stanbol runs on localhost:8080)</p>
+<p>The RESTful interface also provides parameters that can be used to parse/request additional informations. The following Example shows a request that would answer with the plain/text version of the parsed HTML content</p>
+<div class="codehilite"><pre>curl -v -X POST -H "Accept: text/plain" \
+ -H "Content-type: text/html; charset=UTF-8" \
+ --data "<span class="nt"><html><body><p></span>John Smith was born in London.<span class="nt"></p></body></html></span>" \
+ "http://localhost:8080/enhancer/chain/language?omitMetadata=true"
+</pre></div>
+
+
+<p>For detailed information please see the documentation provided by the Stanbol Web UI (e.g. <a href="http://localhost:8080/enhancer">http://localhost:8080/enhancer</a> assuming that Apache Stanbol runs on localhost:8080).</p>
<h3 id="java_api">Java API:</h3>
<p>The usage of the Java API requires the following OSGI Services</p>
<div class="codehilite"><pre><span class="nv">@Reference</span>
@@ -78,7 +86,7 @@
</pre></div>
-<p>Provided this service are available the following code snippet shows how to enhance a Content</p>
+<p>This code snipped shows how to enhance a HTML document</p>
<div class="codehilite"><pre><span class="n">InputStream</span> <span class="n">content</span><span class="p">;</span> <span class="sr">//</span><span class="n">the</span> <span class="n">content</span> <span class="p">(</span><span class="n">assuming</span> <span class="n">an</span> <span class="n">HTML</span> <span class="n">document</span><span class="p">)</span>
<span class="n">String</span> <span class="n">chainName</span><span class="p">;</span> <span class="sr">//</span><span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">the</span> <span class="n">chain</span> <span class="ow">or</span> <span class="n">null</span> <span class="n">to</span> <span class="k">use</span> <span class="n">the</span> <span class="n">default</span>
<span class="n">ContentItem</span> <span class="n">contentItem</span> <span class="o">=</span> <span class="k">new</span> <span class="n">InMemoryContentItem</span><span class="p">(</span>
@@ -99,7 +107,7 @@
</pre></div>
-<p>However the ContentIem may - depending on the executed <a href="engines">Enhancement Engines</a> also provide additional information. This shows how to retrieve the text version of the parsed HTML content.</p>
+<p>After the enhancement process finishes ContentIems do not only contain the metadata but also other informations such as converted versions of the parsed content. The following code snippet shows how to retrieve the text version of the parsed HTML content such as created by the <a href="engines/metaxaengine.html">Metaxa Engine</a>.</p>
<div class="codehilite"><pre><span class="n">Entry</span><span class="sr"><UriRef,Blob></span> <span class="n">textContentPart</span> <span class="o">=</span>
<span class="n">ContentItemHelper</span><span class="o">.</span><span class="n">getBlob</span><span class="p">(</span><span class="n">contentItem</span><span class="p">,</span>
<span class="n">Collections</span><span class="o">.</span><span class="n">singleton</span><span class="p">(</span><span class="s">"text/plain"</span><span class="p">));</span>