Author: agruber
Date: Thu Dec 1 15:54:59 2011
New Revision: 1209126
URL: http://svn.apache.org/viewvc?rev=1209126&view=rev
Log:
Added new components overview page, documentation for factstore and ontonet,
some minor changes in enhancer documentation and index page STANBOL-402
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontonet.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules.mdtext
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext?rev=1209126&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
Thu Dec 1 15:54:59 2011
@@ -0,0 +1,23 @@
+Title: Apache Stanbol RESTful Services and Components
+
+This is an overview of the major features of various Stanbol components and
services for analyzing and enhancing your content. The enhancements are
provided via natural language processing, metadata extraction and linking named
entities to public or private entity repositories. Furthermore, Stanbol
provides a machinery to further process this data and add additional knowledge
and links via applying rules and reasoning. Stanbol let you also generate
distinct indexes of content items together with their linked metadata to serve
faceted semantic search.
+
+* The [Enhancer](enhancer.html) component together with its [Enhancement
Engines](engines.html) provides you with the ability to post content to Stanbol
and get suggestions for possible entity annotation in return.
+
+* The [Entityhub](entityhub.html) is the component, which lets you cache and
manage local indexes of repositories such as dbpedia but also custom data (e.g.
product descriptions, contact data, specialized topic thesauri).
+
+* The [Contenthub](contenthub.html) provides you with an combined index of
your content items together with enhancements to facilitate semantic search on
your entire knowledge base.
+
+* The [CMS Adapter](cmsadapter.html) can be used to map (bidirectionally)
existing node structures from content repositories (CMIS) to RDF models.
+
+* The [Rules](rules.html) component provides you with the means to re-factor
knowledge graphs, e.g. for supporting the schema.org vocabulary for Search
Engine Optimization.
+
+* The [Reasoners](reasoners.html) can be used to automatically infer
additional knowledge. It is used to infer new facts in the knowledge base, e.g.
if you have enhanced your entity "Paris", you can get "France" via a
"located-in" relation.
+
+* The [Ontology Manager](ontonet.html) is the facility to manage all your
ontologies i.e. the knowledge models you use to describe your metadata of your
content as well as knowledge about the semantics of your content.
+
+* The [FactStore](factstore.html) is a component that let's use store
relations between entities identified by their URIs. This relation between two
entities is called a _fact_.
+
+* The 'Sparql endpoint' gives access to the semantic enhancements form the
Stanbol Enhancer.
+
+* The 'EnhancerVIE' 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.
Modified:
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=1209126&r1=1209125&r2=1209126&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer.mdtext Thu
Dec 1 15:54:59 2011
@@ -52,7 +52,4 @@ By default the URI of the content item b
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
+ "http://localhost:8080/engines?uri=urn:fise-example-content-item";
\ No newline at end of file
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore.mdtext?rev=1209126&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore.mdtext
Thu Dec 1 15:54:59 2011
@@ -0,0 +1,47 @@
+Title: Factstore
+
+The FactStore is a component that let's use store relations between entities
identified by their URIs. A relation between two or more entities is called a
*fact*. The FactStore let's you store N-ary facts. In consequence you can store
relations between N participating entities.
+
+## Example
+
+Imagine you want to store the fact that the person named John Doe works for
the company Winzigweich. John Doe is represented by the URI
http://www.doe.com/john and the company by http://www.winzigweich.de. This fact
is stored as a relation between the entity http://www.doe.com/john and
http://www.winzigweich.de.
+
+For this, we first need to create a so called fact schema that tells the
FactStore what we would like to store. A fact schema has a unique name (often
an URI is used) to identify it. To specify what kinds of entities we would like
to store, we specify the type of the entities. Each type has an URI and should
be defined by some ontology. For example, we can use the ontology specified by
http://schema.org/.
+
+According to http://schema.org/ a person is of type http://schema.org/Person
and an organization is of type http://schema.org/Organization. We will use
these type information to specify the fact schema
http://factschema.org/worksFor. The specification of a fact schema is written
in JSON-LD, like this:
+
+ {
+ "@context" : {
+ "#types" : {
+ "person" : "http://schema.org/Person";,
+ "organization" : "http://schema.org/Organization";
+ }
+ }
+ }
+
+To create this fact schema in the FactStore we have to store it in a *.json
file, e.g. worksFor.json, and PUT it into the FactStore. The path to put the
fact schema is `/factstore/facts/{factSchemaName}`. So for our example this
would be `/factstore/facts/http://factschema.org/worksFor`. Unfortunately, this
is not a valid URI so that we have to URL-encode the name of the fact schema.
This leads to
+`/factstore/facts/http%3A%2F%2Ffactschema.org%2FworksFor`.
+
+_Note_: If you want to avoid this URL-encoding step, you should chose another
name for your fact schema that is not an URI by itself. You are free to do so!
+
+Now to PUT the `worksFor` fact schema we can use this cURL command.
+
+ curl
http://localhost:8080/factstore/facts/http%3A%2F%2Ffactschema.org%2FworksFor -T
worksFor.json
+
+After creating the fact schema we can store the fact that John Doe works for
Winzigweich by POSTing it to the FactStore. The fact is specified in JSON-LD
syntax. The `@profile` defines the fact schema where this fact belongs to.
+
+ {
+ "@profile" : "http://factschema.org/worksFor";,
+ "person" : { "@iri" : "http://www.doe.com/john"; },
+ "organization" : { "@iri" : "http://www.winzigweich.de"}
+ }
+
+Now we can POST this fact, e.g. stored in fact.json, to the FactStore at
`/factstore/facts`. By using cURL it would be this command:
+
+ curl -d @fact.json -H "Content-Type: application/json"
http://localhost:8080/factstore/facts
+
+On success this will return a 201 (Created) and the URI of the newly created
fact in the location header of the response. To retrieve a fact you can GET it
from the returned URI.
+
+## REST API Documentation
+
+To get the latest documentation you should start your copy of Apache Stanbol
and navigate your browser to http://localhost:8080/factstore. There you will
find more information and the documentation of the FactStore's REST API.
\ No newline at end of file
Modified: 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=1209126&r1=1209125&r2=1209126&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext Thu
Dec 1 15:54:59 2011
@@ -1,6 +1,6 @@
Title: Apache Stanbol - services for semantic content management
-The documentation of its services and components can be retrieved from
different places:
+The documentation of Apache Stanbol and its services and components can be
retrieved from different places:
1. Below, you get the description how to build, install and run Apache
Stanbol, its major features as well as scenarios how to use it.
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontonet.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontonet.mdtext?rev=1209126&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontonet.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontonet.mdtext Thu
Dec 1 15:54:59 2011
@@ -0,0 +1,27 @@
+Title: Ontology Manager
+
+The Stanbol OntoNet is a controlled environment for managing ontologies and
ontology networks and user sessions managing them.
+
+## RESTful API
+
+Stanbol OntoNet implements the API section for managing OWL and OWL2
ontologies, in order to prepare them for consumption by reasoning services,
refactorers, rule engines and the like. Ontology management in ONM is sparse
and not connected: once loaded internally from their remote locations,
ontologies live and are known within the realm they were loaded in. This allows
loose-coupling and (de-)activation of ontologies in order to scale the data
sets for reasoners to process and optimize them for efficiency. The following
concepts have been introduced with the ONM:
+
+* Ontology scope: a "logical realm" for all the ontologies that encompass a
certain CMS-related set of concepts (such as "User", "ACL", "Event", "Content",
"Domain", "Reengineering", "Community", "Travelling" etc.). Scopes never
inherit from each other, though they can load the same ontologies if need be.
+
+* Ontology space: an access-restricted container for synchronized access to
ontologies within a scope. The ontologies in a scope are loaded within its set
of spaces. An ontology scope contains: (a) exactly one core space, which
contains the immutable set of essential ontologies that describe the scope; (b)
exactly one (possibly empty) custom space, which extends the core space
according to specific CMS needs (e.g. the core space for the User scope may
contains alignments to FOAF); (c) zero or more session spaces, which extend the
custom space with additional models provided by end-users (e.g. the set of
individuals that 'populate' a scope may be fed to OntoNet via a session space).
Session spaces are mapped one-to-one with KReS sessions (see below).
+
+* OntoNet session: a container of session spaces for all affected scopes, for
stateful management of ontology networks. It is not equivalent to an HTTP
session (since it can live persistently across multiple HTTP sessions),
although its behaviour can reflect the one of the HTTP session that created it,
if required by the implementation.
+
+### Sub-Components
+
+ - 'ontonet' - allows to construct subsets of the knowledge base
+ managed by Stanbol into OWL/OWL2 ontology networks
+ - 'registry' - manages ontology libraries for bootstrapping the network
+ using both external and internal ontologies
+ - 'store' - create, read, update and modify operations on single
+ ontologies stored in Stanbol
+ - 'web' - the RESTful Web Service interface for OntoNet
+
+## Examples
+
+TODO
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules.mdtext?rev=1209126&r1=1209125&r2=1209126&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules.mdtext Thu
Dec 1 15:54:59 2011
@@ -1,7 +1,8 @@
Title: Rules
Stanbol Rules is a component that supports the construction and execution of
inference rules. An __inference rule__, or transformation rule, is a syntactic
rule or function which takes premises and returns a conclusion. Stanbol Rules
allows to add a layer for expressing business logics by means of axioms, which
encode the inference rules. These axioms can be organized into a container
called __recipe__, which identifies a set of rules that share the same business
logic and interpret them as a whole.
-
For instance, with Stanbol Rules the administrator can define integrity checks
for data fetched from heterogeneous and external sources in order to prevent
unwanted formats or inconsistent data. Also, Stanbol Rules can be used to
derive new knowledge or integrate information from different semantically
enhanced contents.
+
+For instance, with Stanbol Rules the administrator can define integrity checks
for data fetched from heterogeneous and external sources in order to prevent
unwanted formats or inconsistent data. Also, Stanbol Rules can be used to
derive new knowledge or integrate information from different semantically
enhanced contents.
## Rule Language
@@ -10,6 +11,7 @@ Rules are written in the [Stanbol Rule](
## Service Endpoints
The Rules RESTful API is structured as follows:
+_(Please note, that the following links to the actual service endpoint link to
a running instance of Apache Stanbol. If you use other domains or ports than
"localhost:8080", then please change accordingly)_
### Rule Manager ("/rules/rule"):
