You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by si...@apache.org on 2012/02/07 10:57:10 UTC
svn commit: r804090 - in /websites/production/stanbol: ./
content/stanbol/docs/trunk/components.html
content/stanbol/docs/trunk/contenthub/contenthub5min.html
content/stanbol/docs/trunk/contenthub/index.html
Author: sinaci
Date: Tue Feb 7 09:57:10 2012
New Revision: 804090
Log:
1 minute and 5 minutes tutorials for Contenthub
Added:
websites/production/stanbol/content/stanbol/docs/trunk/contenthub/contenthub5min.html
- copied unchanged from r804089, websites/staging/stanbol/trunk/content/stanbol/docs/trunk/contenthub/contenthub5min.html
Modified:
websites/production/stanbol/ (props changed)
websites/production/stanbol/content/stanbol/docs/trunk/components.html
websites/production/stanbol/content/stanbol/docs/trunk/contenthub/index.html
Propchange: websites/production/stanbol/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Feb 7 09:57:10 2012
@@ -1 +1 @@
-/websites/staging/stanbol/trunk:779452-804080
+/websites/staging/stanbol/trunk:779452-804089
Modified: websites/production/stanbol/content/stanbol/docs/trunk/components.html
==============================================================================
--- websites/production/stanbol/content/stanbol/docs/trunk/components.html (original)
+++ websites/production/stanbol/content/stanbol/docs/trunk/components.html Tue Feb 7 09:57:10 2012
@@ -84,13 +84,14 @@
<p>The <a href="ontologymanager.html">Ontology Manager</a> is the facility that manages your ontologies. Ontologies are used to define the knowledge models that describe the metadata of content. Additionally, the semantics of your metadata can be defined through an ontology.</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>
+<p>The <a href="cmsadapter.html">CMS Adapter</a> CMS Adapter component acts as a bridge between JCR/CMIS compliant content management systems and the Apache Stanbol. It can be used to map existing node structures from JCR/CMIS content repositories to RDF models or vica versa. It also provides services for the management of content repository items as <a href="enhancer/contentitem.html">Content Item</a>s within Contenthub.</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/">Contenthub</a> provides you with a combined index of your content items together with enhancements to facilitate semantic search on your entire knowledge base.</p>
+<p>The <a href="contenthub/">Contenthub</a> is the component which provides persistent document store whose back-end is Apache Solr. On top of the store, it enables semantic indexing facilities during text based document submission
+and semantic search together with faceted search capability on the documents.</p>
</li>
<li>
<p>The <a href="factstore/">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>
Modified: websites/production/stanbol/content/stanbol/docs/trunk/contenthub/index.html
==============================================================================
--- websites/production/stanbol/content/stanbol/docs/trunk/contenthub/index.html (original)
+++ websites/production/stanbol/content/stanbol/docs/trunk/contenthub/index.html Tue Feb 7 09:57:10 2012
@@ -20,7 +20,7 @@
-->
<link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
- <title>Apache Stanbol - ContentHub</title>
+ <title>Apache Stanbol - Contenthub (1 minute tutorial)</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>
@@ -56,50 +56,54 @@
</div>
<div id="content">
- <h1 class="title">ContentHub</h1>
- <p>The Apache Stanbol Contenthub is a persistent document store which enables text based document submission
-and semantic search together with faceted search capability on submitted documents.</p>
-<h2 id="technical_description_of_its_components">Technical Description of its components</h2>
-<h3 id="contenthub_store">ContentHub Store</h3>
-<p>It is the subcomponent that actually stores the document and its metadata persistently. In current implementation only text/plain documents are allowed.</p>
-<p>The storage part of the Contenthub provide basic methods such as create, put, get and delete. When a document is submitted, it delegates the textual content to Stanbol Enhancer to get its enhancements. While submitting the document, it is also possible to specify external metadata as field value pairs to the document. </p>
-<p>The document itself and all specified external metadata are indexed through an embedded Apache Solr core which is created specifically for Contenthub.
-Since documents are given unique IDs while indexing, using its unique ID, a document can be retrieved or deleted from Contenthub.
-ContentHub provides an HTML interface for its functionalities under the following endpoint, which is available after running the full launcher of Apache Stanbol:</p>
+ <h1 class="title">Contenthub (1 minute tutorial)</h1>
+ <p>The Apache Stanbol Contenthub is an Apache Solr based document repository which enables
+storage of text-based documents and customizable semantic search facilities.
+Contenthub exposes an efficient Java API together with the corresponding RESTful services. </p>
+<p>Apache Stanbol comes with several launchers.
+If you build Stanbol from its source with the following command</p>
+<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">clean</span> <span class="n">install</span>
+</pre></div>
+
+
+<p>You can find all launchers under the launchers directory. Contenthub is currently included in
+the full launcher of Apache Stanbol. That is, you can make use of Contenthub services if you
+run the full launcher. </p>
+<p>To run the full launcher of Apache Stanbol, go to the directory of full launcher and run the
+jar file under the target directory</p>
+<div class="codehilite"><pre><span class="n">cd</span> <span class="p">{</span><span class="n">stanbol</span><span class="p">}</span><span class="sr">/launchers/</span><span class="n">full</span>
+<span class="n">java</span> <span class="o">-</span><span class="n">Xmx1g</span> <span class="o">-</span><span class="n">jar</span> <span class="n">target</span><span class="o">/</span><span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">stanbol</span><span class="o">.</span><span class="n">launchers</span><span class="o">.</span><span class="n">full</span><span class="o">-</span><span class="p">{</span><span class="n">snapshot</span><span class="o">-</span><span class="n">version</span><span class="p">}</span><span class="o">-</span><span class="n">incubating</span><span class="o">-</span><span class="n">SNAPSHOT</span><span class="o">.</span><span class="n">jar</span>
+</pre></div>
+
+
+<p>Your Stanbol instance is running under {stanbol}/launchers/full/sling and Contenthub is accessible at</p>
<div class="codehilite"><pre><span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="o">/</span><span class="n">contenthub</span>
</pre></div>
-<h3 id="contenthub_search">ContentHub Search</h3>
-<p>ContentHub has a semantic search subcomponent that allows search over the submitted documents. A HTML interface for search functionality can be reached under:</p>
-<div class="codehilite"><pre><span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/contenthub/s</span><span class="n">earch</span>
+<p>Contenthub is divided into Store and Search subcomponents. The link above will be automatically redirected to </p>
+<div class="codehilite"><pre><span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/contenthub/co</span><span class="n">ntenthub</span><span class="o">/</span><span class="n">store</span>
</pre></div>
-<p>To start a search, one enters a keyword and choose the search engines that will execute the query. After having the first search results, all facets and values of these facets will also arrive. Later on, when a facet constraint is chosen, documents and facets will be dynamically updated according to chosen constraint(s).</p>
-<p>The Contenthub Search API also provides a means of specifying an ontology which carries semantic information to make the search more semantic. How this external ontology is exploited is explained within the search engine documentation below. Furthermore, Search API enables specifying constraints for the search operation. The aim is to provide faceted search functionality through Java interface based on the specified constraints.<br />
-</p>
-<p>The search part of this component is formed by several search engines that work sequentially and contribute to the search results. Each search engine works with a given search context. The initialization of the search context is performed before the execution of any search engine. Each search engine makes use of the information embedded in the search context and populates the context with new results, such as resulting documents, related ontological resources, new keywords etc ...</p>
-<p>Currently, three search engines are active in search subcomponent:</p>
-<h4 id="ontology_resource_search_engine">Ontology Resource Search Engine</h4>
-<p>This engine works when an additional ontology is specified at the beginning of the search. A SPARQL query based on a LARQ index is executed on the specified ontology to find individuals and classes related with the keyword. When a class is found, it is added to search the context as a related class resource and then, subclasses, superclasses and instances of all these classes are found and added to the search context.</p>
-<p>When an individual about keyword is found it is added as a related individual resource to search context and it's classes are found. These classes are added to the search context using the same methodology explained in the previous paragraph.</p>
-<h4 id="enhancement_search_engine">Enhancement Search Engine</h4>
-<p>This engine designed to work on enhancement graph which contains all enhancements of content items submitted to the Contenthub. </p>
-<p>When a document is submitted to ContentHub, its content is enhanced automatically by Enhancer component.
-In a single Clerezza graph, all the enhancements are kept together and this graph is indexed with LARQ. The LARQ index is automatically updated when a new enhancement is added.</p>
-<p>Enhancement Search Engine, executes a SPARQL query on enhancement graph to find enhancements about the given keyword.
-When an enhancement is found, the document from which the enhancement was obtained is added to search context as a related document resource.</p>
-<h4 id="solr_search_engine">SOLr Search Engine</h4>
-<p>The <a href="">SOLr</a> Search Engine is the engine that gives full-text and faceted search capabilities to the Contenthub.</p>
-<p>Since every document is indexed to SOLr (to the core created for Contenthub), it is possible to do full-text
-search over documents' content and metadata. After the first search, all the facet constraints of resulting documents will be available for faceted search. When a facet constraint is chosen, resulting documents and facet constraints are updated dynamically. </p>
-<p>Later on, related class and individual resources about the keyword, which are found by Ontology Resource Search Engine, are searched over SOLr using their resource name. </p>
-<p>After all, document resources founded by Enhancement Search Engine is examined. If there is a document whose field values does not match with facet constraints, these document resources are removed from the search results.</p>
-<h2 id="building_and_launching_contenthub">Building and Launching ContentHub</h2>
-<p>Since ContentHub is built with Apache Stanbol it can be launched under "Full Launcher". For detailed instructions to build and launch Apache Stanbol see the README file through the following link:</p>
-<div class="codehilite"><pre><span class="n">http:</span><span class="sr">//s</span><span class="n">vn</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/repos/</span><span class="n">asf</span><span class="sr">/incubator/s</span><span class="n">tanbol</span><span class="sr">/trunk/</span><span class="n">README</span><span class="o">.</span><span class="n">md</span>
+<p>You can submit text content (sending in the payload of an HTTP POST request) with the following command</p>
+<div class="codehilite"><pre><span class="n">curl</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">X</span> <span class="n">POST</span> <span class="o">-</span><span class="n">H</span> <span class="s">"Content-Type:text/plain"</span> <span class="o">--</span><span class="n">data</span> <span class="s">"I live in Istanbul."</span> <span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/contenthub/co</span><span class="n">ntenthub</span><span class="o">/</span><span class="n">store</span>
</pre></div>
+
+
+<p>Contenthub provides different search interfaces. You can directly query the Solr backend as follows</p>
+<div class="codehilite"><pre><span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/solr/</span><span class="n">default</span><span class="sr">/contenthub/s</span><span class="n">elect</span><span class="p">?</span><span class="sx">q=*:*</span>
+
+<span class="sx">http://localhost:8080/solr/default/contenthub/select?q=</span><span class="n">turkey</span>
+</pre></div>
+
+
+<p>You can obtain a Contenthub specific search result from the featured search service based on a keyword search. The results can be retrieved in JSON format as in the following command</p>
+<div class="codehilite"><pre><span class="n">curl</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">X</span> <span class="n">GET</span> <span class="o">-</span><span class="n">H</span> <span class="s">"Accept: application/json"</span> <span class="o">-</span><span class="n">H</span> <span class="s">"Content-Type:text/plain"</span> <span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/contenthub/co</span><span class="n">ntenthub</span><span class="sr">/search/</span><span class="n">featured</span><span class="p">?</span><span class="n">queryTerm</span><span class="o">=</span><span class="n">turkey</span>
+</pre></div>
+
+
+<p>Featured search not only returns resulting documents, but also related keywords retrieved from various resources (if the resources are available within the running Stanbol instance)</p>
</div>
<div id="footer">