svn commit: r798029 - in /websites/production/stanbol: ./ content/stanbol/docs/trunk/index.html

[ag...@apache.org]

Author: agruber
Date: Fri Nov  4 09:10:19 2011
New Revision: 798029

Log:
added information on structure of documentation

Modified:
    websites/production/stanbol/   (props changed)
    websites/production/stanbol/content/stanbol/docs/trunk/index.html

Propchange: websites/production/stanbol/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Nov  4 09:10:19 2011
@@ -1 +1 @@
-/websites/staging/stanbol/trunk:779452-797547
+/websites/staging/stanbol/trunk:779452-798028

Modified: websites/production/stanbol/content/stanbol/docs/trunk/index.html
==============================================================================
--- websites/production/stanbol/content/stanbol/docs/trunk/index.html (original)
+++ websites/production/stanbol/content/stanbol/docs/trunk/index.html Fri Nov  4 09:10:19 2011
@@ -46,9 +46,21 @@
   
   <div id="content">
     <h1 class="title">Apache Stanbol - services for semantic content management</h1>
-    <h2 id="how_to_build_install_and_run_apache_stanbol">How to build, install and run Apache Stanbol</h2>
-<p>As there is no official release of Apache Stanbol so far, one needs to build the software from source.</p>
-<h3 id="installation">Installation</h3>
+    <p>The documentation of its services and components can be retrieved from different places:</p>
+<ol>
+<li>
+<p>Below, you get the description how to build, install and run Apache Stanbol, its major features as well as scenarios how to use it.</p>
+</li>
+<li>
+<p>Every running Stanbol server provides you with further descriptions at its Web UI and for the RESTful web services for each component. </p>
+</li>
+<li>
+<p>An even more detailed technical documentation can be found within Readme.files wihin the <a href="http://svn.apache.org/repos/asf/incubator/stanbol/trunk/">source code</a>.</p>
+</li>
+</ol>
+<h2 id="1_how_to_build_install_and_run_apache_stanbol">1. How to build, install and run Apache Stanbol</h2>
+<p>As there is no official release of Apache Stanbol so far, one needs to install and build the software from source. As an alternative, you may download</p>
+<h3 id="11_installation">1.1. Installation</h3>
 <ol>
 <li>
 <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: <code>$ export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M </code></p>
@@ -63,7 +75,7 @@
 </li>
 </ol>
 <p><em>Updating sources</em>: From your Stanbol root directory call <code>$ mvn clean</code>, then <code>% svn update</code> and build a new version with <code>$ mvn clean install</code>.</p>
-<h3 id="launch_the_server">Launch the Server</h3>
+<h3 id="12_launch_the_server">1.2. Launch the Server</h3>
 <p>Several launchers are available under the <code>launchers/</code> directory:</p>
 <ul>
 <li>The <strong>"stable launcher"</strong> provides you with the most stable components only,</li>
@@ -78,9 +90,25 @@ port number by passing a <code>-p 9090</
 to see more options.</p>
 <p>Upon first startup, a folder named <code>sling/</code> is created in the current folder. This folder 
 contains Stanbol's persistent data, deployment configuration and logs.</p>
-<h3 id="http_entry_points">HTTP entry points</h3>
+<h3 id="13_http_entry_points">1.3. HTTP entry points</h3>
 <p>The web interface of your Apache Stanbol installation provides information for the main HTTP entry points. Each resource comes with a web view that documents the matching RESTful API for applications. Depending on which launcher you use, you will get a different set of <a href="services.html">services</a>. </p>
-<h2 id="usage_scenarios_for_apache_stanbol">Usage Scenarios for Apache Stanbol</h2>
+<h2 id="2_technical_documentation">2. Technical Documentation</h2>
+<p>A detailed technical documentation of its services and components can be found here:</p>
+<ul>
+<li><a href="services.html">Stanbol Services</a></li>
+<li><a href="enhancer.html">Enhancer</a></li>
+<li><a href="engines.html">Enhancement Engines</a></li>
+<li><a href="entityhub.html">Entityhub</a></li>
+<li><a href="contenthub.html">Contenthub</a></li>
+<li><a href="cmsadapter.html">CMS Adapter</a> </li>
+<li>Ontology Manager</li>
+<li>Reasoners</li>
+<li>Reengineer</li>
+<li><a href="rules.html">Rules</a></li>
+<li>FactStore</li>
+<li>Benchmark</li>
+</ul>
+<h2 id="3_usage_scenarios_for_apache_stanbol">3. Usage Scenarios for Apache Stanbol</h2>
 <ul>
 <li><a href="contentenhancement.html">Basic Content Enhancement</a></li>
 </ul>
@@ -105,22 +133,6 @@ contains Stanbol's persistent data, depl
 <li>Transforming CMS repository structures into ontologies</li>
 <li>Provide repository structures as thesaurus or domain ontology, e.g. categories.</li>
 </ul>
-<h2 id="technical_documentation">Technical Documentation</h2>
-<p>A detailed technical documentation of its services and components can be found here:</p>
-<ul>
-<li><a href="services.html">Stanbol Services</a></li>
-<li><a href="enhancer.html">Enhancer</a></li>
-<li><a href="engines.html">Enhancement Engines</a></li>
-<li><a href="entityhub.html">Entityhub</a></li>
-<li><a href="contenthub.html">Contenthub</a></li>
-<li><a href="cmsadapter.html">CMS Adapter</a> </li>
-<li>Ontology Manager</li>
-<li>Reasoners</li>
-<li>Reengineer</li>
-<li><a href="rules.html">Rules</a></li>
-<li>FactStore</li>
-<li>Benchmark</li>
-</ul>
 <h2 id="follow_and_support_apache_stanbol">Follow and support Apache Stanbol</h2>
 <ul>
 <li>