svn commit: r1357066 - /incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext

[rw...@apache.org]

Author: rwesten
Date: Wed Jul  4 04:33:12 2012
New Revision: 1357066

URL: http://svn.apache.org/viewvc?rev=1357066&view=rev
Log:
the Enhancement Structure section of the enhancer main docu page now correctly linkes to the documentation page of the Enhancement structure

Modified:
    incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.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=1357066&r1=1357065&r2=1357066&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 Wed Jul  4 04:33:12 2012
@@ -101,31 +101,15 @@ _Note that the "org.apache.stanbol.enhan
 <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.
+The enhancement structure for Apache Stanbol is been described [here](enhancementstructure.html) in full. It defines the types and properties used for the resulting metadata graph of the Stanbol Enhancer.
 
-_Note: The currently used Enhancement Structure was defined before the incubation to Apache. There is a proposal and ongoing discussion to update this structure in the future however the decision was to keep the current Structure until a first Release._
+The enhancement structure defines three main types of Annotations:
 
-Each enhancement type description which contains the following important properties:
+* [TextAnnotaitons](enhancementstructure.html#fisetextannotation) - describing the occurrence of an extracted feature within the parsed text.
+* [EntityAnnotaitons](enhancementstructure.html#fiseentityannotation) - suggesting an entity for an mention within the text (e.g. [dbpedia:International_Monetary_Fund](http://dbpedia.org/resource/International_Monetary_Fund) for the mention "IMF" in the analyzed Text). In that case the mention would be represented by a TextAnnotation.
+* [TopicAnnotaitons](enhancementstructure.html#fisetopicannotation) - for assigning the parsed document (or parts of the document) to topics and categories.
 
-* creator: the specific enhancement engine creating this enhancement
-* creation time: the local system time, when the annotation was created
-* extracted-from: the content item for the enhancement. This links to the ID of the content item as assigned by Apache Stanbol.
-* type: the type of the enhancement (e.g. Location, Person, Location, Concept ...).
-* confidence: The level of confidence in the range from 0 to 1 
-
-A text annotation type provides metadata for the selected text. This is intended to be used in addition to the enhancement type if an enhancement is based on a part of the content.
-
-* start: the character position of the start of the selection. If start is not defined it is assumed, that the selection starts at the beginning of the document
-* end: the character position of the end of the selection. If end is not defined it is assumed, that the selection ends at the end of the document.
-* selected-text: The text selected by the enhancement. (optional).
-* selection-context: The context of the selected text. This adds the possibility to specify the context used to extract entities such as persons, organizations, locations ... from natural language documents.
-
-The entity annotation type refers to named entities which have been recognized within the content. This type is intended to be used together with the FISE enhancement type.
-
-* entity-reference: This refers to the URI identifying the Entity
-* 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.
+In addition all annotations created by the Stanbol Enhancer do also provide additional meta information defined by the [Enhancement](enhancementstructure.html#fiseenhancement) class.
 
 <a name="List_of_Engines"></a>
 ## List of Available Enhancement Engines