You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by bu...@apache.org on 2012/04/11 10:30:50 UTC
svn commit: r812318 [8/10] - in /websites/staging/stanbol/trunk/content: ./
stanbol/docs/0.9.0-incubating/ stanbol/docs/0.9.0-incubating/cmsadapter/
stanbol/docs/0.9.0-incubating/contenthub/
stanbol/docs/0.9.0-incubating/enhancer/ stanbol/docs/0.9.0-in...
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/entityhub/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/entityhub/index.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/entityhub/index.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,108 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - Entityhub</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Entityhub</h1>
+ <p>The Entityhub provides two main services. The Entityhub provides the connection to external linked open data sites as well as using indexes of them locally. Its services allow to manage a <strong>network of sites</strong> to consume entity information and to <strong>manage entities locally</strong>.<br />
+</p>
+<p>A small index of approx. 43k entities from dbpedia comes with the default installation.</p>
+<h2 id="service-endpoints">Service Endpoints</h2>
+<p>The RESTful API of the Entityhub ist structured as follows:</p>
+<h3 id="entity-network-entityhubsite">Entity Network ("/entityhub/site*"):</h3>
+<ul>
+<li>The Referenced Site Manager @ <a href="http://localhost:8080/entityhub/sites">/entityhub/sites</a> allows to manages sites and retrieve/search Entities in all sites of the Entity Network.</li>
+<li>A Referenced Site @ /entityhub/site/{siteName} refers to a single site of the Referenced Site Manager and allows to retrieve all active sites. Referenced sites provide the same interface as the referenced site manager.</li>
+</ul>
+<p>For both services, several features are available:</p>
+<ul>
+<li>
+<p><a href="http://localhost:8080/entityhub/sites/referenced"><strong>Referenced</strong></a> returns a json array containing the IDs of all available sites. Sites returned by this method can be accessed via the site service endpoint.</p>
+</li>
+<li>
+<p><a href="http://localhost:8080/entityhub/sites/entity"><strong>Entity</strong></a> searches all referenced sites for the entity with the parsed URI.</p>
+</li>
+<li>
+<p><a href="http://localhost:8080/entityhub/sites/find"><strong>Find</strong></a> provides a label based search service over all sites.</p>
+</li>
+<li>
+<p><a href="http://localhost:8080/entityhub/sites/query"><strong>Query</strong></a> allows to parse JSON serialized field queries to the sites endpoint.</p>
+</li>
+</ul>
+<p>Currently active referenced sites at the demo server are available and running for <a href="http://dev.iks-project.eu:8080/entityhub/site/dbpedia/">dbpedia</a>, <a href="http://dev.iks-project.eu:8080/entityhub/site/dblp/">dplp</a> and <a href="http://dev.iks-project.eu:8080/entityhub/site/geonames/">geonames</a>.</p>
+<h3 id="entityhub-entityhub">Entityhub ("/entityhub"):</h3>
+<ul>
+<li>Local Entities @/entityhub/entity: Full CRUD operations on Entities managed by the Entityhub</li>
+<li>Entity Mappings @ /entityhub/mapping: Lookup mappings from local Entities to Entities managed by a Referenced Site</li>
+<li>Local Search @/entityhub/find: Find locally managed Entities by label based search.</li>
+<li>Local Query @/entityhub/query: Find locally managed Entities by parsing queries</li>
+<li>Entity Lookup @/entityhub/lookup: Lookup Entities by id. This supports also to lookup Entities managed by Referenced Sites and the import of found Entities to the Entityhub.</li>
+</ul>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/examples/anl-mappings.txt
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/examples/anl-mappings.txt (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/examples/anl-mappings.txt Wed Apr 11 08:30:47 2012
@@ -0,0 +1,164 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+#NOTE: THIS IS A DEFAULT MAPPING SPECIFICATION THAT INCLUDES MAPPINGS FOR
+# COMMON ONTOLOGIES. USERS MIGHT WANT TO ADAPT THIS CONFIGURATION AB
+# COMMENTING/UNCOMMENTING AND/OR ADDING NEW MAPPINGS
+
+# --- Define the Languages for all fields ---
+# to restrict languages to be imported (for all fields)
+#| @=null;en;de;fr;it
+
+#NOTE: null is used to import labels with no specified language
+
+# to import all languages leave this empty
+
+# --- RDF RDFS and OWL Mappings ---
+# This configuration only index properties that are typically used to store
+# instance data defined by such namespaces. This excludes Ontology definitions
+
+# NOTE that nearly all other ontologies are are using properties of these three
+# schemas, therefore it is strongly recommended to include such information!
+
+rdf:type | d=entityhub:ref
+
+rdfs:label
+rdfs:comment
+rdfs:seeAlso | d=entityhub:ref
+
+
+owl:sameAs | d=entityhub:ref
+
+#If one likes to also index Ontologies one should add the following statements
+#owl:*
+#rdfs:*
+
+# --- Dublin Core (DC) ---
+# The default configuration imports all dc-terms data and copies vlaues for the
+# old dc-elements standard over to the according properties ofthe dc-terms
+#standard.
+
+# NOTE that a lot of other ontologies are also using DC for some of there data
+# therefore it is strongly recommended to include such information!
+
+#mapping for all dc-terms properties
+dc:*
+
+# copy dc:title to rdfs:label
+dc:title > rdfs:label
+
+# deactivated by default, because such mappings are mapped to dc-terms
+#dc-elements:*
+
+# mappings for the dc-elements properties to the dc-terms
+dc-elements:contributor > dc:contributor
+dc-elements:coverage > dc:coverage
+dc-elements:creator > dc:creator
+dc-elements:date > dc:date
+dc-elements:description > dc:description
+dc-elements:format > dc:format
+dc-elements:identifier > dc:identifier
+dc-elements:language > dc:language
+dc-elements:publisher > dc:publisher
+dc-elements:relation > dc:relation
+dc-elements:rights > dc:rights
+dc-elements:source > dc:source
+dc-elements:subject > dc:subject
+dc-elements:title > dc:title
+dc-elements:type > dc:type
+#also use ec-elements:title as label
+dc-elements:title > rdfs:label
+
+# --- Social Networks (via foaf) ---
+#The Friend of a Friend schema often used to describe social relations between people
+foaf:*
+
+# copy the name of a person over to rdfs:label
+foaf:name > rdfs:label
+
+# additional data types checks
+foaf:knows | d=entityhub:ref
+foaf:made | d=entityhub:ref
+foaf:maker | d=entityhub:ref
+foaf:member | d=entityhub:ref
+foaf:homepage | d=xsd:anyURI
+foaf:depiction | d=xsd:anyURI
+foaf:img | d=xsd:anyURI
+foaf:logo | d=xsd:anyURI
+#page about the entity
+foaf:page | d=xsd:anyURI
+
+
+# --- Simple Knowledge Organization System (SKOS) ---
+
+# A common data model for sharing and linking knowledge organization systems
+# via the Semantic Web. Typically used to encode controlled vocabularies auch as
+# a thesaurus
+skos:*
+
+# copy the preferred label over to rdfs:label
+skos:prefLabel > rdfs:label
+
+# copy values of **Match relations to the according related, broader and narrower
+skos:relatedMatch > skos:related
+skos:broadMatch > skos:broader
+skos:narrowMatch > skos:skos:narrower
+
+#similar mappings for transitive variants are not contained, because transitive
+#reasoning is not directly supported by the Entityhub.
+
+# Some SKOS thesaurus do use "skos:transitiveBroader" and "skos:transitiveNarrower"
+# however such properties are only intended to be used by reasoners to
+# calculate transitive closures over broader/narrower hierarchies.
+# see http://www.w3.org/TR/skos-reference/#L2413 for details
+# to correct such cases we will copy transitive relations to there counterpart
+skos:narrowerTransitive > skos:narrower
+skos:broaderTransitive > skos:broader
+
+
+# --- Semantically-Interlinked Online Communities (SIOC) ---
+
+# an ontology for describing the information in online communities.
+# This information can be used to export information from online communities
+# and to link them together. The scope of the application areas that SIOC can
+# be used for includes (and is not limited to) weblogs, message boards,
+# mailing lists and chat channels.
+sioc:*
+
+# --- biographical information (bio)
+# A vocabulary for describing biographical information about people, both living
+# and dead. (see http://vocab.org/bio/0.1/)
+bio:*
+
+# --- Rich Site Summary (rss) ---
+rss:*
+
+# --- GoodRelations (gr) ---
+# GoodRelations is a standardised vocabulary for product, price, and company data
+gr:*
+
+# --- Creative Commons Rights Expression Language (cc)
+# The Creative Commons Rights Expression Language (CC REL) lets you describe
+# copyright licenses in RDF.
+cc:*
+
+# --- Additional namespaces added for the Europeana dataset (http://ckan.net/dataset/europeana-lod) ---
+http://www.europeana.eu/schemas/edm/*
+http://www.openarchives.org/ore/terms/*
+
+
+
+
+
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/implementation.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/implementation.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/implementation.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,84 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - FactStore Implementation Concept</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">FactStore Implementation Concept</h1>
+ <p>The <a href="specification.html">FactStore specification</a> is written with a certain kind of implementation in mind. Although the implementation of the specification is not pretended it might be useful to have a look at this simple implementation concept.</p>
+<h2 id="store-implementation">Store Implementation</h2>
+<p>The store implementation is based on the well known concept of relational databases. Each fact schema is a table in a relational database. Creating a new fact schema is equivalent to creating a new table with a number of String attributes, because we store IRIs, according to the schema. For performance reasons the attributes should be indexed.
+The store just needs to be able to create new schemata. It is not specified that a schema may be altered over time. This could be an improvement for the future.</p>
+<h2 id="query-implementation">Query Implementation</h2>
+<p>The JSON-LD query structure is designed to be mapped directly to valid SQL statements. If the store is implemented in a relational database all queries can be transformed to SQL queries to this database. For security reasons it is important to keep hacks like SQL injection in mind when transforming the JSON-LD query to SQL.</p>
+<p>As seen in the examples, queries may use attributes of entities to formulate the request. However, the FactStore does only store the IRIs of the entities not the entities with their attributes. Therefore, the FactStores needs an EntityHub to resolve entities specified by their attributes. The EntityHub must be able to query for entities by example.</p>
+<p>Note: Depending on the number of entities returned by the EntityHub for a certain request this architecture may lead to performance problems. It has to be evaluated where the limit of this approach is in terms of performance. However, the assumption is that in many (or most) scenarios this will not become a problem. If it becomes a problem, the type of allowed queries may be restricted, e.g. don't allow queries that use entity attributes in the "where" clause, to avoid performance or memory problems.</p>
+<hr />
+<p><em>Back to <a href="index.html">FactStore</a></em></p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/index.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/index.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,117 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - Factstore</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Factstore</h1>
+ <p>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 <em>fact</em>. The FactStore let's you store N-ary facts according to a user defined fact schema. In consequence you can store relations between N participating entities. The FactStore only stores the relation and not the entities itself. It only uses references to entities by using the entities' URI. The entities itself should be handled by another component, e.g. the <a href="../entityhub/">Entityhub</a>. A fact is defined by a fact schema which is defined over types of entities.</p>
+<p>A fact schema can be defined between an arbitrary number of entities. In most cases a fact schema is defined between two or three entities. For example, the fact schema 'works-for' can be defined as a relation between entities of type 'Person' and 'Organization'. The Fact Store interface allows the creation of custom fact schemata and to store facts according to these custom schemata. The Fact Store provides a simple way to define and store facts. This component is meant to be used in scenarios where a simple solution is sufficient and it is not required to define a complex ontology with reasoning support.</p>
+<p>Read on and have a look at a concrete example or go to the <a href="specification.html">FactStore specification</a> page for more details. If you need some information about its realization, read the notes about its <a href="implementation.html">implementation concept</a>.</p>
+<h2 id="example">Example</h2>
+<p>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.</p>
+<p>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 <a href="http://schema.org/">schema.org</a>.</p>
+<p>According to <a href="http://schema.org/">schema.org</a> is a person of type <a href="http://schema.org/Person">http://schema.org/Person</a> and an organization is of type <a href="http://schema.org/Organization">http://schema.org/Organization</a>. 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:</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"#types"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"person"</span> <span class="p">:</span> <span class="s">"http://schema.org/Person"</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"http://schema.org/Organization"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>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 <code>/factstore/facts/{factSchemaName}</code>. So for our example this would be <code>/factstore/facts/http://factschema.org/worksFor</code>. Unfortunately, this is not a valid URI so that we have to URL-encode the name of the fact schema. This leads to
+<code>/factstore/facts/http%3A%2F%2Ffactschema.org%2FworksFor</code>.</p>
+<p><em>Note</em>: 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!</p>
+<p>Now to PUT the <code>worksFor</code> fact schema we can use this cURL command.</p>
+<div class="codehilite"><pre><span class="n">curl</span> <span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/factstore/</span><span class="n">facts</span><span class="o">/</span><span class="n">http</span><span class="nv">%3A%2F%2Ffactschema</span><span class="o">.</span><span class="n">org</span><span class="nv">%2FworksFor</span> <span class="o">-</span><span class="n">T</span> <span class="n">worksFor</span><span class="o">.</span><span class="n">json</span>
+</pre></div>
+
+
+<p>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 <code>@profile</code> defines the fact schema where this fact belongs to.</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@profile"</span> <span class="p">:</span> <span class="s">"http://factschema.org/worksFor"</span><span class="p">,</span>
+ <span class="s">"person"</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="p">:</span> <span class="s">"http://www.doe.com/john"</span> <span class="p">},</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="p">:</span> <span class="s">"http://www.winzigweich.de"</span><span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Now we can POST this fact, e.g. stored in fact.json, to the FactStore at <code>/factstore/facts</code>. By using cURL it would be this command:</p>
+<div class="codehilite"><pre><span class="n">curl</span> <span class="o">-</span><span class="n">d</span> <span class="nv">@fact</span><span class="o">.</span><span class="n">json</span> <span class="o">-</span><span class="n">H</span> <span class="s">"Content-Type: application/json"</span> <span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/factstore/</span><span class="n">facts</span>
+</pre></div>
+
+
+<p>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.</p>
+<h2 id="rest-api-documentation">REST API Documentation</h2>
+<p>To get the latest documentation you should start your copy of an Apache Stanbol launcher that includes the FactStore and navigate your browser to http://localhost:8080/factstore. There you will find more information and the documentation of the FactStore's REST API.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/specification.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/specification.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/factstore/specification.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,359 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - FactStore Specification</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">FactStore Specification</h1>
+ <p>The FactStore is designed to store semantic relations in terms of facts about entities and their relationships. Additionally, the FactStore specifies a simple SQL-like query language expressed in JSON-LD to search for semantic relations and to reason through the use of joined relationships. This specification defines required interfaces for the FactStore in terms of RESTful API interfaces and a <a href="implementation.html">concept for a possible implementation</a>.</p>
+<p>In the following, we will refer to semantic relationships as facts about entities. For example, the relation âemplyeeOfâ may be a fact about two entities one of type person and one of type organization. Facts are n-ary meaning that the number of participating entities is not limited. The FactStore implements a store for facts plus the ability to query for single facts and for combinations of facts. In summary, the FactStore provides:</p>
+<ul>
+<li>Persistence storage for n-ary facts about entities</li>
+<li>Query language to query for a single fact</li>
+<li>Query language to query for combinations of facts (reasoning)</li>
+</ul>
+<p>In the following, we will define the required interfaces for the FactStore plus the required query language.</p>
+<p>''Note'': Interfaces will be defined as RESTful service APIs. The payload of service calls is specified using <a href="http://www.json-ld.org/spec/ED/20110507/JSON-LD">Specification version 20110507</a>.</p>
+<p>''Note'': The FactStore does not provide any SPARQL endpoint so far. This could be part of an extended version.</p>
+<h2 id="store-interface">Store Interface</h2>
+<p>The store interface allows clients to put new fact schemata and according facts (instances of that schemata) to the FactStore.</p>
+<h3 id="publish-a-new-fact-schema">Publish a New Fact Schema</h3>
+<p>Allows clients to publish new fact schemata to the FactStore. Each fact is an n-tuple where each element of that tuple defines a certain type of entity. A fact schema defines which types of entities and their roles are part of instances of that fact.</p>
+<p>Path: /factstore/facts/{fact-schema-name}</p>
+<p>Method: PUT with data type application/json returns HTTP 201 (created) on success.</p>
+<p>Data: The fact schema is sent as the PUT payload in JSON-LD format as a JSON-LD profile. The name of the fact is given by the URL. The elements of the schema are defined in the "#types" section of the JSON-LD "#context". Each element is specified using a unique role name for that entity plus the entity type specified by an URN.</p>
+<p>Example 1: PUT /factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf with the following data</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/"</span><span class="p">,</span>
+ <span class="s">"#types"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"person"</span> <span class="p">:</span> <span class="s">"iks:person"</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"iks:organization"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>will create the new fact schema for "employeeOf" at the given URL which is in decoded representation: /factstore/facts/http://iks-project.eu/ont/employeeOf</p>
+<p>Instead one can use the cURL tool for this. Store the fact schema in a JSON file and then use this command.</p>
+<div class="codehilite"><pre><span class="n">curl</span> <span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/factstore/</span><span class="n">facts</span><span class="o">/</span><span class="n">http</span><span class="nv">%3A%2F%2Fiks</span><span class="o">-</span><span class="n">project</span><span class="o">.</span><span class="n">eu</span><span class="nv">%2Font%2FemployeeOf</span> <span class="o">-</span><span class="n">T</span> <span class="n">spec</span><span class="o">-</span><span class="n">example1</span><span class="o">.</span><span class="n">json</span>
+</pre></div>
+
+
+<p>Example 2: PUT /factstore/facts/http%3A%2F%2Fwww.schema.org%2FEvent.attendees with the following data</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"sorg"</span> <span class="p">:</span> <span class="s">"http://www.schema.org/"</span><span class="p">,</span>
+ <span class="s">"#types"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"event"</span> <span class="p">:</span> <span class="s">"sorg:Event"</span><span class="p">,</span>
+ <span class="s">"attendee"</span> <span class="p">:</span> <span class="p">[</span><span class="s">"sorg:Person"</span><span class="p">,</span><span class="s">"sorg:Organization"</span><span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>will create the new fact schema for "attendees" at the given URL which is in decoded representation: /factstore/facts/http://www.schema.org/Event.attendees.</p>
+<p>''Note'': This fact schema uses the ability to define more than one possible type for a role. The role 'attendee' can be of type http://www.schema.org/Person or http://www.schema.org/Organization.</p>
+<h3 id="get-fact-schema">Get Fact Schema</h3>
+<p>Allows clients to get the definition of an existing fact schema.</p>
+<p>Path: /factstore/facts/{fact-schema-name}</p>
+<p>Method: GET with data type application/json returns HTTP 200 on success.</p>
+<p>Data: The fact schema is returned as a JSON-LD profile.</p>
+<p>Example: GET /factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf will return the following data:</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"#types"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"person"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/person"</span><span class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/organization"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Status: <strong>Implemented</strong></p>
+<h3 id="publish-new-facts">Publish New Facts</h3>
+<p>Allows clients to publish a new facts according to a defined fact schema that was previously published to the FactStore. Each new fact is an n-tuple according to its schema where each tuple element identifies an entity using its unique IRI.</p>
+<p>Path: /factstore/facts</p>
+<p>Method: POST with data type application/json returns HTTP 201 (created) on success.</p>
+<p>Data: The facts are sent as the POST payload in JSON-LD format referring to the defined JSON-LD profile. The name of the fact is given in the "@profile" element of the JSON-LD object. The JSON-LD object contains a list of facts under the attribute "facts" where each element of that list is an n-tuple of entity instances according to fhe fact schema. The instance of an entity can be specified either by its unique IRI or by specifying the instance by example.</p>
+<p>Using the instance by example variant requires the FactStore to resolve the entity in an EntityHub. An entity by example is specified by defining attributes and required values of the searched entity. A fact can only be stored if all entities can be uniquely identified either by their IRI or by example.</p>
+<p>Example 1: POST /factstore/facts with the following data</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/"</span><span class="p">,</span>
+ <span class="s">"upb"</span> <span class="p">:</span> <span class="s">"http://upb.de/persons/"</span>
+ <span class="p">},</span>
+ <span class="s">"@profile"</span> <span class="p">:</span> <span class="s">"iks:employeeOf"</span><span class="p">,</span>
+ <span class="s">"person"</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="p">:</span> <span class="s">"upb:bnagel"</span> <span class="p">},</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="p">:</span> <span class="s">"http://uni-paderborn.de"</span><span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>creates a new fact of type http://iks-project.eu/ont/employeeof specifying that the person http://upb.de/persons/bnagel is employee of the organization defined by the IRI http://uni-paderborn.de.</p>
+<p>Example 2: POST /factstore/facts with the following data to create several facts of the same type at once</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="o">:</span> <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="o">:</span> <span class="s">"http://iks-project.eu/ont/"</span><span class="p">,</span>
+ <span class="s">"upb"</span> <span class="o">:</span> <span class="s">"http://upb.de/persons/"</span>
+ <span class="p">},</span>
+ <span class="s">"@profile"</span> <span class="o">:</span> <span class="s">"iks:employeeOf"</span><span class="p">,</span>
+ <span class="s">"@"</span> <span class="o">:</span> <span class="p">[</span>
+ <span class="p">{</span> <span class="s">"person"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"upb:bnagel"</span> <span class="p">},</span>
+ <span class="s">"organization"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"http://uni-paderborn.de"</span> <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"person"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"upb:fchrist"</span> <span class="p">},</span>
+ <span class="s">"organization"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"http://uni-paderborn.de"</span> <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>creates two new facts of type http://iks-project.eu/ont/employeeof specifying that the persons http://upb.de/persons/bnagel and http://upb.de/persons/fchrist are employees of the organization defined by the IRI http://uni-paderborn.de.</p>
+<p>Example 3: POST /factstore/facts with the following data to create several facts of different type</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="o">:</span> <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="o">:</span> <span class="s">"http://iks-project.eu/ont/"</span><span class="p">,</span>
+ <span class="s">"upb"</span> <span class="o">:</span> <span class="s">"http://upb.de/persons/"</span>
+ <span class="p">},</span>
+ <span class="s">"@"</span> <span class="o">:</span> <span class="p">[</span>
+ <span class="p">{</span> <span class="s">"@profile"</span> <span class="o">:</span> <span class="s">"iks:employeeOf"</span><span class="p">,</span>
+ <span class="s">"person"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"upb:bnagel"</span> <span class="p">},</span>
+ <span class="s">"organization"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"http://uni-paderborn.de"</span> <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"@profile"</span> <span class="o">:</span> <span class="s">"iks:friendOf"</span><span class="p">,</span>
+ <span class="s">"person"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"upb:bnagel"</span> <span class="p">},</span>
+ <span class="s">"friend"</span> <span class="o">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="o">:</span> <span class="s">"upb:fchrist"</span> <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>creates two new facts. The first one of type http://iks-project.eu/ont/employeeof specifying that the person http://upb.de/persons/bnagel is employee of the organization defined by the IRI http://uni-paderborn.de. The second of type http://iks-project.eu/ont/friendOf specifying that http://upb.de/persons/fchrist is a friend of http://upb.de/persons/bnagel.</p>
+<p>Status: <strong>Implemented</strong></p>
+<h2 id="query-interface">Query Interface</h2>
+<p>The query interface allows clients to query for facts and combination of facts (reasoning). The JSON-LD query structure is inspired by SQL using SELECT FROM [JOIN] WHERE constructs. Depending on the implementation the JSON-LD queries may be transformed directly into valid SQL queries.</p>
+<h3 id="query-for-facts-of-a-certain-type">Query for Facts of a Certain Type</h3>
+<p>Allows clients to query stored facts of a specific type defined by the fact's schema. The clients specify the desired fact plus an arbitrary number of entities that play some role in the fact.</p>
+<p>Path: /factstore/query</p>
+<p>Method: POST with data type application/json returns application/json</p>
+<p>Data: The query is specified by a JSON-LD object in the payload of the request. The query defines a "select" to specify the desired type of result to be returned in the result set. The "from" part specifies the fact type to query and the "where" clause specifies constraints to be fulfilled.</p>
+<p><em>Note</em>: For the moment constraints only support the equals "=" relation. There may be more relations like ">" in future versions of this specification. If there is more than one constraint all constraints are concatenated by "AND".</p>
+<p>Example 1: POST /factstore/query with the following data</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/"</span>
+ <span class="p">},</span>
+ <span class="s">"select"</span> <span class="p">:</span> <span class="p">[</span> <span class="s">"person"</span> <span class="p">],</span>
+ <span class="s">"from"</span> <span class="p">:</span> <span class="s">"iks:employeeOf"</span><span class="p">,</span>
+ <span class="s">"where"</span> <span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"="</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="p">:</span> <span class="s">"http://uni-paderborn.de"</span> <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>returns the list of all persons participating in the fact of type http://iks-project.eu/ont/employeeOf where the organization is http://uni-paderborn.de. The result is sent back in JSON-LD format with the result set specified by the select clause.</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@subject"</span> <span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"@subject"</span> <span class="p">:</span> <span class="s">"_bnode1"</span><span class="p">,</span>
+ <span class="s">"PERSON"</span> <span class="p">:</span> <span class="s">"http://upb.de/persons/gengels"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"@subject"</span> <span class="p">:</span> <span class="s">"_bnode2"</span><span class="p">,</span>
+ <span class="s">"PERSON"</span> <span class="p">:</span> <span class="s">"http://upb.de/persons/ssauer"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"@subject"</span> <span class="p">:</span> <span class="s">"_bnode3"</span><span class="p">,</span>
+ <span class="s">"PERSON"</span> <span class="p">:</span> <span class="s">"http://upb.de/persons/bnagel"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"@subject"</span> <span class="p">:</span> <span class="s">"_bnode4"</span><span class="p">,</span>
+ <span class="s">"PERSON"</span> <span class="p">:</span> <span class="s">"http://upb.de/persons/fchrist"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>If there is only one entry in the result set, this would be returned as follows.</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"PERSON"</span> <span class="p">:</span> <span class="s">"http://upb.de/persons/fchrist"</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Status: <strong>Example 1 is implemented</strong>.</p>
+<p>Example 2: GET /factstore/query?q= with the following data as the request parameter "q"</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/"</span>
+ <span class="p">},</span>
+ <span class="s">"select"</span> <span class="p">:</span> <span class="p">[</span>
+ <span class="s">"person.name"</span><span class="p">,</span> <span class="s">"person.email"</span>
+ <span class="p">],</span>
+ <span class="s">"from"</span> <span class="p">:</span> <span class="s">"iks:employeeOf"</span><span class="p">,</span>
+ <span class="s">"where"</span> <span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"="</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"organization"</span> <span class="p">:</span> <span class="p">{</span> <span class="s">"@iri"</span> <span class="p">:</span> <span class="s">"http://upb.de"</span> <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>returns a list with names and e-mail addresses of all persons participating in the fact of type http://iks-project.eu/ont/employeeOf where the organization is http://upb.de. The result is sent back in JSON-LD format with the result set specified by the select clause.</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"resultset"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span> <span class="s">"person.name"</span> <span class="p">:</span> <span class="s">"Gregor Engels"</span><span class="p">,</span>
+ <span class="s">"person.email"</span><span class="p">:</span> <span class="s">"engels@upb.de"</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"person.name"</span> <span class="p">:</span> <span class="s">"Stefan Sauer"</span><span class="p">,</span>
+ <span class="s">"person.email"</span><span class="p">:</span> <span class="s">"sauer@upb.de"</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"person.name"</span> <span class="p">:</span> <span class="s">"Benjamin Nagel"</span><span class="p">,</span>
+ <span class="s">"person.email"</span><span class="p">:</span> <span class="s">"nagel@upb.de"</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"person.name"</span> <span class="p">:</span> <span class="s">"Fabian Christ"</span><span class="p">,</span>
+ <span class="s">"person.email"</span><span class="p">:</span> <span class="s">"christ@upb.de"</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Status: <strong>Example 2 is NOT Implemented, yet.</strong></p>
+<h3 id="query-for-combinations-of-facts">Query for Combinations of Facts</h3>
+<p>Allows clients to query for combinations of facts.</p>
+<p>Path: /factstore/query?q=</p>
+<p>Method: GET with data type application/json returns application/json</p>
+<p>Data: The query is specified by a JSON-LD object in request parameter "q" of the request. The query defines a "select" to specify the desired type of result to be returned in the result set. Instead of using a "from" part this type of query supports joins over facts using the "join" field. The "join" field specifies which facts are joined by specifying the elements of the facts that are evaluated to be equal during the join. The "where" clause specifies constraints over the join to be fulfilled.</p>
+<p><em>Note</em>: For the moment constraints only support the equals "=" relation. There may be more relations like ">" in future versions of this specification. If there is more than one constraint all constraints are concatenated by "AND".</p>
+<p>Example: GET /factstore/query?q= with the following request data in request parameter "q"</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/"</span>
+ <span class="p">},</span>
+ <span class="s">"select"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"iks:friendOf.friend.name"</span>
+ <span class="p">],</span>
+ <span class="s">"join"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks:employeeOf.person"</span> <span class="p">:</span> <span class="s">"iks:friendOf.person"</span>
+ <span class="p">},</span>
+ <span class="s">"where"</span> <span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"="</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks:employeeOf.organization"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"@iri"</span> <span class="p">:</span> <span class="s">"http://upb.de"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"="</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks:friendOf.friend.city"</span> <span class="p">:</span> <span class="s">"Paderborn"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>will return a list of names of all the friends living in Paderborn of the employees of the University of Paderborn. The result in JSON-LD format would look like the following.</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s">"iks"</span> <span class="p">:</span> <span class="s">"http://iks-project.eu/ont/"</span>
+ <span class="p">},</span>
+ <span class="s">"resultset"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span> <span class="s">"iks:friendOf.friend.name"</span> <span class="p">:</span> <span class="s">"Schmidt"</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"iks:friendOf.friend.name"</span> <span class="p">:</span> <span class="s">"Meier"</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"iks:friendOf.friend.name"</span> <span class="p">:</span> <span class="s">"Schneider"</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="s">"iks:friendOf.friend.name"</span> <span class="p">:</span> <span class="s">"Schuster"</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Status: <strong>NOT Implemented, yet.</strong></p>
+<hr />
+<p><em>Back to <a href="index.html">FactStore</a></em></p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/faq.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/faq.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/faq.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,86 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - FAQ for Apache Stanbol users </title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">FAQ for Apache Stanbol users </h1>
+ <h2 id="can-i-update-the-default-dbpedia-index-with-a-bigger-one">Can I update the default DBpedia index with a bigger one?</h2>
+<p>Yes, you can just copy such an index from <a href="http://dev.iks-project.eu/downloads/stanbol-indices/">here</a> into the sling/datafiles directory. It will be initialized automatically.</p>
+<h2 id="how-about-language-support-of-enhancement-engines">How about language support of enhancement engines?</h2>
+<ul>
+<li>The Named Entity Recognition Engine has support for English.</li>
+<li>The Keyword Linking Engine has support for English, German, Danish, Dutch and Portuguese.
+<em><a href="multilingual.html">Check "Working with multiple languages"</a></em></li>
+</ul>
+<h2 id="can-i-use-my-own-vocabulary-as-linking-target">Can I use my own vocabulary as linking target?</h2>
+<p>Yes, Stanbol provides you with and indexing tool for creating appropriate indexes for any kind of RDF data, vCard or SKOS vocabularies. <em><a href="customvocabulary.html">Check "Using custom vocabulary"</a></em></p>
+<h2 id="can-i-use-existing-solr-indexes">Can I use existing SOLr indexes?</h2>
+<p>Yes, just provide a link within the org.apache.stanbol.commons.solr.impl.DefaultSolrDirectoryManager.name Bundle to a local directory, where you host the SOLr indexes, in order to reuse.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/features.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/features.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/features.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,92 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - Apache Stanbol features</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Apache Stanbol features</h1>
+ <h2 id="stable-features">Stable features</h2>
+<ul>
+<li>NLP and Named Entity Recognition via <a href="http://incubator.apache.org/opennlp/">Apache OpenNLP</a></li>
+<li>Enhancement engines linking to open data such as dbpedia, geonames, dplb.</li>
+<li>Enhancement engines integrating external services such as zemanta and opencalais.</li>
+<li>Local Indexes of Linked open Data</li>
+<li>RDF management via <a href="http://incubator.apache.org/clerezza/">Apache Clerezza</a></li>
+<li>Various enhancement output serialisations (RDF/XML, JSON-LD, RDF/XML, RDF/JSON, Turtle, N-TRIPLES)</li>
+<li>Language Detection for European Languages</li>
+<li>Extracting embedded metadata and textual content via <a href="http://aperture.sourceforge.net/">Aperture</a></li>
+</ul>
+<h2 id="upcoming-features">Upcoming Features</h2>
+<h2 id="features-whishlist">Features whishlist</h2>
+<ul>
+<li>Multilingual support</li>
+</ul>
+<hr />
+<p><em><a href="index.html">Back to index</a></em></p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/index.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/index.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,99 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - Documentation</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Documentation</h1>
+ <p>This documentation of Apache Stanbol targets at Content Management System (CMS) developers and integrators, who want to use and integrate Apache Stanbol RESTful services into their CMS. Secondly, it is for Apache Stanbol contributors, which are developing Apache Stanbol components and engines.</p>
+<h2 id="documentation-for-cms-developers">Documentation for CMS Developers</h2>
+<ul>
+<li><a href="scenarios.html">Usage Scenarios</a></li>
+<li><a href="components.html">Overview on components and engines</a></li>
+<li><a href="faq.html">FAQ</a></li>
+<li>Demos</li>
+</ul>
+<p><em>Note</em>: In addition to the documentation on this site, every Apache Stanbol instance provides you with live documentation when pointing your browser to the Apache Stanbol start page. It contains further descriptions and the most up-to-date documenation for each component and its RESTful API. Additional technical notes for each component can be found within various README files within the <a href="http://svn.apache.org/repos/asf/incubator/stanbol/trunk/">source code</a>.</p>
+<h2 id="documentation-for-apache-stanbol-for-developers-and-contributors">Documentation for Apache Stanbol for Developers and Contributors</h2>
+<ul>
+<li>Detailed documentation on the <a href="enhancer">Enhancer</a> and <a href="enhancer/engines">Enhancement Engines</a>: develop a new engine!</li>
+<li>How to contribute to software development</li>
+<li>How to work and update documentation</li>
+<li>Proposals for further developments</li>
+</ul>
+<h2 id="how-to-get-involved">How to get involved</h2>
+<ul>
+<li>
+<p>Subscribe to the Apache Stanbol Developers mailinglist by sending an email to <code>stanbol-dev-subscribe AT incubator.apache.org</code>.</p>
+</li>
+<li>
+<p>Please report bugs on the <a href="https://issues.apache.org/jira/browse/STANBOL">Apache issue tracker</a></p>
+</li>
+</ul>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/mailinglists.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/mailinglists.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/mailinglists.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,83 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - How to get involved</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">How to get involved</h1>
+ <p>The dev mailing list is where the action is, so make sure you subscribe to the Stanbol developers mailing list by sending an email to <code>stanbol-dev-subscribe AT incubator.apache.org</code> .</p>
+<p>We don't have a users mailing list at this time, we'll create it if traffic becomes too high on the dev list. User questions are welcome on the dev list for now.</p>
+<p>Mailing list archives are available at <a href="http://mail-archives.apache.org/mod_mbox/">mail-archives.apache.org</a>,
+<a href="http://markmail.org/search/?q=list:org.apache.incubator.stanbol-*">markmail.org</a> and the other usual places.</p>
+<p>Additional mailing lists:</p>
+<ul>
+<li><code>stanbol-commits AT incubator.apache.org</code> : commit messages</li>
+<li><code>stanbol-private AT incubator.apache.org</code> : private list for Stanbol PPMC members</li>
+</ul>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/multilingual.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/multilingual.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/0.9.0-incubating/multilingual.html Wed Apr 11 08:30:47 2012
@@ -0,0 +1,133 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - Configure Apache Stanbol to work with multiple languages</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220" height="101" border="0" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL">Issue Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Configure Apache Stanbol to work with multiple languages</h1>
+ <p>The following languages are supported -</p>
+<ul>
+<li>English</li>
+<li>German</li>
+<li>Danish</li>
+<li>Swedish</li>
+<li>Dutch</li>
+<li>Portuguese</li>
+</ul>
+<h2 id="configuration-steps">Configuration steps</h2>
+<ul>
+<li>Have language labels in your target data and install the index</li>
+<li>Add language models to your Stanbol instance</li>
+<li>Activate the LangIdEnhancementEngine and the KeywordLinkingEngine</li>
+<li>Configure the KeywordLinkingEngine</li>
+</ul>
+<h3 id="install-your-index">Install your index</h3>
+<p>In DBpedia, there exist language labels for many entities. In case you want to use an index of your custom vocabulary, first <a href="customvocabulary.html">create the index</a> from it and add the index to your stanbol instance. Simply paste the <code>{yourindex}.solr.zip</code> into your <code>{stanbol-root}/sling/datafiles</code> directory and install the respective OSGI bundle at your OSGI admin console.</p>
+<p>Make sure, that this index contains language labels in all languages you want to work with and that they are properly indexed.</p>
+<h3 id="build-and-add-the-necessary-language-bundles">Build and add the necessary language bundles</h3>
+<p>To build the language bundles go to "{stanbol-root}/data/" and call</p>
+<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">clean</span> <span class="n">install</span> <span class="o">-</span><span class="n">P</span> <span class="n">opennlp</span>
+</pre></div>
+
+
+<p>This enables the profile to build the OpenNLP models for all languages.</p>
+<p>After this the bundles are available in the folder</p>
+<div class="codehilite"><pre><span class="p">{</span><span class="n">stanbol</span><span class="o">-</span><span class="n">root</span><span class="p">}</span><span class="sr">/data/o</span><span class="n">pennlp</span><span class="sr">/lang/</span><span class="p">{</span><span class="n">language</span><span class="p">}</span><span class="o">/</span><span class="n">target</span>
+</pre></div>
+
+
+<p>The naming of the bundles is "org.apache.stanbol.data.opennlp.lang.{language}-*.jar".</p>
+<p>Add the bundles via the OSGI admin console in the bundles tab. The language bundles will fetch and install the according <a href="http://dev.iks-project.eu/downloads/opennlp/models-1.5/">OpenNLP</a> models for the languages you want to use.</p>
+<h3 id="activate-langid-engine-and-keywordlinkingengine">Activate LangID engine and KeywordLinkingEngine</h3>
+<p>Go to the admin console and deactivate some of the available engines. Especially the standard NER engine and the Entity Linking Engines should be deactivated, as they do not support multiple languages. At least two engines need to be activated:</p>
+<ul>
+<li>The <a href="enhancer/engines/langidengine.html">Language Identification Engine</a> provides you with the language of the text you want to enhance, it creates a dc:terms languaage property. The </li>
+<li>The <a href="enhancer/engines/keywordlinkingengine.html">Keyword Linking Engine</a> provides you with the TextAnnotations (selects potential parts of your text) as well as with EntitiyAnnotations (provides suggestions for links). Be aware, that the result (especially the recall) heavily depends on the amount of entities you have specified in your target data source.</li>
+</ul>
+<h3 id="configure-the-keywordlinkingengine">Configure the KeywordLinkingEngine</h3>
+<p>At the OSGI admin console, you can get the most relevant configuration options of the Keyword Linking Engine.</p>
+<ul>
+<li><strong>Referenced Site:</strong> The ID of the Entityhub Referenced Site holding the Controlled Vocabulary (e.g. a taxonomy or just a set of named entities) </li>
+<li><strong>Label Field:</strong> The field used to match Entities with a mentions within the parsed text.</li>
+<li><strong>Type Field:</strong> The field used to retrieve the types of matched Entities. Values of that field are expected to be URIs </li>
+<li><strong>Redirect Field:</strong> Entities may define redirects to other Entities (e.g. "USA"(http://dbpedia.org/resource/USA) -> "United States"(http://dbpedia.org/resource/United_States). Values of this field are expected to link to other entities part of the controlled vocabulary</li>
+<li><strong>Redirect Mode:</strong> Defines how to process redirects of Entities mentioned in the parsed content.. Three modes to deal with such links are supported: Ignore redirects; Add values from redirected Entities to extracted; Follow Redirects and suggest the redirected Entity instead of the extracted. </li>
+<li><strong>Min Token Length:</strong> The minimum length of Tokens used to lookup Entities within the Controlled Vocabulary. This parameter is ignored in case a POS (Part of Speech) tagger is available for the language of the parsed content.</li>
+<li><strong>Suggestions:</strong> The maximal number of suggestions returned for a single mention. (org.apache.stanbol.enhancer.engines.keywordextraction.maxSuggestions)
+Languages <br />
+</li>
+<li><strong>Languages to process:</strong> An empty text indicates that all languages are processed. Use ',' as separator for languages (e.g. 'en,de' to enhance only English and German texts). </li>
+<li><strong>Default Matching Language:</strong> The language used in addition to the language detected for the analysed text to search for Entities. Typically this configuration is an empty string to search for labels without any language defined, but for some data sets (such as DBpedia.org) that add languages to any labels it might improve resuls to change this configuration (e.g. to 'en' in the case of DBpedia.org).</li>
+</ul>
+<p>Read the technical description of this <a href="enhancer/engines/keywordlinkingengine.html">Enhancement Engine</a> to learn about more configuration options.</p>
+<h2 id="results">Results</h2>
+<p>Depending on your linking target dataset - the engine provides you with enhancement suggestions using labels in your chosen language(s). Note: In the actual version of the DBpedia index, the link directs to the english version of the resource.</p>
+<h2 id="examples">Examples</h2>
+<p>This <a href="http://blog.iks-project.eu/apache-stanbol-now-with-multi-language-support/">article</a> from October 2011 describes how to deal with multilingual texts.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>