Author: agruber
Date: Wed Feb 22 18:00:31 2012
New Revision: 1292426
URL: http://svn.apache.org/viewvc?rev=1292426&view=rev
Log:
Updated tutorial to new enhancer
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext?rev=1292426&r1=1292425&r2=1292426&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext Wed
Feb 22 18:00:31 2012
@@ -1,6 +1,6 @@
-Title: One Minute Tutorial for Apache Stanbol
+Title: Tutorial for Apache Stanbol - Enhancing content items
-This tutorial targets at content management system (CMS) developers, who want
to enrich unstructured textual content with "named entity" tags (locations,
persons or organizations such as "Paris", "Barack Obama", "BBC"). Apache
Stanbol can provide such enhancements together with links to public (e.g.
DBpedia) or private (e.g. an enterprise specific terminology) repositories.
+This tutorial targets at content management system developers, who want to
enrich unstructured textual content with "named entity" tags (locations,
persons or organizations such as "Paris", "Barack Obama", "BBC"). Apache
Stanbol can provide such enhancements together with links to public (e.g.
DBpedia) or private (e.g. an enterprise specific terminology) repositories.
## Build and run your Apache Stanbol instance
@@ -16,52 +16,51 @@ From the source directory run
% mvn clean install
-Run the stable launcher of Apache Stanbol from your local server machine from
the your local directory
+Run the stable launcher of Apache Stanbol from your local server machine from
the your local directory <code>{root}/stanbol/launchers/</code> with
- {root}/stanbol/launchers/
-
- with
-
- % java -Xmx1g -jar
stable/target/org.apache.stanbol.launchers.stable-{snapshot-version}-SNAPSHOT.jar
+ % java -Xmx1g -jar
stable/target/org.apache.stanbol.launchers.stable-{snapshot-version}-SNAPSHOT.jar
+
Your instance runs within the <code>stanbol/sling/</code> directory and is
accessible at
http://localhost:8080
-## Post textual content, get enhancement graph
+## Post content item, get an enhancement graph
Goto the local HTTP web endpoint
- http://localhost:8080/engines
+ http://localhost:8080/enhancer
This stateless interface allows the caller to submit content to the Apache
Stanbol enhancer engines and get the resulting enhancements formatted as RDF at
once without storing anything on the server-side.
-Simply copy arbitrary textual content into the input field _or_ to work with
the REST interface directly, you may also post a text with cURL command below.
The content to analyze should be sent in a POST request with the mimetype
specified in the Content-type header. The response will hold the RDF
enhancement serialized in the format specified in the Accept header.
+Simply copy arbitrary english textual content into the input field and get
back the enhancements for Bob Marley and Paris together with the enhancement
graph. If you want to work with the REST interface directly, you may also post
the text with the cURL command below. The resulting enhancement RDF will be in
turtle notation.
+
% curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" \
- --data "John Smith was born in London."
http://localhost:8080/engines
+ --data "The Stanbol enhancer can detect famous cities such as
Paris and people such as Bob Marley." \
+ http://localhost:8080/enhancer
-By using the HTTP web interface, you will get back the enhancements for John
Smith and London as well as the full enhancement RDF graph in a notation you
select. The cURL will result in the enhancement graph in turtle notation.
## Configuration
-The default configuration is based on two active Enhancement Engines, first
the __NamedEntityExtractionEnhancementEngine__ which finds occurrences of named
entities such as people, places and organisations, and the
__NamedEntityTaggingEngine__ which suggests links to an entity repository, in
this case to DBpedia entities. It is restricted to English content and to plain
text format.
+The "default" enhancement chain includes the following, by default active
Enhancement Engines:
-### Additional enhancement engines
-You may use the [OSGI console
(http://{yourdomain}:{port}/)](http://localhost:8080/) (user/pwd: admin/admin)
of your running Stanbol instance to activate and configure additional engines
in order to get language detection, support for multiple document formats and
some additional language support. Additional engines provide support for
geonames, zemanta or opencalais. We have put together an overview of available
Apache Stanbol [Enhancement Engines](engines/list.html).
+* one engine for conversions from various document formats to plain text
+* one for detection of the language of the text,
+* one for named entity extractions from the content item and
+* one engine configured to link the extracted entities to DBpedia entities.
+You can use the [OSGI console
(http://{yourdomain}:{port}/)](http://localhost:8080/) (user/pwd: admin/admin)
of your running Stanbol instance to activate and configure additional engines.
Additional engines provide support keyword extraction together with a better
language support, for geonames, zemanta or opencalais. See the overview of
available Apache Stanbol [Enhancement Engines](enhancer/engines/list.html).
-### Working with local and/or custom entities
-Another feature of Apache Stanbol is to manage and cache external entity
repositories such as DBpedia locally as well as the possibility to use custom
vocabularies as linking target repositories.
+Another feature of this Apache Stanbol version is to manage and locally cache
external entity repositories such as DBpedia as well as the possibility to use
custom vocabularies as linking target repositories. Read more about this
scenario [using custom vocabularies](customvocabulary.html).
-Read more about the scenario of [using custom
vocabularies](customvocabulary.html).
+## Advanced: Explore Apache Stanbol "full" launcher
-### Explore Apache Stanbol "full" launcher
+The full (including experimental) features of Apache Stanbol can be accessed
via Apache Stanbol's "full launcher". See the [list of all available
components](components.html) and their features.
-The full (including experimental) features of Apache Stanbol can be accessed
via Apache Stanbol's "full launcher". To start the full launcher, you just have
to executes its JAR via the following Java command.
+To start the full launcher, you just have to execute its JAR via the following
command:
% java -Xmx1g -jar
full/target/org.apache.stanbol.launchers.full-{snapshot-version}-SNAPSHOT.jar
-See the overview of all available [components](components.html).
