svn commit: r805173 - in /websites/staging/stanbol/trunk: ./ content/stanbol/docs/trunk/enhancer/enhancerrest.html

[bu...@apache.org]

Author: buildbot
Date: Fri Feb 17 11:17:09 2012
New Revision: 805173

Log:
Staging update by buildbot for stanbol

Modified:
    websites/staging/stanbol/trunk/   (props changed)
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancerrest.html

Propchange: websites/staging/stanbol/trunk/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Feb 17 11:17:09 2012
@@ -1 +1 @@
-1245393
+1245395

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 Fri Feb 17 11:17:09 2012
@@ -20,7 +20,7 @@
 -->
 
   <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
-  <title>Apache Stanbol - Stanbol Enhancer RESTful API</title>
+  <title>Apache Stanbol - Stanbol Enhancer RESTful Services</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"/>
 </head>
@@ -56,7 +56,7 @@
   </div>
   
   <div id="content">
-    <h1 class="title">Stanbol Enhancer RESTful API</h1>
+    <h1 class="title">Stanbol Enhancer RESTful Services</h1>
     <p>The RESTful service endpoint provided by the Stanbol Enhancer is a stateless interface that allows the caller to submit content and get the resulting enhancements formatted as RDF at once without storing anything on the server-side. More advanced options also allow to parse pre-existing metadata, parse and request alternate content versions and additional metadata created by the Enhancer or specific Enhancement Engines.</p>
 
 <p>The here described RESTful interface is provided on several Endpoints</p>
@@ -65,7 +65,7 @@
 <li><strong>'/enhancer/chain/{chain-name}'</strong>: The Stanbol Enhancer supports the configuration of multiple <a href="chains">Enhancement Chains</a>. Users can lookup active chains by requests to the 'enhancer/chain' endpoint.</li>
 <li><strong>'/engines':</strong> Same as '/enhancer' this ensures backward compatibility to older Stanbol versions.</li>
 </ul>
-<h2 id="enhancement_request">Enhancement Request</h2>
+<h2 id="basic_enhancement_service">Basic Enhancement Service</h2>
 <p>This sections describes how to parse Content to the Stanbol Enhancer that gets than analyzed. Results are sent back in the form of a serialized RDF graph.</p>
 <p>The content to analyze should be sent in a POST request with the mimetype specified in
 the <code>Content-type</code> header. The response will hold the RDF enhancement serialized in the format specified in the <code>Accept</code> header:</p>
@@ -84,7 +84,7 @@ text/rdf+nt (N-TRIPLES)
 </pre></div>
 
 
-<h3 id="additional_supported_queryparameters">Additional supported QueryParameters:</h3>
+<h3 id="additional_parameters">Additional Parameters:</h3>
 <ul>
 <li><strong>uri={content-item-uri}:</strong> By default the URI of the content item being enhanced is a local, non de-referencable URI automatically built out of a hash digest of the binary content. Sometimes it might be helpful to provide the URI of the <a href="contentitem.html">ContentItem</a> to be used in the enhancements RDF graph.</li>
 <li><strong>executionmetadata=true/false:</strong> Allows the include of <a href="executionmetadata.html">execution metadata</a> in the enhancement metadata of the response. Such data include also the <a href="chains/executionplan.html">execution plan</a> used to enhance the parsed content. This information is typically only useful to clients that want to know how the parsed content was processed by the enhancer. NOTE that the execution metadata can also be requested by using the multi-part content item API described below.</li>
@@ -98,8 +98,7 @@ In addition this request is directed to 
 
 
 <h2 id="multi-part_contentitem_support">Multi-part ContentItem support</h2>
-<p>The multi-part <code>ContentItem</code> extensions to the RESTful API (introduced by <a href="https://issues.apache.org/jira/browse/STANBOL-481">STANBOL-481</a>) are considered an advanced usage of the Stanbol Enhancer. </p>
-<p>Users will want to use this extensions if they need to:</p>
+<p>The multi-part <code>ContentItem</code> extensions to the basic RESTful services provided by the Stanbol Enhancer. It was introduced (by <a href="https://issues.apache.org/jira/browse/STANBOL-481">STANBOL-481</a>) to allow advanced usage scenarios. Users will want to use this extensions if they need to:</p>
 <ul>
 <li>parse multiple versions of the content: Most CMS already do have support for converting content to plain text. This API allows to parse both the original AND multiple transcoded versions of the content to the Enhancer.</li>
 <li>parse pre-existing metadata: Typically CMS do have already some metadata about content parsed to the Stanbol Enhancer (e.g. User provided Tags, Categories …). The multi-part extensions do allow to parse such data in addition to the content. </li>