Author: agruber
Date: Mon Dec 5 18:00:07 2011
New Revision: 1210546
URL: http://svn.apache.org/viewvc?rev=1210546&view=rev
Log:
Created the 1min tutorial contents ... STANBOL-402
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext?rev=1210546&r1=1210545&r2=1210546&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext Mon
Dec 5 18:00:07 2011
@@ -24,7 +24,7 @@ Now, several launchers should be availab
You can launch the server with:
-<code>$ java -Xmx1g -jar
full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar</code>
+ $ java -Xmx1g -jar
full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar
Your instance is then available on <http://localhost:8080>. You may change
the default
port number by passing a `-p 9090` options to the commandline launcher. Use
<code>-h</code>
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=1210546&r1=1210545&r2=1210546&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext Mon
Dec 5 18:00:07 2011
@@ -1,14 +1,70 @@
Title: 1 minute tutorial for Apache Stanbol
+This tutorial targets at CMS developers, who want to enrich unstructured
textual content with "named entity" tags (locations, persons or organizations
such as "Paris", "Barack Obama", "BBC"). They will get such enhancements
together with links to public (e.g. DBpedia) or private (e.g. an enterprise
specific terminology) repositories.
+## Build and run your Stanbol
+To build Stanbol from source you need Java 6 and maven 2.2.1 + (version as
defined in the pom). You probably need also:
+ % export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M
+Fetch the sources from the Apache code repository
+ % svn co http://svn.apache.org/repos/asf/incubator/stanbol/trunk
stanbol
+From the source directory run
+ % mvn clean install
+Run the stable launcher of Stanbol from your local server machine from the
your local directory
+ {root}/stanbol/launchers/
-(link 5 minutes tutorial)
-(link 30 minutes tutorial)
\ No newline at end of file
+ with
+
+ % java -Xmx512k -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
+
+Goto the HTTP web endpoint
+
+ http://localhost:8080/engines
+
+This stateless interface allows the caller to submit content to the 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.
+
+ % curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" \
+ --data "John Smith was born in London."
http://localhost:8080/engines
+
+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.
+
+
+## Need more features?
+
+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.
+
+### Configuring 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. _Overview on Stanbol [Enhancement
Engines](engines.html)_
+
+
+### Working with local and/or custom entities
+Another feature of 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. _See the scenario on [using custom
vocabularies](customvocabulary.html)_
+
+
+### Explore Stanbol "full" launcher
+The full features of Apache Stanbol can be accessed via the "full launcher" of
the software.
+
+ % java -Xmx512k -jar
full/target/org.apache.stanbol.launchers.full-{snapshot-version}-SNAPSHOT.jar
+
+_See the overview on all available [components](components.html)._
+
+----
+
+TODO (link 5 minutes tutorial)
+
+TODO (link 30 minutes tutorial)
\ No newline at end of file
