Author: rwesten
Date: Wed May 30 08:02:07 2012
New Revision: 1344139
URL: http://svn.apache.org/viewvc?rev=1344139&view=rev
Log:
restructuring of the Doc
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext?rev=1344139&r1=1344138&r2=1344139&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext
Wed May 30 08:02:07 2012
@@ -13,9 +13,12 @@ Its two main purposes are to facilitate
The last section of this document provides a more detailed look at those
usage scenarios.
-This document first specifies the Enhancement Structure consisting of the
Ontology as well as additional rules [EnhancementEngine](engines)s need to
consider when writing Enhancement. In the second part this document focuses
more on the consumption of Enhancements by users of the Stanbol Enhancer.
+This document follows a similar structure. While the first part goes into the
detail of the Stanbol Enhancement Structure as integral part of the Stanbol
Enhancer the second part focuses on the consumption of the EnhancementResults.
-## Overview
+While the first part is intended to be read by Developers that want to extend
the Stanbol Enhancer (e.g. implement there own [EnhancementEngine](engines)s)
the target audience of the second part are typical users of the Stanbol
Enhancer.
+
+---
+# PART 1: The Stanbol Enhancement Structure
The Stanbol Enhancement Structure is a central part of the [Stanbol
Enhancer](index.html) architecture as it represents the binding element between
the [ContentItem](contentitem.html) analyzed by the the
[EnhancementEngine](engines)s as configured by an [EnhancementChain](chains).
Together with the [ContentParts](content item.html#content-parts) it represents
the state that is constantly updated during the enhancement process.
@@ -131,3 +134,7 @@ TopicAnnotation are used to categorize/c
* __entityhub:site__ (optional, single)_: The name of the Entityhub
ReferencedSite managing the the suggested Entity. If this property is present
users can dereference the suggested Entity with a GET request to
"{stanbol}/entityhub/site/{site-name}/entity?id={entity}" where {site-name} is
the value of this property and {entity} is the value of the
"fise:entity-reference" property.
NOTE: the values "local" and "entityhub" need to be treated separately. In
those cases the GET request need to use
"{stanbol}/entityhub/entity?id={entity}".
+---
+# Part 2: Using the Stanbol Enhancement Structure
+
+TODO: Work in progress
\ No newline at end of file
