svn commit: r1353526 - in /incubator/stanbol/site/trunk/content/stanbol/docs/trunk: contentenhancement.mdtext enhancementusage.mdtext index.mdtext scenarios.mdtext

[fc...@apache.org]

Author: fchrist
Date: Mon Jun 25 13:26:04 2012
New Revision: 1353526

URL: http://svn.apache.org/viewvc?rev=1353526&view=rev
Log:
Reviewed basic enhancement and added links

Modified:
    incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext
    incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancementusage.mdtext
    incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
    incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext

Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext?rev=1353526&r1=1353525&r2=1353526&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext Mon Jun 25 13:26:04 2012
@@ -1,8 +1,8 @@
-Title: Using Apache Stanbol for enhancing textual content
+Title: Basic Content Enhancement
 
-For enhancing content you simply post plain text content to the Enhancement Engines and you will get back enhancement data. The enhancement process is stateless, so neither your content item, nor the enhancements will be stored. 
+For enhancing content you simply post plain text content to the enhancement engines and you will get back enhancement data. The enhancement process is stateless, so neither your content item, nor the enhancements will be stored. 
 
-You can test this via the [Web interface](http://localhost:8080/enhancer) of the Stanbol Enhancer - http://{host}:{port}/enhancer or from the console using the CURL command.
+You can test this via the [Web interface](http://localhost:8080/enhancer) of the Apache Stanbol Enhancer - http://{host}:{port}/enhancer or from the console using the CURL command.
 
     :::bash
     curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" \
@@ -17,43 +17,43 @@ The following script sends the contents 
             -T $file http://localhost:8080/enhancer;
     done
 
-The Stanbol Enhancer can also enhancer non-plain-text files. In this case [Apache Tika](http://tika.apache.org) - via the [Tika Engine](enhancer/engines/tikaengine.html) is used to extract the plain text from those files (see the [Apache Tika](http://tika.apache.org) documentation for supported file formats).
+The Apache Stanbol Enhancer can also enhancer non-plain-text files. In this case [Apache Tika](http://tika.apache.org) - via the [Tika Engine](enhancer/engines/tikaengine.html) is used to extract the plain text from those files (see the [Apache Tika](http://tika.apache.org) documentation for supported file formats).
 
 ## Configuring and Using Enhancement Chains
 
-The Stanbol Enhancer supports multiple [Enhancement Chains](enhancer/chains). This feature allows to configure use multiple processing chains for parsed content within the same Stanbol Instance.
+The Apache Stanbol Enhancer supports multiple [enhancement chains](enhancer/chains). This feature allows to configure use multiple processing chains for parsed content within the same Apache Stanbol instance.
 
-Chains are build based on an [Execution Plan](enhancer/chains/executionpla.html) referencing one or more [Enhancement Engines](enhancer/engines) by there name. Users can create and modify EnhancementChains by using the [Configuration Tab](http://localhost:8080/system/console/configMgr) of the Apache Felix Webconsole - http://{host}:{port}/system/console/configMgr. There are three different implementations: (1) the self sorting [Weighted Chain](enhancer/chains/weightedchain.html), (2) the [List Chain](enhancer/chains/listchain.html) and (3) the [Graph Chain](enhancer/chains/graphchain.html) that allows the direct configuration of the execution graph. There is also a (4) [Default Chain](enhancer/chains/defaultchain.html) that includes all currently active Enhancement Engines. While this engine is enabled by default most users might want to deactivate it as soon as they have configured there own chains.
+Chains are build based on an [execution plan](enhancer/chains/executionpla.html) referencing one or more [enhancement engines](enhancer/engines) by there name. Users can create and modify enhancement chains by using the [Configuration Tab](http://localhost:8080/system/console/configMgr) of the Apache Felix web console - http://{host}:{port}/system/console/configMgr. There are three different implementations: (1) the self sorting [weighted chain](enhancer/chains/weightedchain.html), (2) the [list chain](enhancer/chains/listchain.html) and (3) the [graph chain](enhancer/chains/graphchain.html) that allows the direct configuration of the execution graph. There is also a (4) [default chain](enhancer/chains/defaultchain.html) that includes all currently active enhancement engines. While this engine is enabled by default most users might want to deactivate it as soon as they have configured there own chains.
 
-To configure Enhancement Engine it is essential to understand the intension of the different [Enhancement Engine](enhancer/engines) implementations. The [List of all Enhancement Engines](enhancer/engines/list.html) managed by the Apache Stanbol Community is available [here](enhancer/engines/list.html). See the documentation of the listed Engines for detailed information.
+To configure enhancement engines it is essential to understand the intension of the different [enhancement engine](enhancer/engines) implementations. The [list of available enhancement engines](enhancer/engines/list.html) managed by the Apache Stanbol community is available [here](enhancer/engines/list.html). See the documentation of the listed engines for detailed information.
 
-The list groups engines by categories: Preprocessing Engines_ typically perform operations on a content scope. This includes plain-text extraction, metadata extraction, language detection. This is followed by Engines that analyses the parsed content. This category currently includes all Natural Language Processing related engines but also would include Image-, Audio- and Viedo- processing. The third category consist of Engines that consume extracted features from the content and perform some kind of semantic lifting on it - e.g. linking extracted features with Entities/Concepts contained in Controlled Vocabularies. Finally Post-Processing Engines can be used to adjust rankings, filter out unwanted enhancements or do other kind of transformations on the Enhancement results.
+The list groups engines by categories: Preprocessing engines typically perform operations on a content scope. This includes plain-text extraction, metadata extraction, language detection. This is followed by engines that analyses the parsed content. This category currently includes all Natural Language Processing (NLP) related engines but also would include image-, audio- and video- processing. The third category consist of engines that consume extracted features from the content and perform some kind of semantic lifting on it - e.g. linking extracted features with entities/concepts contained in controlled vocabularies. Finally post-processing engines can be used to adjust rankings, filter out unwanted enhancements or do other kind of transformations on the enhancement results.
 
-A typical Text Processing Enhancement Chain might look like that:
+A typical text processing enhancement chain might look like that:
 
 * [tika](enhancer/engines/tikaengine.html) - to convert parsed content to "text/plain"
 * [langid](enhancer/engines/langidengine.html) - to detect the language of the parsed text
-* [ner](enhancer/engines/namedentityextractionengine.html) - to extract named entities (Persons, Organizations, Places) from the parsed text
-* [dbpediaLinking](enhancer/engines/namedentitytaggingengine.html) - link extracted named entities with Entities defined by [dbpedia.org](http://dbpedia.org)
-* [myCustomVocExtraction](enhancer/engines/keywordlinkingengine.html) - Keyword Extraction based on a custom built vocabulary - as described by this [usage scenario](customvocabulary.html).
+* [ner](enhancer/engines/namedentityextractionengine.html) - to extract named entities (persons, organizations, places) from the parsed text
+* [dbpediaLinking](enhancer/engines/namedentitytaggingengine.html) - link extracted named entities with entities defined by [dbpedia.org](http://dbpedia.org)
+* [myCustomVocExtraction](enhancer/engines/keywordlinkingengine.html) - keyword extraction based on a custom built vocabulary - as described by this [usage scenario](customvocabulary.html).
 
-An other Enhancement Chain using an External service
+And here is another enhancement chain using an external service
 
 * [tika](enhancer/engines/tikaengine.html) - assuming we want to send MS Word dokuments to Zemanta
-* [zemanta](enhancer/engines/zemantaengine.html) - this wraps [Zemanta.com/](http://www.zemanta.com/) as Stanbol Enhancement Engine
+* [zemanta](enhancer/engines/zemantaengine.html) - this wraps [Zemanta.com/](http://www.zemanta.com/) as an Apache Stanbol Enhancement Engine
 
-_Tips for configuring Enhancment Chains:_ 
+_Tips for configuring enhancment chains:_ 
 
 * [http://{host}:{port}/enhancer/chain](http://localhost:8080/enhancer/engine) provides a list of all configured [Enhancement Chains](enhancer/chains). It also includes direct links to their configurations.
 * As one needs to use the names of active [Enhancement Engines](enhancer/engines) for the configuration of Enhancement Chains it is very useful to open [http://{host}:{port}/enhancer/engine](http://localhost:8080/enhancer/engine) in an other browser window.
 
-After configuring all the Enhancement Engines and combining them to Enhancement Chains it is important to understand how to inspect and call the configured components via the RESTful API of the Stanbol Enhancer.
+After configuring all the enhancement engines and combining them to enhancement chains it is important to understand how to inspect and call the configured components via the RESTful API of the Apache Stanbol Enhancer.
 
 Enhancement requests directly issued to <code>/enhancer</code> (or the old deprecated <code>/engines</code>) endpoint are processed by using the Enhancement Chain with the name "default" or if none with that name the one with the highest "service.ranking" (see [here](enhancer/chains/#default-chain) for details). To process content with a specific chain requests need to be issued against <code>/enhancer/chain/{chain-name}</code>. 
 
-Note that it is also possible to enhance content by using a single [Enhancement Engine](enhancer/engines). For that request can be sent to <code>enhancer/engine/{engine-name}</code>. A typical example would be parsing text directly to the [Language Identification Engine](enhancer/engine/langidengine.html) to use the Stanbol Enhancer to detect the language of the parsed content.
+Note, that it is also possible to enhance content by using a single [enhancement engine](enhancer/engines). For that, request can be sent to <code>enhancer/engine/{engine-name}</code>. A typical example would be parsing text directly to the [Language Identification Engine](enhancer/engine/langidengine.html) to use the Apache Stanbol Enhancer to detect the language of the parsed content.
 
-To sum up the RESTful API of the Stanbol Enhancer is structured like follows
+To sum up the RESTful API of the Apache Stanbol Enhancer is structured like follows
 
     GET /enhancer - returns the configuration of the Stanbol Enhancer
     GET /enhancer/chain - returns the configuration of all active [Enhancement Chains](enhancer/chains)
@@ -62,11 +62,11 @@ To sum up the RESTful API of the Stanbol
     POST /enhancer/chain/{chain-name} - enhances parsed content by using the Enhancement Chain with the given name
     POST /enhancer/engine/{engine-name} - enhances parsed content by using only the referenced Enhancement Engine
 
-See the [Documentation](enhancer/enhancerrest.html) of the the RESTful API for all services and parameters of the Stanbol Enhancer.
+See the [documentation](enhancer/enhancerrest.html) of the the RESTful API for all services and parameters of the Apache Stanbol Enhancer.
 
-## Using an index of linked open data locally
+## Using a Local Index of a Linked Open Data Source
 
-Both the [Named Entity Tagging Engine](enhancer/engines/namedentitytaggingengine.html) and the [Keyword Linking Engine](enhancer/engines/keywordlinkingengine.html) require to be configured with a dataset containing Entities to link/extract for parsed content. As those Engines typically need to make a lot of requests against those datasets it is important to make those data locally available - a feature of the [Apache Stanbol Entityhub](entityhub)
+Both the [Named Entity Tagging Engine](enhancer/engines/namedentitytaggingengine.html) and the [Keyword Linking Engine](enhancer/engines/keywordlinkingengine.html) require to be configured with a dataset containing entities to link/extract for parsed content. As those engines typically need to make a lot of requests against those datasets it is important to make those data locally available - a feature of the [Apache Stanbol Entityhub](entityhub)
 
 Because of this Apache Stanbol allows to create/install local indexes of datasets. A detailed description on how to create those indexes is described by this [user scenario](customvocabulary.html). A set of pre-computed indexes can be downloaded from the [IKS development server](http://dev.iks-project.eu/downloads/stanbol-indices/).
 
@@ -88,4 +88,4 @@ _NOTE:_ In case of "dbpedia" the OSGI bu
 
 ## Processing the Enhancement Results
 
-The final step in using the Stanbol Enhancer is about processing the Enhancement Results. As this is a central part developers of client applications this is described by an own [Usage Scenario](enhancementusage.html)
\ No newline at end of file
+The final step in using the Apache Stanbol Enhancer is about processing the enhancement results. As this is a central part developers of client applications this is described in another [usage scenario](enhancementusage.html)
\ No newline at end of file

Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancementusage.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancementusage.mdtext?rev=1353526&r1=1353525&r2=1353526&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancementusage.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancementusage.mdtext Mon Jun 25 13:26:04 2012
@@ -1,4 +1,4 @@
-Title: Making use of Apache Stanbol enhancements
+Title: Making use of Apache Stanbol Enhancements
 
 This document describes how to implement client side, i.e. user interface components by using the [enhancement results](enhancer/engines/enhancementstructure.html) returned by the [Apachee Stanbol Enhancer](enhancer). It does so by using three different scenarios:
 

Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext?rev=1353526&r1=1353525&r2=1353526&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext Mon Jun 25 13:26:04 2012
@@ -4,6 +4,7 @@ This documentation of Apache Stanbol tar
 
 * [Usage Scenarios](scenarios.html)
 	* [Basic Content Enhancement](contentenhancement.html)
+	* [Making use of Apache Stanbol Enhancements](enhancementusage.html)
 	* [Working with Custom Vocabularies](customvocabulary.html)
 	* [Working with Multiple Languages](multilingual.html)
 * [Component Overview](components.html)

Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext?rev=1353526&r1=1353525&r2=1353526&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext Mon Jun 25 13:26:04 2012
@@ -8,17 +8,13 @@ Apache Stanbol is designed to bring sema
 The following usage scenarios explain in more detail how to use various services from a CMS.
 
 * [Basic Content Enhancement](contentenhancement.html): Analyze textual content, enhance with it with named entities (person, place, organization), suggest links to open data sources.
-
+* [Making use of Apache Stanbol Enhancements](enhancementusage.html) Describes how to work with enhancements provided by the Apache Stanbol Enhancer.
 * [Working with Custom Vocabularies](customvocabulary.html): Use locally defined entities (e.g. thesaurus concepts) from an organization's context.
-
 * [Working with Multiple Languages](multilingual.html): Get enhancements for textual content in multiple languages (EN, DE, SV, DA, PT and NL).
 
 * Semantic Search in Portals: Store/index enhancements and content items. For a portal this would facilitate semantic search applications.
- 
 * Refactoring Enhancements for SEO: Refactor the enhancement result, its property names and ontology types according your target ontology.
-
 * Transforming CMS repository structures into ontologies.
-
 * Provide repository structures as thesaurus or domain ontology, e.g. categories.
 
 -----------------------------------------------------------------------------