You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by fc...@apache.org on 2012/06/26 09:54:39 UTC
svn commit: r1353849 - in /incubator/stanbol/site/trunk/content/stanbol:
docs/trunk/enhancer/index.mdtext downloads/releases.mdtext
Author: fchrist
Date: Tue Jun 26 07:54:38 2012
New Revision: 1353849
URL: http://svn.apache.org/viewvc?rev=1353849&view=rev
Log:
Improving navigation by adding anchors
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
incubator/stanbol/site/trunk/content/stanbol/downloads/releases.mdtext
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext?rev=1353849&r1=1353848&r2=1353849&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext Tue Jun 26 07:54:38 2012
@@ -1,14 +1,23 @@
Title: Apache Stanbol Enhancer
-The Apache Stanbol Enhancer provides both a RESTful and a Java API that allows a caller to extract features from passed content. In more detail the passed content is processed by [Enhancement Engines](engines) as defined by the called [Enhancement Chain](chains).
+The Apache Stanbol Enhancer provides both a [RESTful](#RESTful_API) and a [Java API](#Java_API) that allows a caller to extract features from passed content. In more detail the passed content is processed by [Enhancement Engines](engines) as defined by the called [Enhancement Chain](chains).
+* [Using the Stanbol Enhancer](#Using_Stanbol_Enhancer)
+ * [RESTful](#RESTful_API)
+ * [Java API](#Java_API)
+ * [Main Interfaces and Utility Classes](#Main_Interfaces_and_Utility_Classes)
+ * [Enhancement Structure](#Enhancement_Structure)
+* [List of Available Enhancement Engines](#List_of_Engines)
+
+<a name="Using_Stanbol_Enhancer"></a>
## Using the Stanbol Enhancer
The figure below provides an overview of the RESTful as well as the Java API provided by the Stanbol Enhancer
-### RESTful service
+<a name="RESTful_API"></a>
+### RESTful API
The content to be analyzed should be sent in a POST request with the mime-type specified in the Content-type header. The response will hold the RDF enhancement serialized in the format specified in the Accept header:
@@ -29,6 +38,7 @@ The RESTful interface also provides para
For detailed information please see the documentation of the [Stanbol Enhancer RESTful Services](enhancerrest.html). A short version is also provided under the REST API link of the Stanbol Web UI (e.g. [http://localhost:8080/enhancer](http://localhost:8080/enhancer) assuming that Apache Stanbol runs on localhost:8080).
+<a name="Java_API"></a>
### Java API
The usage of the Java API requires the following OSGI Services
@@ -72,12 +82,8 @@ After the enhancement process, ContentIt
textContentPart.getValue().getStream(),
charset == null ? "UTF-8" : charset);
-
-## List of Available Enhancement Engines
-
-Apache Stanbol comes with a [list of enhancement engines implementations](engines/list.html). These engines are supported by the Apache Stanbol community. If you would like to implement your own enhancement engine, you should go on reading this documentation.
-
-## Main Interfaces and Utilities
+<a name="Main_Interfaces_and_Utility_Classes"></a>
+#### Main Interfaces and Utility Classes
* __ContentItem__: A [content item](contentitem.html) is the unit of content the Stanbol Enhancer can deal with. It gives access to the binary content that was registered, and the graph that represents its metadata (provided by client and/or generated). ContentItems are created by using the [ContentItemFactory](contentitemfactory.html).
* __EnhancementEngine__: The [enhancement engine](engines) provides the interface to internal or external semantic enhancement engines. Typically content items will be processed by several enhancement engines.
@@ -88,8 +94,8 @@ Apache Stanbol comes with a [list of enh
_Note that the "org.apache.stanbol.enhancer.servicesapi" module also provides a set of "**Helper" utility classes (e.g. ContentItemHelper, EnhancementEngineHelper â¦). It is highly recommended for users to use the functionality provided by such helpers when working with the according classes of the Stanbol Enhancer._
-
-## Enhancement Structure
+<a name="Enhancement_Structure"></a>
+### Enhancement Structure
The enhancement structure for Apache Stanbol is been described [here](http://wiki.iks-project.eu/index.php/EnhancementStructure) in full. It defines the types and properties used for the resulting metadata graph of Apache Stanbol.
@@ -116,3 +122,8 @@ The entity annotation type refers to nam
* entity-label: The label(s) of the referred entity
* entity-type: This property can be used to specify the type of the entity (optional)
* The occurrences of the entity within the content (the exact positions within the text where this entity is referred) are determined by outgoing dc:relation links.
+
+<a name="List_of_Engines"></a>
+## List of Available Enhancement Engines
+
+Apache Stanbol comes with a [list of enhancement engines implementations](engines/list.html). These engines are supported by the Apache Stanbol community. If you would like to implement your own enhancement engine, you should go on reading this documentation.
\ No newline at end of file
Modified: incubator/stanbol/site/trunk/content/stanbol/downloads/releases.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/downloads/releases.mdtext?rev=1353849&r1=1353848&r2=1353849&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/downloads/releases.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/downloads/releases.mdtext Tue Jun 26 07:54:38 2012
@@ -1,4 +1,4 @@
-Title: Releases
+Title: Source Releases
To get the latest development release of Apache Stanbol, you can check out the
source code and build Apache Stanbol yourself. Otherwise, the source releases below are