Author: alexdma
Date: Tue Dec 13 15:27:49 2011
New Revision: 1213737
URL: http://svn.apache.org/viewvc?rev=1213737&view=rev
Log:
ontonet.mdtext renamed to ontologymanager.mdtext , first stub of ontology
registry documentation created (STANBOL-402)
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/registry.mdtext
Removed:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontonet.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext?rev=1213737&r1=1213736&r2=1213737&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
Tue Dec 13 15:27:49 2011
@@ -14,7 +14,7 @@ This is an overview of the major feature
* The [Reasoners](reasoners.html) can be used to automatically infer
additional knowledge. It is used to infer new facts in the knowledge base, e.g.
if you have enhanced your entity "Paris", you can get "France" via a
"located-in" relation.
-* The [Ontology Manager](ontonet.html) is the facility to manage all your
ontologies i.e. the knowledge models you use to describe your metadata of your
content as well as knowledge about the semantics of your content.
+* The [Ontology Manager](ontologymanager.html) is the facility to manage all
your ontologies i.e. the knowledge models you use to describe your metadata of
your content as well as knowledge about the semantics of your content.
* The [FactStore](factstore.html) is a component that let's use store
relations between entities identified by their URIs. This relation between two
entities is called a _fact_.
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager.mdtext?rev=1213737&view=auto
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager.mdtext
(added)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager.mdtext
Tue Dec 13 15:27:49 2011
@@ -0,0 +1,27 @@
+Title: Ontology Manager
+
+The Stanbol Ontology Manager provides a controlled environment for managing
ontologies, ontology networks and user sessions for semantic data modeled after
them. It provides full access to ontologies stored into the Stanbol persistence
layer.
+
+## RESTful API
+
+Stanbol OntoNet implements the API section for managing OWL and OWL2
ontologies, in order to prepare them for consumption by reasoning services,
refactorers, rule engines and the like. Ontology management in ONM is sparse
and not connected: once loaded internally from their remote locations,
ontologies live and are known within the realm they were loaded in. This allows
loose-coupling and (de-)activation of ontologies in order to scale the data
sets for reasoners to process and optimize them for efficiency. The following
concepts have been introduced with the ONM:
+
+* Ontology scope: a "logical realm" for all the ontologies that encompass a
certain CMS-related set of concepts (such as "User", "ACL", "Event", "Content",
"Domain", "Reengineering", "Community", "Travelling" etc.). Scopes never
inherit from each other, though they can load the same ontologies if need be.
+
+* Ontology space: an access-restricted container for synchronized access to
ontologies within a scope. The ontologies in a scope are loaded within its set
of spaces. An ontology scope contains: (a) exactly one core space, which
contains the immutable set of essential ontologies that describe the scope; (b)
exactly one (possibly empty) custom space, which extends the core space
according to specific CMS needs (e.g. the core space for the User scope may
contains alignments to FOAF); (c) zero or more session spaces, which extend the
custom space with additional models provided by end-users (e.g. the set of
individuals that 'populate' a scope may be fed to OntoNet via a session space).
Session spaces are mapped one-to-one with KReS sessions (see below).
+
+* OntoNet session: a container of session spaces for all affected scopes, for
stateful management of ontology networks. It is not equivalent to an HTTP
session (since it can live persistently across multiple HTTP sessions),
although its behaviour can reflect the one of the HTTP session that created it,
if required by the implementation.
+
+### Sub-Components
+
+ - 'ontonet' - allows to construct subsets of the knowledge base
+ managed by Stanbol into OWL/OWL2 ontology networks
+ - [Registry](ontologymanager/registry.html) - manages ontology libraries
for bootstrapping the network
+ using both external and internal ontologies
+ - 'store' - create, read, update and modify operations on single
+ ontologies stored in Stanbol
+ - 'web' - the RESTful Web Service interface for OntoNet
+
+## Examples
+
+TODO
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/registry.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/registry.mdtext?rev=1213737&view=auto
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/registry.mdtext
(added)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/registry.mdtext
Tue Dec 13 15:27:49 2011
@@ -0,0 +1,21 @@
+Title: Ontology Registry Manager
+
+Registry management is a facility of the Ontology Manager that allows Stanbol
__administrators__ to pre-configure sets of ontologies that Stanbol should load
and store, or simply be aware of, __before__ they are included in a part of the
ontology network (e.g. a scope or session). Via the registry manager, it is
possible to configure whether these ontologies should be loaded immediately
when Stanbol is initialized, or only when explicitly requested. The Ontology
Registry Manager is essentially an ontology bookmarker with caching support. It
is also possible to cache multiple versions of the same ontology if needed.
+
+## Glossary
+
+* A __Library__ is a collection of references to ontologies.
+* A __Registry__ is an RDF resource (i.e. an ontology itself) that describes
one or more libraries. It is the physical object that has to be accessed to
gain knowledge about libraries.
+
+## Usage Scenarios
+
+TODO
+
+## Configuration
+
+Ontology registries (and, by extension, the libraries they reference) are
configured by the Stanbol administrator via the Felix Web console.
+
+* Go to the [Felix console Configuration
Manager](http://localhost:8080/system/console/configMgr) and select __Apache
Stanbol Ontology Registry Manager__ (or follow this [direct
link](http://localhost:8080/system/console/configMgr/org.apache.stanbol.ontologymanager.registry.impl.RegistryManagerImpl))
+* Under __Registry locations__ you can add or remove the physical URIs of
ontology registries, i.e. RDF resources that contain knowledge about ontology
libraries.
+* If you wish all the registry contents to be loaded altogether on startup,
uncheck the __lazy ontology loading__ box.
+* You can select one __Caching policy__ between Centralised (default) and
Distributed. In centralised caching, all the libraries that reference an
ontology with the same URI will share the very same version of that ontology.
In distributed caching, each library will reference its own version of each
ontology. Centralised caching is generally recommended, as distributed caching
allows multi-version ontology management, but occupies much more storage space,
depending on the amount of ontologies in common.
\ No newline at end of file