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 2011/12/01 16:55:17 UTC
svn commit: r799551 - in
/websites/staging/stanbol/trunk/content/stanbol/docs/trunk: components.html
enhancer.html factstore.html index.html ontonet.html rules.html
Author: buildbot
Date: Thu Dec 1 15:55:15 2011
New Revision: 799551
Log:
Staging update by buildbot
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/ontonet.html
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/rules.html
Added: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components.html Thu Dec 1 15:55:15 2011
@@ -0,0 +1,96 @@
+<!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 RESTful Services and Components</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">
+ <img alt="Apache Stanbol" width="220" height="101" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/>
+ <h1 id="stanbol_links">Stanbol links</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</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 RESTful Services and Components</h1>
+ <p>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.</p>
+<ul>
+<li>
+<p>The <a href="enhancer.html">Enhancer</a> component together with its <a href="engines.html">Enhancement Engines</a> provides you with the ability to post content to Stanbol and get suggestions for possible entity annotation in return.</p>
+</li>
+<li>
+<p>The <a href="entityhub.html">Entityhub</a> 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).</p>
+</li>
+<li>
+<p>The <a href="contenthub.html">Contenthub</a> provides you with an combined index of your content items together with enhancements to facilitate semantic search on your entire knowledge base.</p>
+</li>
+<li>
+<p>The <a href="cmsadapter.html">CMS Adapter</a> can be used to map (bidirectionally) existing node structures from content repositories (CMIS) to RDF models.</p>
+</li>
+<li>
+<p>The <a href="rules.html">Rules</a> component provides you with the means to re-factor knowledge graphs, e.g. for supporting the schema.org vocabulary for Search Engine Optimization. </p>
+</li>
+<li>
+<p>The <a href="reasoners.html">Reasoners</a> 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.</p>
+</li>
+<li>
+<p>The <a href="ontonet.html">Ontology Manager</a> 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.</p>
+</li>
+<li>
+<p>The <a href="factstore.html">FactStore</a> is a component that let's use store relations between entities identified by their URIs. This relation between two entities is called a <em>fact</em>.</p>
+</li>
+<li>
+<p>The 'Sparql endpoint' gives access to the semantic enhancements form the Stanbol Enhancer.</p>
+</li>
+<li>
+<p>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.</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>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer.html Thu Dec 1 15:55:15 2011
@@ -94,10 +94,6 @@
<span class="o">--</span><span class="n">data</span> <span class="s">"John Smith was born in London."</span> <span class="o">\</span>
<span class="s">"http://localhost:8080/engines?uri=urn:fise-example-content-item"</span>
</pre></div>
-
-
-<hr />
-<p><em><a href="index.html">Back to index</a></em></p>
</div>
<div id="footer">
Added: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore.html Thu Dec 1 15:55:15 2011
@@ -0,0 +1,104 @@
+<!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">
+ <img alt="Apache Stanbol" width="220" height="101" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/>
+ <h1 id="stanbol_links">Stanbol links</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</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. In consequence you can store relations between N participating entities.</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 http://schema.org/.</p>
+<p>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:</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 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.</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>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/index.html Thu Dec 1 15:55:15 2011
@@ -46,7 +46,7 @@
<div id="content">
<h1 class="title">Apache Stanbol - services for semantic content management</h1>
- <p>The documentation of its services and components can be retrieved from different places:</p>
+ <p>The documentation of Apache Stanbol and its services and components can be retrieved from different places:</p>
<ol>
<li>
<p>Below, you get the description how to build, install and run Apache Stanbol, its major features as well as scenarios how to use it.</p>
Added: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/ontonet.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/ontonet.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/ontonet.html Thu Dec 1 15:55:15 2011
@@ -0,0 +1,89 @@
+<!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 - Ontology Manager</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">
+ <img alt="Apache Stanbol" width="220" height="101" src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/>
+ <h1 id="stanbol_links">Stanbol links</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</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">Ontology Manager</h1>
+ <p>The Stanbol OntoNet is a controlled environment for managing ontologies and ontology networks and user sessions managing them. </p>
+<h2 id="restful_api">RESTful API</h2>
+<p>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:</p>
+<ul>
+<li>
+<p>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.</p>
+</li>
+<li>
+<p>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).</p>
+</li>
+<li>
+<p>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.</p>
+</li>
+</ul>
+<h3 id="sub-components">Sub-Components</h3>
+<ul>
+<li>'ontonet' - allows to construct subsets of the knowledge base
+ managed by Stanbol into OWL/OWL2 ontology networks</li>
+<li>'registry' - manages ontology libraries for bootstrapping the network
+ using both external and internal ontologies</li>
+<li>'store' - create, read, update and modify operations on single
+ ontologies stored in Stanbol</li>
+<li>'web' - the RESTful Web Service interface for OntoNet</li>
+</ul>
+<h2 id="examples">Examples</h2>
+<p>TODO</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>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/rules.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/rules.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/rules.html Thu Dec 1 15:55:15 2011
@@ -51,7 +51,8 @@
<h2 id="rule_language">Rule Language</h2>
<p>Rules are written in the <a href="rules/language.html">Stanbol Rule</a> language and can be interpreted either as SWRL rules (for classical Description Logic reasoning) or SPARQL CONSTRUCT queries (for RDF querying and transformation).</p>
<h2 id="service_endpoints">Service Endpoints</h2>
-<p>The Rules RESTful API is structured as follows:</p>
+<p>The Rules RESTful API is structured as follows:
+<em>(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)</em></p>
<h3 id="rule_manager_rulesrule">Rule Manager ("/rules/rule"):</h3>
<ul>
<li>The Rule Manager @ <a href="http://localhost:8080/rules/rule">/rules/rule</a> allows to manage and retrieve inference rules.</li>