Author: agruber
Date: Fri Dec 2 13:22:58 2011
New Revision: 1209460
URL: http://svn.apache.org/viewvc?rev=1209460&view=rev
Log:
Changed the navigation, added subpages for building, download, tutorial,
scenarios, faq and overview for documentation STANBOL-402
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/downloads.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/faq.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/mailinglists.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext
incubator/stanbol/site/trunk/templates/sidenav.mdtext
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext?rev=1209460&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/building.mdtext Fri
Dec 2 13:22:58 2011
@@ -0,0 +1,39 @@
+Title: Building Apache Stanbol
+
+
+To build Stanbol from source you need Java 6 and maven 2.2.1 + (version as
defined in the pom). You probably need also: <code>$ export
MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M </code>
+
+Fetch the sources from the Apache code repository
+
+ $ svn co http://svn.apache.org/repos/asf/incubator/stanbol/trunk
stanbol
+
+From the source directory run:
+
+ $ mvn clean install
+
+ _Updating sources_: From your Stanbol root directory call <code>$ mvn
clean</code>, then <code>% svn update</code> and build a new version with
<code>$ mvn clean install</code>.
+
+
+Now, several launchers should be available under the <code>launchers/</code>
directory:
+
+* The _"stable launcher"_ provides you with the most stable components only,
+* the _"full launcher"_ contains all major components available,
+* the _"stateless launcher"_ lets you work with Apache Stanbol components in
offline mode and
+* the _"kres launcher"_ activates the rules machinery only.
+
+
+You can launch the server with:
+
+<code>$ java -Xmx1g -jar
full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar</code>
+
+ Your instance is then available on <http://localhost:8080>. You may change
the default
+port number by passing a `-p 9090` options to the commandline launcher. Use
<code>-h</code>
+to see more options.
+
+Upon first startup, a folder named `sling/` is created in the current folder.
This folder
+contains Stanbol's persistent data, deployment configuration and logs.
+
+
+__HTTP entry points: Web view and REST API__
+
+The web interface of your Apache Stanbol installation provides information for
the main HTTP entry points. Each resource also comes with a web view that
documents the matching RESTful API for applications.
\ No newline at end of file
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/downloads.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/downloads.mdtext?rev=1209460&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/downloads.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/downloads.mdtext
Fri Dec 2 13:22:58 2011
@@ -0,0 +1,5 @@
+Title: Downloads
+
+As there is no official release of Apache Stanbol so far, one needs to install
and build the software from source.
+
+In the meantime, you may download and use pre-builts of Stanbol launchers
served [here](http://http://dev.iks-project.eu/downloads/stanbol-launchers/).
\ No newline at end of file
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/faq.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/faq.mdtext?rev=1209460&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/faq.mdtext (added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/faq.mdtext Fri Dec
2 13:22:58 2011
@@ -0,0 +1,17 @@
+Title: FAQ for Apache Stanbol users
+
+
+## Can I update the default DBpedia index with a bigger one?
+
+Yes, you can just copy such an index from
[here](http://dev.iks-project.eu/downloads/stanbol-indices/) into the
sling/datafiles directory. It will be initialized automatically.
+
+## How about language support of enhancement engines?
+* The Named Entity Recognition Engine has support for English.
+* The Keyword Linking Engine has support for English, German, Danish, Dutch
and Portuguese.
+_[Check "Working with multiple languages"](multilingual.html)_
+
+## Can I use my own vocabulary as linking target?
+Yes, Stanbol provides you with and indexing tool for creating appropriate
indexes for any kind of RDF data, vCard or SKOS vocabularies. _[Check "Using
custom vocabulary"](customvocabulary.html)_
+
+## Can I use existing SOLr indexes?
+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.
\ No newline at end of file
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext?rev=1209460&r1=1209459&r2=1209460&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext Fri
Dec 2 13:22:58 2011
@@ -1,107 +1,24 @@
-Title: Apache Stanbol - services for semantic content management
+Title: Documentation
-The documentation of Apache Stanbol and its services and components can be
retrieved from different places:
+This documentation of Apache Stanbol targets at CMS developers and
integrators, who want to use and integrate Stanbol RESTful Services into a
content management system and secondly for Stanbol contributors, which are
developing Stanbol Components and Engines.
-1. Below, you get the description how to build, install and run Apache
Stanbol, its major features as well as scenarios how to use it.
+## Documentation for CMS Developers
-1. Every running Stanbol server provides you with further descriptions at its
Web UI and for the RESTful web services for each component.
+* [Usage Scenarios](scenarios.html)
+* [Overview on components and engines](components.html)
+* [FAQ](faq.html)
+* Demos
-1. An even more detailed technical documentation can be found within
Readme.files wihin the [source
code](http://svn.apache.org/repos/asf/incubator/stanbol/trunk/).
+_Note: In addition to the documentation on this site, every running Stanbol
server provides you with further descriptions of its RESTful web services for
each component. The most detailed technical documentation can be found within
various Readme.files within the [source
code](http://svn.apache.org/repos/asf/incubator/stanbol/trunk/)._
+## Documentation for Stanbol Contributors
+* Java API for developers
+* How to contribute to software development
+* How to work and update documentation
-## 1. How to build, install and run Apache Stanbol
-
-As there is no official release of Apache Stanbol so far, one needs to install
and build the software from source. As an alternative, you may download
-
-
-### 1.1. Installation
-
-1. To build Stanbol from source you need Java 6 and maven 2.2.1 + (version as
defined in the pom). You probably need also: <code>$ export
MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M </code>
-
-
-2. Fetch the sources from the Apache code repository
-
- <code>$ svn co http://svn.apache.org/repos/asf/incubator/stanbol/trunk
stanbol</code>
-
-3. From the source directory run:
-
- <code>$ mvn clean install</code>
-
- _Updating sources_: From your Stanbol root directory call <code>$ mvn
clean</code>, then <code>% svn update</code> and build a new version with
<code>$ mvn clean install</code>.
-
-
-### 1.2. Launch the Server
-
-Several launchers are available under the <code>launchers/</code> directory:
-
-* The __"stable launcher"__ provides you with the most stable components only,
-* the __"full launcher"__ contains all major components available,
-* the __"stateless launcher"__ lets you work with Apache Stanbol components in
offline mode and
-* the __"kres launcher"__ activates the rules machinery only.
-
-You can launch the server via e.g:
-
-<code>$ java -Xmx1g -jar
full/target/org.apache.stanbol.launchers.full-0.9-SNAPSHOT.jar</code>
-
- Your instance is then available on <http://localhost:8080>. You may change
the default
-port number by passing a `-p 9090` options to the commandline launcher. Use
<code>-h</code>
-to see more options.
-
-Upon first startup, a folder named `sling/` is created in the current folder.
This folder
-contains Stanbol's persistent data, deployment configuration and logs.
-
-
-### 1.3. HTTP entry points
-
-The web interface of your Apache Stanbol installation provides information for
the main HTTP entry points. Each resource comes with a web view that documents
the matching RESTful API for applications. Depending on which launcher you use,
you will get a different set of [services](services.html).
-
-## 2. Technical Documentation
-
-A detailed technical documentation of its services and components can be found
here:
-
-* [Stanbol Services](services.html)
-* [Enhancer](enhancer.html)
-* [Enhancement Engines](engines.html)
-* [Entityhub](entityhub.html)
-* [Contenthub](contenthub.html)
-* [CMS Adapter](cmsadapter.html)
-* [Rules](rules.html)
-* [Reasoners](reasoners.html)
-* Ontology Manager
-* Reengineer
-* FactStore
-* Benchmark
-
-## 3. Usage Scenarios for Apache Stanbol
-
-* [Basic Content Enhancement](contentenhancement.html)
-
- Analyze textual content, enhance with with named entities (person, place,
organization), suggest links to open data sources.
-
-* [Working with "local" Entities](customvocabulary.html)
-
- Use locally defined entities (e.g. thesaurus concepts) from an organization's
context.
-
-* [Working with multiple languages](multilingual.html)
-
- Get enhancements for textual content in multiple languages (EN, DE, SV, DA,
PT and NL).
-
-* Semantic Search in Portals
-
- Store/index enhancements and content items. For a portal this would
facilitate semantic search applications.
-
-* Refactoring Enhancements for SEO
-
- Refactor the enhancement result, its property names and ontology types
according your target ontology.
-
-* Transforming CMS repository structures into ontologies
-* Provide repository structures as thesaurus or domain ontology, e.g.
categories.
-
-
-
-## Follow and support Apache Stanbol
+## How to get involved
- Subscribe to the Apache Stanbol Developers mailinglist by sending an email
to <code>stanbol-dev-subscribe AT incubator.apache.org</code>.
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/mailinglists.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/mailinglists.mdtext?rev=1209460&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/mailinglists.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/mailinglists.mdtext
Fri Dec 2 13:22:58 2011
@@ -0,0 +1,14 @@
+## How to get involved
+
+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> .
+
+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.
+
+Mailing list archives are available at
[mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/),
+[markmail.org](http://markmail.org/search/?q=list:org.apache.incubator.stanbol-*)
and the other usual places.
+
+Additional mailing lists:
+
+ * <code>stanbol-commits AT incubator.apache.org</code> : commit messages
+ * <code>stanbol-private AT incubator.apache.org</code> : private list for
Stanbol PPMC members
+
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext?rev=1209460&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/scenarios.mdtext
Fri Dec 2 13:22:58 2011
@@ -0,0 +1,17 @@
+Title: Usage Scenarios for Apache Stanbol
+
+The following usage scenarios explain how to use various components and
services together with content management systems.
+
+* [Basic Content Enhancement](contentenhancement.html): Analyze textual
content, enhance with with named entities (person, place, organization),
suggest links to open data sources.
+
+* [Working with "local" Entities](customvocabulary.html): Use locally defined
entities (e.g. thesaurus concepts) from an organization's context.
+
+* [Working with multiple languages](multilingual.html): Get enhancements for
textual content in multiple languages (EN, DE, SV, DA, PT and NL).
+
+* Semantic Search in Portals: Store/index enhancements and content items. For
a portal this would facilitate semantic search applications.
+
+* Refactoring Enhancements for SEO: Refactor the enhancement result, its
property names and ontology types according your target ontology.
+
+* Transforming CMS repository structures into ontologies.
+
+* Provide repository structures as thesaurus or domain ontology, e.g.
categories.
\ No newline at end of file
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext?rev=1209460&r1=1209459&r2=1209460&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/services.mdtext Fri
Dec 2 13:22:58 2011
@@ -2,7 +2,7 @@ Title: HTTP entry points for Apache Stan
The web interface of your Apache Stanbol installation provides information for
the main HTTP entry points. Each resource comes with a web view that documents
the matching RESTful API for applications.
-Depending on which launcher you use, you will get a different set of services.
By choosing the __full launcher__, you will get everything including
experimental services, if you choose the __stable launcher__ you will get the
most stable services only.
+Depending on which launcher you use, you will get a different set of services.
By choosing the __full launcher__, you will get everything including
experimental components, if you choose the __stable launcher__ you will get the
most stable components only.
*Note: all links on this page direct to [demo
instances](http://dev.iks-project.eu) of Apache Stanbol. To be able to
configure all services to your needs, you have run your own installation.*
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext?rev=1209460&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/tutorial.mdtext Fri
Dec 2 13:22:58 2011
@@ -0,0 +1,16 @@
+Title: HowTo for Apache Stanbol
+
+## 1 minute tutorial for Apache Stanbol
+
+
+
+
+
+
+
+
+
+
+
+(link 5 minutes tutorial)
+(link 30 minutes tutorial)
\ No newline at end of file
Modified: incubator/stanbol/site/trunk/templates/sidenav.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/templates/sidenav.mdtext?rev=1209460&r1=1209459&r2=1209460&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/templates/sidenav.mdtext (original)
+++ incubator/stanbol/site/trunk/templates/sidenav.mdtext Fri Dec 2 13:22:58
2011
@@ -1,7 +1,12 @@
# Stanbol links
- [Home](/stanbol/index.html)
- - [Project Team](/stanbol/team.html)
+ - [Tutorial](/stanbol/docs/trunk/tutorial.html)
+ - [Downloads](/stanbol/docs/trunk/downloads.html)
+ - [Building from Source](/stanbol/docs/trunk/building.html)
- [Documentation](/stanbol/docs/trunk/)
+ - [Mailing Lists](/stanbol/docs/trunk/mailinglists.html)
+ - [Issue Tracker](https://issues.apache.org/jira/browse/STANBOL)
+ - [Project Team](/stanbol/team.html)
# ASF links
- [Apache Software Foundation](http://www.apache.org)
