Author: agruber
Date: Thu Jun 30 09:18:32 2011
New Revision: 1141455
URL: http://svn.apache.org/viewvc?rev=1141455&view=rev
Log:
Renamed files to *mdtext
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext
Removed:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.md
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.md
Added:
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=1141455&view=auto
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext
(added)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/contentenhancement.mdtext
Thu Jun 30 09:18:32 2011
@@ -0,0 +1,206 @@
+_[Back to index](index.html)_
+
+# Using Apache Stanbol for enhancing textual content
+
+---
+
+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 of the engines][stan-engines] or from
console via
+
+ curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" \
+ --data "John Smith was born in London." http://localhost:8080/engines
+
+or by using the text examples delivered with Stanbol.
+
+ for file in enhancer/data/text-examples/*.txt;
+ do
+ curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" -T
$file http://localhost:8080/engines;
+ done
+
+Content items in formats other than plain text can be tested via the [web
interface of contenthub][stan-contenthub] or via the console by attaching
files. (The Metaxa Engine needs to be activated).
+
+
+## Using the enhancement engines
+
+Apache Stanbol starts with a number of active enhancement engines by default.
You can activate or deactivate engines as well as configure them to your needs
via the [OSGI administration console][stan-admin].
+
+For the enhancement engines, a workflow for the enhancement process is defined
as pre-processing, content-extraction, extraction-enhancement, default and
post-processing.
+
+The following pre-processing engines are available:
+
+- The __Language Identification Engine__ detects several European languages of
the content items you want to process.
+
+- The __Metaxa Engine__ extracts embedded metadata and textual content from a
large variety of document types and formats.
+
+For content extraction / natural language processing one engine is available:
+
+- The __Named Entity Extraction Enhancement Engine__ leverages the sentence
detector and name finder tools of the OpenNLP project bundled with statistical
models trained to detect occurrences of names of persons, places and
organizations.
+
+
+The extracted items will then be enhanced by a dedicated engine:
+
+- The __Named Entity Tagging Engine__ provides according suggestions from
dbpedia (default) and other references sites for entities extracted by the NER
engine .
+
+
+Specific additional enhancement engines are:
+
+- The __Location Enhancement Engine__ takes its suggestions from geonames.org
only.
+
+- The __OpenCalais Enhancement Engine__ uses services from Open Calais. (Note:
You need to provide a key in order to use this engine)
+
+- The __Zemanta Enhancement Engine__ uses the Zemanta services. (Note: You
need to provide a key in order to use this engine)
+
+
+For post-processing the results of the enhancement engines
+
+- The __CachingDereferencerEngine__ is used for the Web UI and fetches files
such as images for locations from external sites and is used to present the
enhancement results.
+
+
+## Using an index of linked open data locally
+
+To use the pre-configured indexes you can download them from
[here][stan-download]. You will get two files for each index:
+
+* org.apache.stanbol.data.site.{name}-{version}.jar
+* {name}.solrindex.zip
+
+
+By copying the zip archive into the "/sling/datafiles" folder before
installing the bundle, the data will used during the installation of the bundle
automatically. If you provide the file after installing the bundle, you will
need to restart the SolrYard installed by the bundle.
+
+The jar can be installed at any OSGI environment running the Apache Stanbol
Entityhub. When started it will create and configure:
+
+- a "ReferencedSite" accessible at "http://{host}/{root}/entityhub/site/{name}";
+- a "Cache" used to connect the ReferencedSite with your Data and
+- a "SolrYard" that manages the data indexed by this utility.
+
+This bundle does not contain the indexed data but only the configuration for
the Solr Index.
+
+If one has not copied the archive beforehand, the ZIP archive will be
requested by the Apache Stanbol Data File Provider after installing the Bundle.
To install the data you need copy this file to the "/sling/datafiles" folder
within the working directory of your Stanbol Server.
+
+_Note: {name} denotes to the value you configured for the "name" property
within the "indexing.properties" file._
+
+
+## Enhancement Example
+
+The text "John Smith was born in London." with a minimal configuration of
enhancement engines (_Named Entity Extraction Enhancement Engine_ and _Named
Entity Tagging Engine_) together with a local index of dbpedia entities will
result in the following output graph of several Entity Annotations and Text
Annotations (in Turtle-Syntax):
+
+ <urn:enhancement-37e084aa-abbd-5f15-d5e7-a59feea4deb2>
+ a <http://fise.iks-project.eu/ontology/EntityAnnotation> ,
<http://fise.iks-project.eu/ontology/Enhancement> ;
+ <http://fise.iks-project.eu/ontology/confidence>
+ "46.396988"^^<http://www.w3.org/2001/XMLSchema#double> ;
+ <http://fise.iks-project.eu/ontology/entity-label>
+ "London, Ontario"@en ;
+ <http://fise.iks-project.eu/ontology/entity-reference>
+ <http://dbpedia.org/resource/London,_Ontario> ;
+ <http://fise.iks-project.eu/ontology/entity-type>
+ <http://www.w3.org/2002/07/owl#Thing> ,
<http://dbpedia.org/ontology/City> , <http://www.opengis.net/gml/_Feature> ,
<http://dbpedia.org/ontology/Place> , <http://dbpedia.org/ontology/Settlement>
, <http://dbpedia.org/ontology/PopulatedPlace> ;
+ <http://fise.iks-project.eu/ontology/extracted-from>
+ <urn:content-item-sha1-88a2b5f6520df87e4567c06b48e742b7d1c71e9c>
;
+ <http://purl.org/dc/terms/created>
+
"2011-06-29T14:43:24.295+02:00"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
+ <http://purl.org/dc/terms/creator>
"org.apache.stanbol.enhancer.engines.entitytagging.impl.NamedEntityTaggingEngine"^^<http://www.w3.org/2001/XMLSchema#string>
;
+ <http://purl.org/dc/terms/relation>
+ <urn:enhancement-7af2e1a3-93fc-008f-fc6a-12accf05e58f> .
+
+
+ <urn:enhancement-6fbf0996-b518-7130-92f8-00b4f7572031>
+ a <http://fise.iks-project.eu/ontology/EntityAnnotation> ,
<http://fise.iks-project.eu/ontology/Enhancement> ;
+ <http://fise.iks-project.eu/ontology/confidence>
+ "183.53368"^^<http://www.w3.org/2001/XMLSchema#double> ;
+ <http://fise.iks-project.eu/ontology/entity-label>
+ "London"@en ;
+ <http://fise.iks-project.eu/ontology/entity-reference>
+ <http://dbpedia.org/resource/London> ;
+ <http://fise.iks-project.eu/ontology/entity-type>
+ <http://www.w3.org/2002/07/owl#Thing> ,
<http://www.opengis.net/gml/_Feature> ,
<http://dbpedia.org/ontology/Settlement> , <http://dbpedia.org/ontology/Place>
, <http://dbpedia.org/ontology/PopulatedPlace> ;
+ <http://fise.iks-project.eu/ontology/extracted-from>
+ <urn:content-item-sha1-88a2b5f6520df87e4567c06b48e742b7d1c71e9c>
;
+ <http://purl.org/dc/terms/created>
+
"2011-06-29T14:43:24.295+02:00"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
+ <http://purl.org/dc/terms/creator>
"org.apache.stanbol.enhancer.engines.entitytagging.impl.NamedEntityTaggingEngine"^^<http://www.w3.org/2001/XMLSchema#string>
;
+ <http://purl.org/dc/terms/relation>
+ <urn:enhancement-7af2e1a3-93fc-008f-fc6a-12accf05e58f> .
+
+
+ <urn:enhancement-7af2e1a3-93fc-008f-fc6a-12accf05e58f>
+ a <http://fise.iks-project.eu/ontology/TextAnnotation> ,
<http://fise.iks-project.eu/ontology/Enhancement> ;
+ <http://fise.iks-project.eu/ontology/confidence>
+ "0.9973729691652052"^^<http://www.w3.org/2001/XMLSchema#double> ;
+ <http://fise.iks-project.eu/ontology/end>
+ "29"^^<http://www.w3.org/2001/XMLSchema#int> ;
+ <http://fise.iks-project.eu/ontology/extracted-from>
+ <urn:content-item-sha1-88a2b5f6520df87e4567c06b48e742b7d1c71e9c>
;
+ <http://fise.iks-project.eu/ontology/selected-text>
+ "London"^^<http://www.w3.org/2001/XMLSchema#string> ;
+ <http://fise.iks-project.eu/ontology/selection-context>
+ "John Smith was born in
London."^^<http://www.w3.org/2001/XMLSchema#string> ;
+ <http://fise.iks-project.eu/ontology/start>
+ "23"^^<http://www.w3.org/2001/XMLSchema#int> ;
+ <http://purl.org/dc/terms/created>
+
"2011-06-29T14:43:24.291+02:00"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
+ <http://purl.org/dc/terms/creator>
"org.apache.stanbol.enhancer.engines.opennlp.impl.NEREngineCore"^^<http://www.w3.org/2001/XMLSchema#string>
;
+ <http://purl.org/dc/terms/type>
+ <http://dbpedia.org/ontology/Place> .
+
+
+ <urn:enhancement-4629f59b-7a78-4cb2-e7d6-99ffca61a3a7>
+ a <http://fise.iks-project.eu/ontology/EntityAnnotation> ,
<http://fise.iks-project.eu/ontology/Enhancement> ;
+ <http://fise.iks-project.eu/ontology/confidence>
+ "33.187008"^^<http://www.w3.org/2001/XMLSchema#double> ;
+ <http://fise.iks-project.eu/ontology/entity-label>
+ "City of London"@en ;
+ <http://fise.iks-project.eu/ontology/entity-reference>
+ <http://dbpedia.org/resource/City_of_London> ;
+ <http://fise.iks-project.eu/ontology/entity-type>
+ <http://www.w3.org/2002/07/owl#Thing> ,
<http://www.opengis.net/gml/_Feature> , <http://dbpedia.org/ontology/Place> ,
<http://dbpedia.org/ontology/Settlement> ,
<http://dbpedia.org/ontology/PopulatedPlace> ;
+ <http://fise.iks-project.eu/ontology/extracted-from>
+ <urn:content-item-sha1-88a2b5f6520df87e4567c06b48e742b7d1c71e9c>
;
+ <http://purl.org/dc/terms/created>
+
"2011-06-29T14:43:24.296+02:00"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
+ <http://purl.org/dc/terms/creator>
"org.apache.stanbol.enhancer.engines.entitytagging.impl.NamedEntityTaggingEngine"^^<http://www.w3.org/2001/XMLSchema#string>
;
+ <http://purl.org/dc/terms/relation>
+ <urn:enhancement-7af2e1a3-93fc-008f-fc6a-12accf05e58f> .
+
+
+ <urn:enhancement-37173dd0-240a-068c-91c9-60d91a8677e5>
+ a <http://fise.iks-project.eu/ontology/TextAnnotation> ,
<http://fise.iks-project.eu/ontology/Enhancement> ;
+ <http://fise.iks-project.eu/ontology/confidence>
+ "0.8398552823821589"^^<http://www.w3.org/2001/XMLSchema#double> ;
+ <http://fise.iks-project.eu/ontology/end>
+ "10"^^<http://www.w3.org/2001/XMLSchema#int> ;
+ <http://fise.iks-project.eu/ontology/extracted-from>
+ <urn:content-item-sha1-88a2b5f6520df87e4567c06b48e742b7d1c71e9c>
;
+ <http://fise.iks-project.eu/ontology/selected-text>
+ "John Smith"^^<http://www.w3.org/2001/XMLSchema#string> ;
+ <http://fise.iks-project.eu/ontology/selection-context>
+ "John Smith was born in
London."^^<http://www.w3.org/2001/XMLSchema#string> ;
+ <http://fise.iks-project.eu/ontology/start>
+ "0"^^<http://www.w3.org/2001/XMLSchema#int> ;
+ <http://purl.org/dc/terms/created>
+
"2011-06-29T14:43:24.289+02:00"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
+ <http://purl.org/dc/terms/creator>
"org.apache.stanbol.enhancer.engines.opennlp.impl.NEREngineCore"^^<http://www.w3.org/2001/XMLSchema#string>
;
+ <http://purl.org/dc/terms/type>
+ <http://dbpedia.org/ontology/Person> .
+
+
+ <urn:enhancement-de0e2c42-f3f6-1fdb-ef30-2650dc398108>
+ a <http://fise.iks-project.eu/ontology/EntityAnnotation> ,
<http://fise.iks-project.eu/ontology/Enhancement> ;
+ <http://fise.iks-project.eu/ontology/confidence>
+ "10.437969"^^<http://www.w3.org/2001/XMLSchema#double> ;
+ <http://fise.iks-project.eu/ontology/entity-label>
+ "John Maynard Smith"@en ;
+ <http://fise.iks-project.eu/ontology/entity-reference>
+ <http://dbpedia.org/resource/John_Maynard_Smith> ;
+ <http://fise.iks-project.eu/ontology/entity-type>
+ <http://xmlns.com/foaf/0.1/Person> ,
<http://www.w3.org/2002/07/owl#Thing> , <http://dbpedia.org/ontology/Scientist>
, <http://dbpedia.org/ontology/Person> ;
+ <http://fise.iks-project.eu/ontology/extracted-from>
+ <urn:content-item-sha1-88a2b5f6520df87e4567c06b48e742b7d1c71e9c>
;
+ <http://purl.org/dc/terms/created>
+
"2011-06-29T14:43:24.304+02:00"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
+ <http://purl.org/dc/terms/creator>
"org.apache.stanbol.enhancer.engines.entitytagging.impl.NamedEntityTaggingEngine"^^<http://www.w3.org/2001/XMLSchema#string>
;
+ <http://purl.org/dc/terms/relation>
+ <urn:enhancement-37173dd0-240a-068c-91c9-60d91a8677e5>
+
+---
+
+_[Back to index](index.html)_
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.mdtext?rev=1141455&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/engines.mdtext Thu
Jun 30 09:18:32 2011
@@ -0,0 +1,48 @@
+_[Back to index](index.html)_
+
+# Enhancement Engines and their main features
+
+## Preprocessing
+
+- __Language Identification Engine__
+ - langage dedection for textual content
+
+
+- __Metaxa Engine__
+ - text extraction from various documents
+ - extraction of metadata from documents
+
+## Natural Language Processing
+
+- __Named Entity Extraction Enhancement Engine__
+ - NLP processing
+ - dedect occurences of persons, places and organizations, mandatory for
every enhancement.
+
+
+## Linking Suggestions
+
+- __Named Entity Tagging Engine__
+ - suggest links to several Linked Data Sources (e.g. dbpedia)
+
+- __Location Enhancement Engine__
+ - suggests links to geonames.org
+
+- __OpenCalais Enhancement Engine__
+ - integrates service from Open Calais. (Note: You need to provide a key
in order to use this engine)
+
+- __Zemanta Enhancement Engine__
+ - integrates the Zemanta services. (Note: You need to provide a key in
order to use this engine)
+
+
+
+## Postprocessing / Other
+
+- __CachingDereferencerEngine__
+ - retrieves additional content for presenting the enhancement results.
+
+- __Refactor Engine__
+ - transforms enhancements according to a target ontology,
requires KRES launcher.
+
+
+---
+_[Back to index](index.html)_
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext?rev=1141455&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext Thu
Jun 30 09:18:32 2011
@@ -0,0 +1,62 @@
+_[Back to index](index.html)_
+
+# 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.
+
+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
+
+The list of mimetypes accepted as inputs depends on the deployed engines. By
default only text/plain content will be analyzed. By using the Metaxa En
+
+## Main Interfaces and Utilities
+
+A __Content Item__ is the unit of content that Stanbol Enhancer can deal with.
It gives access to the binary content that was registered, and the graph that
represents its metadata (provided by client and/or generated). The
__Enhancement Engine__ provides the interface to internal or external semantic
enhancement engines. There will usually be several of those, that the
EnhancementJobManager uses to enhance content items. The __Enhancement Job
Manager__ accepts requests for enhancing ContentItems, and processes them
either synchronously or asynchronously (as decided by the enhancement engines
or by configuration). The __Enhancement Engine Helper__ provides the classes
for the resulting enhancement structure according to the defined __Enhancement
Structure__.
+
+## Enhancement Structure
+
+The enhancement structure for Apache Stanbol is been described in full [here]
+The enhancement structure defines the types and properties used for the
resulting metadata graph of Apache Stanbol. Every __Enhancement__ type is a
description which contains the following mandatory properties:
+
+* creator: the specific enhancement engine creating this enhancement
+* creation time: the local system time, when the annotation was created
+* extracted-from: the content item for the enhancement. This links to the ID
of the content item as assigned by Stanbol.
+* type: the type of the enhancement (e.g. Location, Person, Location, Concept
...).
+* confidence: The level of confidence in the range from 0 to 1
+
+A __Text Annotation__ type provides metadata for the selected text. This is
intended to be used in addition to the enhancement type if an enhancement is
based on a part of the content.
+
+* start: the character position of the start of the selection. If start is not
defined it is assumed, that the selection starts at the beginning of the
document
+* end: the character position of the end of the selection. If end is not
defined it is assumed, that the selection ends at the end of the document.
+* selected-text: The text selected by the enhancement. (optional).
+* selection-context: The context of the selected text. This adds the
possibility to specify the context used to extract entities such as persons,
organizations, locations ... from natural language documents.
+
+The __Entity Annotation__ refer to named entities which have been recognized
within the content. This type is intended to be used together with the FISE
enhancement type.
+
+* entity-reference: This refers to the URI identifying the Entity
+* entity-label: The label(s) of the referred entity
+* entity-type: This property can be used to specify the type of the entity
(optional)
+
+The occurrences of the entity within the content (the exact positions within
the text where this entity is referred) are determined by outgoing dc:relation
links.
+
+
+## Response in RDF
+
+Apache Stanbol Enhancer is able to serialize the response in the following RDF
formats:
+
+ application/json (JSON-LD)
+ application/rdf+xml (RDF/XML)
+ application/rdf+json (RDF/JSON)
+ text/turtle (Turtle)
+ text/rdf+nt (N-TRIPLES)
+
+By default the URI of the content item being enhanced is a local, non
de-referencable URI automatically built out of a hash digest of the binary
content. Sometimes it might be helpful to provide the URI of the content-item
to be used in the enhancements RDF graph. This can be achieved by passing a URI
request parameter as follows:
+
+ curl -X POST -H "Accept: text/turtle" -H "Content-type: text/plain" \
+ --data "John Smith was born in London." \
+ "http://localhost:8080/engines?uri=urn:fise-example-content-item";
+
+____
+_[Back to index](index.html)_
\ No newline at end of file
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.mdtext?rev=1141455&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/features.mdtext Thu
Jun 30 09:18:32 2011
@@ -0,0 +1,20 @@
+_[Back to index](index.html)_
+
+# Apache Stanbol features
+
+* NLP and Named Entity Recognition via [Apache
OpenNLP](http://incubator.apache.org/opennlp/)
+* Enhancement engines linking to open data such as dbpedia, geonames, dplb.
+* Enhancement engines integrating external services such as zemanta and
opencalais.
+* Local Indexes of Linked open Data
+* RDF management via [Apache Clerezza](http://incubator.apache.org/clerezza/)
+* Various enhancement output serialisations (RDF/XML, JSON-LD, RDF/XML,
RDF/JSON, Turtle, N-TRIPLES)
+* Language Detection for European Languages
+* Extracting embedded metadata and textual content via
[Aperture](http://aperture.sourceforge.net/)
+
+## Upcoming features whishlist
+
+* Multilingual support
+
+---
+
+_[Back to index](index.html)_
Added: 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=1141455&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext (added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext Thu
Jun 30 09:18:32 2011
@@ -0,0 +1,119 @@
+# Apache Stanbol - services for semantic content management
+
+---
+
+[Apache Stanbol][stan-home] is an open source modular software stack and
reusable set of components for semantic content management.
+
+Apache Stanbol components are meant to be accessed over RESTful interfaces to
provide semantic services for content management. The current code is written
in Java and based on the OSGi modularization framework.
+
+Applications include extending existing content management systems with
(internal or external) semantic services, and creating new types of content
management systems with semantics at their core. Its main features will include:
+
+- Persistence: services that store (or cache) semantic information and make it
searchable
+- Lifting/Enhancement: services that add semantic information to
ânon-semanticâ pieces of content
+- Knowledge models and reasoning: services that enhance the semantic
information
+- Interaction: intelligent user interface management and generation
+
+Apache Stanbol project was initiated and is part-funded by the European R&D
project [IKS - Interactive Knowledge Stack for small to medium CMS
providers][iks].
+
+Online demos of Apache Stanbol are available at
+
+* [http://dev.iks-project.eu:8080/](http://dev.iks-project.eu:8080/)
+* [http://stanbol.demo.nuxeo.com/](http://stanbol.demo.nuxeo.com/)
+
+
+## Build, install and run Apache Stanbol
+
+As there is no official release of [Apache Stanbol][stan-home] so far, one
needs to build the software from source.
+
+
+### Installation
+
+1. 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>
+
+
+2. Fetch the sources from the Apache code repository
+
+ <code>$ svn co https://svn.apache.org/repos/asf/incubator/stanbol/
stanbol</code>
+
+3. From the source directory run:
+
+ <code>$ mvn clean install</code>
+
+ _Updating sources_: 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>.
+
+
+### Launch the Server
+
+Several launchers are available under the <code>launchers/</code> directory:
+
+* The __"stable launcher"__ provides you with the most stable components only,
+* the __"full launcher"__ contains all major components available,
+* the __"stateless launcher"__ lets you work with Apache Stanbol components in
offline mode and
+* the __"kres launcher"__ activates the rules machinery only.
+
+You can launch the Server via e.g:
+
+<code>$ java -Xmx1g -jar
full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar</code>
+
+ 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. Upon first startup, a folder named `sling/` is created in the current
folder. This folder will hold the files for any database used by Stanbol,
deployment configuration and logs.
+
+
+### HTTP entry points
+
+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 [services](services.html).
+
+
+## Usage Scenarios for Apache Stanbol
+
+* [Content Enhancement](contentenhancement.html)
+
+ Analyze textual content, enhance with with named entities (person, place,
organization), suggest links to open data sources.
+
+* Working with "local" Entities
+
+ Use locally defined entities (e.g. thesaurus concepts) from an organization's
context.
+
+* 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.
+
+
+## Technical Documentation
+
+A detailed technical documentation of its components can be found here:
+
+* [Enhancer](enhancer.html)
+* [Enhancement Engines](engines.html)
+* Entityhub
+* Contenthub
+* CMS Adapter
+* Ontology Manager
+* Reasoners
+* Reengineer
+* Rules
+* Benchmark
+
+
+## Follow and support Apache Stanbol
+
+- Subscribe to the Apache Stanbol Developers mailinglist by sending an email
to <code>stanbol-dev-subscribe AT incubator.apache.org</code>.
+
+- Please report bugs on the [Apache issue
tracker](https://issues.apache.org/jira/browse/STANBOL)
+
+[iks]: http://www.iks-project.eu/
+[stan-home]: http://incubator.apache.org/stanbol/
+[stan-admin]: http://localhost:8080/system/console/
+[stan-engines]: http://localhost:8080/engines
+[stan-contenthub]: http://localhost:8080/contenthub
+
+
+
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext?rev=1141455&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext Thu
Jun 30 09:18:32 2011
@@ -0,0 +1,35 @@
+# HTTP entry points for Apache Stanbol services
+
+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 services.
+
+- [/engines][stan-engines] (stable)
+
+ This is a stateless interface to allow clients to submit content to be
analyzed by the Enhancement Engines and get the resulting RDF enhancements at
once without storing anything on the server-side.
+
+- [/entityhub](http://localhost:8080/entityhub) (stable)
+
+ The Entityhub provides two main services: The entity network manages
(external) referenced sites and lets one consume entity information, the
Entityhub supports managing and using local entities.
+
+
+- [/system/console][stan-admin] (stable)
+
+ This is the OSGi administration console (for administrators and developers).
The initial username / password is set to admin / admin. Use the console to add
new bundles and activate, de-activate and configure components. The console can
also be used to perform hot-(re)deployment of any OSGi bundles. For instance to
re-deploy a new version of this web interface, go to the
<code>$STANBOL_HOME/enhancer/jersey</code> source folder and run the following
command:
+
+ <code>$ mvn install -o -DskipTests -PinstallBundle \
+ -Dsling.url=http://localhost:8080/system/console</code>
+
+
+- [/sparql](http://localhost:8080/sparql) (full)
+
+ This is the SPARQL endpoint for the Stanbol store. SPARQL is the standard
query language the most commonly used to provide interactive access to semantic
knowledge bases.
+
+- [/contenthub](http://localhost:8080/contenthub) (full)
+
+ This is a stateful interface to submit content to analyze and store the
results on the server. It is then possible to browse the resulting enhanced
content items. The longer-term goal of this endpoint is to implement faceted
semantic search of the enhanced content items. (Note: Up to now, this endpoint
is a proof of concept / experimental feature. It does not actually store the
content on the disk, just in memory.)
+
+- [/ontonet](http://dev.iks-project.eu:8080/ontonet) (full)
+
+- [/factstore](http://dev.iks-project.eu:8080/factstore) (full)
+
+-
+
