You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by fl...@apache.org on 2012/10/25 14:19:11 UTC

svn commit: r1402126 - in /stanbol/site/trunk/content/production: file-bundle-configuration.mdtext partial-updates.mdtext your-launcher.mdtext

Author: florent
Date: Thu Oct 25 12:19:11 2012
New Revision: 1402126

URL: http://svn.apache.org/viewvc?rev=1402126&view=rev
Log:
STANBOL-789 md format, fighting with xml display

Modified:
    stanbol/site/trunk/content/production/file-bundle-configuration.mdtext
    stanbol/site/trunk/content/production/partial-updates.mdtext
    stanbol/site/trunk/content/production/your-launcher.mdtext

Modified: stanbol/site/trunk/content/production/file-bundle-configuration.mdtext
URL: http://svn.apache.org/viewvc/stanbol/site/trunk/content/production/file-bundle-configuration.mdtext?rev=1402126&r1=1402125&r2=1402126&view=diff
==============================================================================
--- stanbol/site/trunk/content/production/file-bundle-configuration.mdtext (original)
+++ stanbol/site/trunk/content/production/file-bundle-configuration.mdtext Thu Oct 25 12:19:11 2012
@@ -17,8 +17,10 @@ A bundleconfig artifact is a Maven proje
                        |- ....
 </pre>
 
-The pom.xml has nothing special. You can copy [this one](https://svn.apache.org/repos/asf/stanbol/trunk/data/defaultconfig/pom.xml) for example and only adapt group and artifact ID to suit your project naming convention.
-The configurations are held by files in the src/main/resources/config folder. This configurations files : 
+The pom.xml has nothing special. You can copy [this one](https://svn.apache.org/repos/asf/stanbol/trunk/data/defaultconfig/pom.xml) for example and only adapt group and artifact ID to suit your project naming convention.  
+
+The configurations are held by files in the src/main/resources/config folder. This configurations files :  
+
 * need to respect this naming convention :
     * {bundleArtifactID}-{uniqueID}.conf, where {uniqueID} can be anything but unique to not be overloaded.
     * for example a configuration file with this name "org.apache.stanbol.enhancer.engines.keywordextraction.engine.KeywordLinkingEngine-entityhub.config" will be used to configure the Keyword Linking Engine bundle.

Modified: stanbol/site/trunk/content/production/partial-updates.mdtext
URL: http://svn.apache.org/viewvc/stanbol/site/trunk/content/production/partial-updates.mdtext?rev=1402126&r1=1402125&r2=1402126&view=diff
==============================================================================
--- stanbol/site/trunk/content/production/partial-updates.mdtext (original)
+++ stanbol/site/trunk/content/production/partial-updates.mdtext Thu Oct 25 12:19:11 2012
@@ -5,6 +5,7 @@ Felix web interface allow you to do this
 The Apache Sling File Provider allow you to define a folder, where you just have to drop/update/delete your bundle to get your server in sync.  
 
 Follow this two step procedure to enjoy this feature :  
+
 * 0. Install the "Sling File Provider" Bundle (not needed as this is included by default in Stanbol)
 * 1. Configure the "sling.fileinstall.dir" property: You can add this to the "{stanbol-working-dir}/stanbol/sling.properties file" or parse it as a system property '-Dsling.fileinstall.dir={path-to-dir}' when you start stanbol.
 * 2. Create the referenced Folder on you file system.

Modified: stanbol/site/trunk/content/production/your-launcher.mdtext
URL: http://svn.apache.org/viewvc/stanbol/site/trunk/content/production/your-launcher.mdtext?rev=1402126&r1=1402125&r2=1402126&view=diff
==============================================================================
--- stanbol/site/trunk/content/production/your-launcher.mdtext (original)
+++ stanbol/site/trunk/content/production/your-launcher.mdtext Thu Oct 25 12:19:11 2012
@@ -15,7 +15,7 @@ Stanbol launcher's use this bundlelist m
 
 * Bundlelist are in fact just jar. So you just need to declare them as dependencies in you launcher pom.xml to get the feature package and all required bundle for it.
 * For example, if you want the entityHub feature in you server, you only need to add this dependency to your launcher pom.xml :
-<pre>
+```xml
     <dependency>
       <groupId>org.apache.stanbol</groupId>
       <artifactId>org.apache.stanbol.entityhub.bundlelist</artifactId>
@@ -23,7 +23,7 @@ Stanbol launcher's use this bundlelist m
       <type>partialbundlelist</type>
       <scope>provided</scope>
     </dependency>
-</pre>
+```
 
 * Please note the <pre><type>partialbundlelist</type></pre> property of the dependency.
 * Also in actual Stanbol code base you can easily detect feature package bundlelist as their artifactId has the structure org.apache.stanbol.{feature-name}.bundlelist
@@ -55,10 +55,10 @@ Stanbol launcher's use this bundlelist m
 
 * The bundlelist mechanism is the perfect and simple way to include your list of bundles into your launcher ! 
 
-## Build *your** bundlelist dependency
+## Build *your* bundlelist dependency
 
 * Bundlelist (or partialbundlelist) artifact is a really simple Maven project that rely on this structure :
-
+<pre>
     mybundlelistFolder
       |
       |- pom.xml
@@ -66,11 +66,12 @@ Stanbol launcher's use this bundlelist m
           |- main
               |- bundles
                    |- list.xml
+</pre>
 
 * You only need to define 2 files : 
     * pom.xml : really simple you can copy-paste the [Enhancer bundlelist](http://svn.apache.org/repos/asf/stanbol/trunk/enhancer/bundlelist/pom.xml) one and only change the groupId and artifactId properties to suit you need. All the magic here is contained in <packaging> property.
     * list.xml : this file will contains information about the bundles you want to include. This file has a simple structure :
-
+<pre><code>
     <bundles>
         <startlevel level="L0">
             <bundle>
@@ -84,7 +85,7 @@ Stanbol launcher's use this bundlelist m
             ... anothers bundles nodes...
         </startlevel>
     </bundles>
-
+<code></pre>
 
 * Start level is an important things to keep in mind as the value of the "level" property will determine when your bundle is started during the server launch.
     * So, if your bundle require some other services to be up and running, be sure to define a higher start level to your bundle that the ones of the required services.