Author: buildbot
Date: Mon Dec 5 18:00:35 2011
New Revision: 799739
Log:
Staging update by buildbot
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/building.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/tutorial.html
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/building.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/building.html
(original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/building.html Mon
Dec 5 18:00:35 2011
@@ -71,7 +71,10 @@
<li>the <em>"kres launcher"</em> activates the rules machinery only.</li>
</ul>
<p>You can launch the server with:</p>
-<p><code>$ java -Xmx1g -jar
full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar</code></p>
+<div class="codehilite"><pre><span class="nv">$</span> <span
class="nv">java</span> <span class="o">-</span><span class="n">Xmx1g</span>
<span class="o">-</span><span class="n">jar</span> <span
class="n">full</span><span class="sr">/target/o</span><span
class="n">rg</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">stanbol</span><span class="o">.</span><span
class="n">launchers</span><span class="o">.</span><span
class="n">full</span><span class="o">-</span><span class="mf">0.9</span><span
class="o">-</span><span class="n">SNAPSHOT</span><span class="o">.</span><span
class="n">jar</span>
+</pre></div>
+
+
<p>Your instance is then available on <a
href="http://localhost:8080";>http://localhost:8080</a>. You may change the
default
port number by passing a <code>-p 9090</code> options to the commandline
launcher. Use <code>-h</code>
to see more options.</p>
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/tutorial.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/tutorial.html
(original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/tutorial.html Mon
Dec 5 18:00:35 2011
@@ -51,8 +51,68 @@
<div id="content">
<h1 class="title">1 minute tutorial for Apache Stanbol</h1>
- <p>(link 5 minutes tutorial)
-(link 30 minutes tutorial)</p>
+ <p>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.</p>
+<h2 id="build_and_run_your_stanbol">Build and run your Stanbol</h2>
+<p>To build Stanbol from source you need Java 6 and maven 2.2.1 + (version as
defined in the pom). You probably need also: <br />
+</p>
+<div class="codehilite"><pre><span class="c">% export
MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M</span>
+</pre></div>
+
+
+<p>Fetch the sources from the Apache code repository</p>
+<div class="codehilite"><pre><span class="c">% svn co
http://svn.apache.org/repos/asf/incubator/stanbol/trunk stanbol</span>
+</pre></div>
+
+
+<p>From the source directory run</p>
+<div class="codehilite"><pre><span class="c">% mvn clean install</span>
+</pre></div>
+
+
+<p>Run the stable launcher of Stanbol from your local server machine from the
your local directory</p>
+<div class="codehilite"><pre><span class="p">{</span><span
class="n">root</span><span class="p">}</span><span
class="sr">/stanbol/</span><span class="n">launchers</span><span
class="o">/</span>
+
+<span class="n">with</span>
+
+<span class="nv">%</span> <span class="nv">java</span> <span
class="o">-</span><span class="n">Xmx512k</span> <span class="o">-</span><span
class="n">jar</span> <span class="n">stable</span><span
class="sr">/target/o</span><span class="n">rg</span><span
class="o">.</span><span class="n">apache</span><span class="o">.</span><span
class="n">stanbol</span><span class="o">.</span><span
class="n">launchers</span><span class="o">.</span><span
class="n">stable</span><span class="o">-</span><span class="p">{</span><span
class="n">snapshot</span><span class="o">-</span><span
class="n">version</span><span class="p">}</span><span class="o">-</span><span
class="n">SNAPSHOT</span><span class="o">.</span><span class="n">jar</span>
+</pre></div>
+
+
+<p>Your instance runs within the <code>stanbol/sling/</code> directory and is
accessible at</p>
+<div class="codehilite"><pre><span class="n">http:</span><span
class="sr">//</span><span class="n">localhost:8080</span>
+</pre></div>
+
+
+<h2 id="post_textual_content_get_enhancement_graph">Post textual content, get
enhancement graph</h2>
+<p>Goto the HTTP web endpoint</p>
+<div class="codehilite"><pre><span class="n">http:</span><span
class="sr">//</span><span class="n">localhost:8080</span><span
class="o">/</span><span class="n">engines</span>
+</pre></div>
+
+
+<p>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.</p>
+<p>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. </p>
+<div class="codehilite"><pre><span class="c">% curl -X POST -H "Accept:
text/turtle" -H "Content-type: text/plain" \</span>
+ <span class="o">--</span><span class="n">data</span> "<span
class="n">John</span> <span class="n">Smith</span> <span class="n">was</span>
<span class="n">born</span> <span class="n">in</span> <span
class="n">London</span><span class="p">.</span>" <span
class="n">http</span><span class="p">:</span><span class="o">//</span><span
class="n">localhost</span><span class="p">:</span>8080<span
class="o">/</span><span class="n">engines</span>
+</pre></div>
+
+
+<p>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.</p>
+<h2 id="need_more_features">Need more features?</h2>
+<p>The default configuration is based on two active Enhancement Engines, first
the <strong>NamedEntityExtractionEnhancementEngine</strong> which finds
occurrences of named entities such as people, places and organisations, and the
<strong>NamedEntityTaggingEngine</strong> which suggests links to an entity
repository, in this case to DBpedia entities. It is restricted to English
content and to plain text format.</p>
+<h3 id="configuring_enhancement_engines">Configuring enhancement engines</h3>
+<p>You may use the <a href="http://localhost:8080/";>OSGI console
(http://{yourdomain}:{port}/)</a> (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. <em>Overview on Stanbol <a href="engines.html">Enhancement
Engines</a></em></p>
+<h3 id="working_with_local_andor_custom_entities">Working with local and/or
custom entities</h3>
+<p>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. <em>See the scenario on <a
href="customvocabulary.html">using custom vocabularies</a></em></p>
+<h3 id="explore_stanbol_full_launcher">Explore Stanbol "full" launcher</h3>
+<p>The full features of Apache Stanbol can be accessed via the "full launcher"
of the software.</p>
+<div class="codehilite"><pre><span class="c">% java -Xmx512k -jar
full/target/org.apache.stanbol.launchers.full-{snapshot-version}-SNAPSHOT.jar</span>
+</pre></div>
+
+
+<p><em>See the overview on all available <a
href="components.html">components</a>.</em></p>
+<hr />
+<p>TODO (link 5 minutes tutorial)</p>
+<p>TODO (link 30 minutes tutorial)</p>
</div>
<div id="footer">
