You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by ge...@apache.org on 2011/02/03 22:02:11 UTC
svn commit: r1066967 - in /servicemix/documentation/trunk: ./
src/main/scala/org/apache/servicemix/documentation/ src/main/webapp/
src/main/webapp/images/ src/main/webapp/quickstart/
src/main/webapp/quickstart/console-guide/ src/main/webapp/quickstart/...
Author: gertv
Date: Thu Feb 3 21:02:10 2011
New Revision: 1066967
URL: http://svn.apache.org/viewvc?rev=1066967&view=rev
Log:
SMX4-614 Documentation: Add a Getting Started Guide
Thanks to Hans Couder for providing the patch!
Added:
servicemix/documentation/trunk/src/main/webapp/images/samplelog.png
servicemix/documentation/trunk/src/main/webapp/images/samplelogactivemq.png
servicemix/documentation/trunk/src/main/webapp/quickstart/activemq.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/camel.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/
servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/index.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/toc.ssp
servicemix/documentation/trunk/src/main/webapp/quickstart/console.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/features/
servicemix/documentation/trunk/src/main/webapp/quickstart/features.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/features/index.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/features/toc.ssp
servicemix/documentation/trunk/src/main/webapp/quickstart/images/
servicemix/documentation/trunk/src/main/webapp/quickstart/images/console.png
servicemix/documentation/trunk/src/main/webapp/quickstart/images/featureslist.png
servicemix/documentation/trunk/src/main/webapp/quickstart/images/osgilist.png
servicemix/documentation/trunk/src/main/webapp/quickstart/images/samplebundle.png
servicemix/documentation/trunk/src/main/webapp/quickstart/installation.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/quickstart.pdf.conf
servicemix/documentation/trunk/src/main/webapp/quickstart/sample/
servicemix/documentation/trunk/src/main/webapp/quickstart/sample-activemq/
servicemix/documentation/trunk/src/main/webapp/quickstart/sample-activemq/toc.ssp
servicemix/documentation/trunk/src/main/webapp/quickstart/sample/toc.ssp
servicemix/documentation/trunk/src/main/webapp/quickstart/toc.ssp
Modified:
servicemix/documentation/trunk/pom.xml
servicemix/documentation/trunk/src/main/scala/org/apache/servicemix/documentation/Helper.scala
servicemix/documentation/trunk/src/main/webapp/index.ssp
servicemix/documentation/trunk/src/main/webapp/quickstart/index.conf
servicemix/documentation/trunk/src/main/webapp/theme/master.css
servicemix/documentation/trunk/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala
Modified: servicemix/documentation/trunk/pom.xml
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/pom.xml?rev=1066967&r1=1066966&r2=1066967&view=diff
==============================================================================
--- servicemix/documentation/trunk/pom.xml (original)
+++ servicemix/documentation/trunk/pom.xml Thu Feb 3 21:02:10 2011
@@ -84,6 +84,16 @@
<version>1.6.0</version>
</dependency>
+ <!-- Scala -->
+ <dependency>
+ <groupId>org.scala-lang</groupId>
+ <artifactId>scala-compiler</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.scala-lang</groupId>
+ <artifactId>scala-library</artifactId>
+ </dependency>
+
<!-- ensure that the components are available in the local repo -->
<dependency>
<groupId>org.apache.servicemix</groupId>
Modified: servicemix/documentation/trunk/src/main/scala/org/apache/servicemix/documentation/Helper.scala
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/scala/org/apache/servicemix/documentation/Helper.scala?rev=1066967&r1=1066966&r2=1066967&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/scala/org/apache/servicemix/documentation/Helper.scala (original)
+++ servicemix/documentation/trunk/src/main/scala/org/apache/servicemix/documentation/Helper.scala Thu Feb 3 21:02:10 2011
@@ -24,7 +24,7 @@ import org.fusesource.scalate.TemplateEn
*/
object Helper {
- val SITEGEN_ENGINE = "org.fusesource.scalate.maven.DummyTemplateEngine"
+ val SITEGEN_ENGINE = "org.fusesource.scalate.support.DummyTemplateEngine"
val TOC = "/toc.ssp"
val SEPARATOR = "/"
Added: servicemix/documentation/trunk/src/main/webapp/images/samplelog.png
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/images/samplelog.png?rev=1066967&view=auto
==============================================================================
Files servicemix/documentation/trunk/src/main/webapp/images/samplelog.png (added) and servicemix/documentation/trunk/src/main/webapp/images/samplelog.png Thu Feb 3 21:02:10 2011 differ
Added: servicemix/documentation/trunk/src/main/webapp/images/samplelogactivemq.png
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/images/samplelogactivemq.png?rev=1066967&view=auto
==============================================================================
Files servicemix/documentation/trunk/src/main/webapp/images/samplelogactivemq.png (added) and servicemix/documentation/trunk/src/main/webapp/images/samplelogactivemq.png Thu Feb 3 21:02:10 2011 differ
Modified: servicemix/documentation/trunk/src/main/webapp/index.ssp
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/index.ssp?rev=1066967&r1=1066966&r2=1066967&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/index.ssp (original)
+++ servicemix/documentation/trunk/src/main/webapp/index.ssp Thu Feb 3 21:02:10 2011
@@ -5,7 +5,9 @@
<div id="bookpicker">
<div class="left">
- <h2>Quickstart Guide</h2>
+ <a href="quickstart/index.html">
+ <h2>Quickstart Guide</h2>
+ </a>
</div>
<div class="right">
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/activemq.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/activemq.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/activemq.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/activemq.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,74 @@
+h1. Adding ActiveMQ to the 'Mix
+
+Out-of-the-box, every Apache ServiceMix instance comes with an embedded ActiveMQ JMS broker. This makes it easy to communicate between Camel routes using persistent messages on the same machine, but it will also enable you to distribute your routes over multiple instances afterwards for clustering or load-balancing.
+
+h2. Our scenario
+
+In this scenario, we also want to move files between directories. Instead of logging the move directly, we are going to send an event JMS message onto a queue. Afterwards, we will create a second Camel route to receive the events and log them.
+
+h2. Moving files and sending event messages
+The first Blueprint XML file we'll create contains a Camel route that moves the files from {{activemq/input}} to the {{activemq/output}} directory. Afterwards, it will generate an event message and send that to an ActiveMQ queue called {{events}}.
+
+{pygmentize:lang=xml}
+<?xml version="1.0" encoding="UTF-8"?>
+<blueprint
+ xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="
+ http://www.osgi.org/xmlns/blueprint/v1.0.0
+ http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <camelContext xmlns="http://camel.apache.org/schema/blueprint">
+ <route>
+ <from uri="file:activemq/input"/>
+ <to uri="file:activemq/output"/>
+
+ <setBody>
+ <simple>
+ FileMovedEvent(file: ${file:name}, timestamp: ${date:now:hh:MM:ss.SSS})
+ </simple>
+ </setBody>
+ <to uri="amq://events" />
+ </route>
+ </camelContext>
+
+ <bean id="amq" class="org.apache.activemq.camel.component.ActiveMQComponent">
+ <property name="brokerURL" value="vm://default?create=false&waitForStart=10000"/>
+ </bean>
+
+</blueprint>
+{pygmentize}
+
+Save this file in ServiceMix' {{deploy}} folder and use {{osgi:list}} to check on the bundle status as you did with the simple Camel example. You should now be able to put files in the {{activemq/input}} directory and see them being moved to {{activemq/output}}.
+
+h2. Receiving the event messages
+After deploying the first XML file, you're obviously not seeing any events being logged yet. The event messages are sent to an ActiveMQ queue, but there's nobody to receive the events yet. Let's change that now by creating a second Blueprint XML file.
+
+{pygmentize:lang=xml}
+<?xml version="1.0" encoding="UTF-8"?>
+<blueprint
+ xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="
+ http://www.osgi.org/xmlns/blueprint/v1.0.0
+ http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <camelContext xmlns="http://camel.apache.org/schema/blueprint">
+ <route>
+ <from uri="amq://events"/>
+ <to uri="log:events"/>
+ </route>
+ </camelContext>
+
+ <bean id="amq" class="org.apache.activemq.camel.component.ActiveMQComponent">
+ <property name="brokerURL" value="tcp://localhost:61616"/>
+ </bean>
+
+</blueprint>
+{pygmentize}
+
+As soon as this second file has been deployed, you'll start seeing the event messages in your {{log:display}} output.
+
+h2. Using the shell to manage the routes
+
+You can now start and stop both routes from the command shell. The important thing to note here is that you can stop the event handler route while files are being processed. As soon as you restart that bundle afterwards, you'll receive the events from all files that have been moved while the route was not running.
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/camel.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/camel.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/camel.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/camel.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,56 @@
+h1. Using Camel
+
+Now that we know how to operate Apache ServiceMix through the shell console, it's time to start using it for what it is built for. Let's build our very first integration solution with a Camel route and deploy it on ServiceMix.
+
+h2. Our simple scenario
+In this simple scenario, we're going to move files from an input directory called {{camel/input}} to an output directory called {{camel/output}}. To ensure we can keep track of which files get moved, we'll also write a message to the log file whenever we move a file.
+
+h2. Creating the route
+One of the most simple ways to deploy a new route on ServiceMix, is by defining the route in a Blueprint XML file.
+
+{pygmentize:lang=xml}
+<?xml version="1.0" encoding="UTF-8"?>
+<blueprint
+ xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="
+ http://www.osgi.org/xmlns/blueprint/v1.0.0
+ http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <camelContext xmlns="http://camel.apache.org/schema/blueprint">
+ <route>
+ <from uri="file:camel/input"/>
+ <log message="Moving ${file:name} to the output directory"/>
+ <to uri="file:camel/output"/>
+ </route>
+ </camelContext>
+
+</blueprint>
+{pygmentize}
+
+h2. Deploying the route
+In order to deploy and start the route, just copy the XML file you created into ServiceMix' {{deploy}} directory. The file will get picked up and deployed by ServiceMix. You will see a {{camel/input}} folder appear in your ServiceMix installation directory and any files you copy into that directory will get moved into the {{camel/output}} directory.
+
+If you do a {{log:display}} in the shell, you will also see the log output for every file that's been moved.
+
+h2. Using the shell to manage the route
+
+Using {{osgi:list}}, you'll notice that your XML file has been transformed into a bundle and that the Blueprint container has been created to start your Camel route.
+
+{pygmentize:lang=text}
+[ 209] [Active ] [Created ] [ ] [ 60] quickstart1.xml (0.0.0)
+{pygmentize}
+
+From this output, you also learn that the bundle id for your XML file is 209. This allow you to start and stop the route whenever necessary. Let's give this a go now...
+
+First, stop the route with
+{pygmentize:lang=text}
+karaf@root> osgi:stop 209
+{pygmentize}
+
+The route is no longer active, so any files you copy into the {{orders/input}} folder will remain there for now. As soon as you restart the route, the pending files will get moving again.
+
+{pygmentize:lang=text}
+karaf@root> osgi:stop 209
+{pygmentize}
+
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/index.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/index.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/index.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/index.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,38 @@
+h1. Basic console commands
+
+h2. Bundles
+
+h3. Listing installed bundles
+
+In the command console type the following to get a list of all installed bundles.
+
+{pygmentize:lang=text}
+karaf@root> osgi:list
+{pygmentize}.
+
+This list shows the state of the bundle.
+
+h4. Snapshot osgi list
+
+!/images/osgilist.png|title=osgi:list!
+
+h3. Stopping a bundle
+
+{pygmentize:lang=text}
+karaf@root> osgi:stop ID
+{pygmentize}.
+
+
+h3. Starting a bundle
+
+{pygmentize:lang=text}
+karaf@root> osgi:start ID
+{pygmentize}.
+
+
+h3. Installing a bundle
+
+{pygmentize:lang=text}
+karaf@root> osgi:install file:examples/camel-osgi/target/camel-osgi-4.2.0.jar
+{pygmentize}.
+
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/toc.ssp
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/toc.ssp?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/toc.ssp (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/console-guide/toc.ssp Thu Feb 3 21:02:10 2011
@@ -0,0 +1,17 @@
+<ul>
+ <li id="introduction">
+ <a href="${uri("/quickstart/index.html")}">Install and start servicemix</a>
+ </li>
+ <li id="basic-commands">
+ <a href="${uri("/quickstart/console-guide/index.html")}">Basic console commands</a>
+ </li>
+ <li id="features">
+ <a href="${uri("/quickstart/features/index.html")}">Installing additional features</a>
+ </li>
+ <li id="sample">
+ <a href="${uri("/quickstart/sample/index.html")}">Deploying a camel route </a>
+ </li>
+ <li id="sample-activemq">
+ <a href="${uri("/quickstart/sample-activemq/index.html")}">Example Camel + ActiveMQ</a>
+ </li>
+</ul>
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/console.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/console.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/console.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/console.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,57 @@
+h1. Apache ServiceMix console
+
+Now that we successfully installed and started Apache ServiceMix, we'll take a closer look at the console. This is where you manage your ServiceMix instance, add and remove bundles, install optional features, ...
+
+h2. Working with bundles
+
+When ServiceMix is first started, a whole set of bundles providing the core features for the product are being installed. Let's use the command console to find out more about them...
+
+The {{osgi:list}} command can be used to get a list of all bundles currently installed. Enter this
+
+{pygmentize:lang=text}
+karaf@root> osgi:list
+{pygmentize}
+
+This is what the output looks like if you run this on your ServiceMix instance.
+
+!/quickstart/images/osgilist.png|title=osgi:list!
+
+For every bundle, you see:
+* the bundle id
+* the bundle state
+* if the bundle contains a Blueprint or Spring XML file, the next 2 columns will show you if the beans defined there were created successfully
+* the bundle start level
+* the bundle name and version
+
+If you're looking for something specific in the list, you can use unix-like pipes and utilities to help you. An example: to look for the all Camel related bundles...
+
+{pygmentize:lang=text}
+karaf@root> osgi:list | grep camel
+{pygmentize}
+
+h2. Working with logging
+
+Many of the applications you write will have some form of log output. To look at the message in the log file, you can us the {{log:diplay}} command.
+
+{pygmentize:lang=text}
+karaf@root> log:display
+{pygmentize}
+
+If you're only interested in the latest exception in the log file, you can use {{log:display-exception}} instead.
+
+{pygmentize:lang=text}
+karaf@root> log:display-exception
+{pygmentize}
+
+You can also change the log level at runtime by using the {{log:set}} command. You can try these commands on your instance now by setting the log level to {{DEBUG}}, checking the log file to see if you actually see the extra logging and then revert back to {{INFO}}.
+
+{pygmentize:lang=text}
+karaf@root> log:set DEBUG
+karaf@root> log:display | grep DEBUG
+<you should see some log messages at the DEBUG log level here>
+karaf@root> log:set INFO
+{pygmentize}
+
+h2. ...and there's a lot more
+
+These are obviously just a few examples of what the command shell is all about. There are a lot more commands in the shell to help you deploy, monitor, manage and troubleshoot the applications you're building with ServiceMix.
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/features.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/features.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/features.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/features.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,27 @@
+h1. Optional features
+
+Everything discussed in the quickstart guide so far is installed out-of-the-box in Apache ServiceMix, but we also have a lot of optional features that can be installed in the container when necessary.
+
+h2. List of features
+The list of features is available with the {{features:list}} command. The overview shows you whether or not the feature is currently installed, the version and the name of the feature.
+
+!/quickstart/images/featureslist.png!
+
+The full list contains a lot of different features: optional Camel components, features for adding OBR or wrapper support to Serviceix, a web console, ... Again, you can use things like {{|}} and {{grep}} to find the things in the list that you're interested in.
+
+{pygmentize:lang=text}
+karaf@root> features:list | grep camel
+{pygmentize}
+
+h2. Example: Web console
+To get the web console installed in ServiceMix, install the feature from your console
+{pygmentize:lang=text}
+karaf@root> features:install webconsole
+{pygmentize}
+
+Afterwards, you can verify that the feature is marked installed in the overview. You'll notice that the {{webconsole-base}} feature has also been installed as a requirement for the {{webconsole}} feature itself.
+{pygmentize:lang=text}
+karaf@root> features:list | grep webconsole
+{pygmentize}
+
+You will now be able to point your browser to http://localhost:8181/system/console and login with user {{smx}} and password {{smx}} to access the web console. From the webconsole, you can also start and stop bundles, install optional features again, ...
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/features/index.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/features/index.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/features/index.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/features/index.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,26 @@
+h1. Installing additional features
+
+h2. Listing features
+
+{pygmentize:lang=text}
+karaf@root> features:list
+{pygmentize}.
+
+h3. Snapshot features list
+
+!/images/featureslist.png|title=features:list!
+
+
+h2. Installing a feature
+
+{pygmentize:lang=text}
+karaf@root> features:install Name
+{pygmentize}.
+
+
+h2. Uninstalling a feature
+
+{pygmentize:lang=text}
+karaf@root> features:uninstall Name
+{pygmentize}.
+
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/features/toc.ssp
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/features/toc.ssp?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/features/toc.ssp (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/features/toc.ssp Thu Feb 3 21:02:10 2011
@@ -0,0 +1,17 @@
+<ul>
+ <li id="introduction">
+ <a href="${uri("/quickstart/index.html")}">Install and start servicemix</a>
+ </li>
+ <li id="basic-commands">
+ <a href="${uri("/quickstart/console-guide/index.html")}">Basic console commands</a>
+ </li>
+ <li id="features">
+ <a href="${uri("/quickstart/features/index.html")}">Installing additional features</a>
+ </li>
+ <li id="sample">
+ <a href="${uri("/quickstart/sample/index.html")}">Deploying a camel route </a>
+ </li>
+ <li id="sample-activemq">
+ <a href="${uri("/quickstart/sample-activemq/index.html")}">Example Camel + ActiveMQ</a>
+ </li>
+</ul>
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/images/console.png
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/images/console.png?rev=1066967&view=auto
==============================================================================
Files servicemix/documentation/trunk/src/main/webapp/quickstart/images/console.png (added) and servicemix/documentation/trunk/src/main/webapp/quickstart/images/console.png Thu Feb 3 21:02:10 2011 differ
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/images/featureslist.png
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/images/featureslist.png?rev=1066967&view=auto
==============================================================================
Files servicemix/documentation/trunk/src/main/webapp/quickstart/images/featureslist.png (added) and servicemix/documentation/trunk/src/main/webapp/quickstart/images/featureslist.png Thu Feb 3 21:02:10 2011 differ
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/images/osgilist.png
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/images/osgilist.png?rev=1066967&view=auto
==============================================================================
Files servicemix/documentation/trunk/src/main/webapp/quickstart/images/osgilist.png (added) and servicemix/documentation/trunk/src/main/webapp/quickstart/images/osgilist.png Thu Feb 3 21:02:10 2011 differ
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/images/samplebundle.png
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/images/samplebundle.png?rev=1066967&view=auto
==============================================================================
Files servicemix/documentation/trunk/src/main/webapp/quickstart/images/samplebundle.png (added) and servicemix/documentation/trunk/src/main/webapp/quickstart/images/samplebundle.png Thu Feb 3 21:02:10 2011 differ
Modified: servicemix/documentation/trunk/src/main/webapp/quickstart/index.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/index.conf?rev=1066967&r1=1066966&r2=1066967&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/index.conf (original)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/index.conf Thu Feb 3 21:02:10 2011
@@ -1,3 +1,4 @@
-h2. Purpose
+h1. Introduction
+First of all, welcome to the Apache ServiceMix project!
-The goal of this quickstart guide is to give you a 15 minute tour around ServiceMix. You can find more in depth information in the others guides available on http://servicemix.apache.org/documentation/${project.version}.
\ No newline at end of file
+The goal of this Quickstart guide is to give you a 20-minute overview of what ServiceMix is and what you can do with it. In that time, we'll install ServiceMix on your machine, deploy some basic integration routes and extend the container with an additional feature.
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/installation.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/installation.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/installation.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/installation.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,42 @@
+h1. Installation
+Before we can start working with Apache ServiceMix, we have to get it installed and running on our local machine first.
+
+h2. System requirements
+* Java Developer Kit (JDK) 1.5.x (Java 5) or later, for both deployment and compiling.
+* About 100 MB of free disk space
+
+h2. Downloading Apache ServiceMix
+
+Apache ServiceMix ${servicemix.version} is available under the Apache License v2 and can be downloaded from [http://servicemix.apache.org/SMX4/download.html].
+
+Depending on your operation system, you should download either the tar.gz or the zip file:
+* tar.gz for Linux/Unix/MacOS X
+* zip for Windows
+
+h2. Installing Apache ServiceMix
+
+Installing Apache ServiceMix is as simple as uncompressing the downloaded archive on your hard disk. For the rest of this guide, we'll refer to the this location as *{{<SERVICEMIX_HOME>}}*.
+
+h2. Starting Apache ServiceMix
+
+Depending on your platform, start Apache ServiceMix by following the instructions below. After starting the container, you will have access to the console from which you can manage the container.
+
+!/quickstart/images/console.png!
+
+h3. On Windows
+In a command prompt window, navigate to the directory where you extracted ServiceMix and run the {{bin\servicemix.bat}} file.
+
+Example: if ServiceMix in installed in the {{c:\tools\apache-servicemix-${servicemix.version}}} directory
+{pygmentize:lang=bat}
+> cd c:\tools\apache-servicemix-${servicemix.version}
+> .\bin\servicemix
+{pygmentize}
+
+h3. On Linux/Unix/MacOS X
+On a command shell, navigate to the directory where you extracted ServiceMix and the {{bin/servicemix}} shell script
+
+Example: if ServiceMix is installed in the {{~/Applications/apache-servicemix-${servicemix.version}}} directory.
+{pygmentize:lang=bash}
+$ cd ~/Applications/apache-servicemix-${servicemix.version}
+$ ./bin/servicemix
+{pygmentize}
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/quickstart.pdf.conf
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/quickstart.pdf.conf?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/quickstart.pdf.conf (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/quickstart.pdf.conf Thu Feb 3 21:02:10 2011
@@ -0,0 +1,19 @@
+{attributes:layout=/WEB-INF/scalate/layouts/print.ssp}
+{attributes:title=Quickstart Guide}
+
+{include:quickstart/index.conf}
+
+{include:quickstart/installation.conf}
+
+{include:quickstart/console.conf}
+
+{include:quickstart/camel.conf}
+
+{include:quickstart/activemq.conf}
+
+{include:quickstart/features.conf}
+
+h1. Wrapping it up...
+This is where our introductory journey through the world of Apache ServiceMix ends. We've obviously just scratched the surface of what is possible, but we hope you have an idea of what you can expect from Apache ServiceMix and how you can use it in your environment.
+
+For more in-depth information, have a look at our set of user guides. Also, if you have any questions, we welcome you on our user mailing list!
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/sample-activemq/toc.ssp
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/sample-activemq/toc.ssp?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/sample-activemq/toc.ssp (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/sample-activemq/toc.ssp Thu Feb 3 21:02:10 2011
@@ -0,0 +1,17 @@
+<ul>
+ <li id="introduction">
+ <a href="${uri("/quickstart/index.html")}">Install and start servicemix</a>
+ </li>
+ <li id="basic-commands">
+ <a href="${uri("/quickstart/console-guide/index.html")}">Basic console commands</a>
+ </li>
+ <li id="features">
+ <a href="${uri("/quickstart/features/index.html")}">Installing additional features</a>
+ </li>
+ <li id="sample">
+ <a href="${uri("/quickstart/sample/index.html")}">Deploying a camel route </a>
+ </li>
+ <li id="sample-activemq">
+ <a href="${uri("/quickstart/sample-activemq/index.html")}">Example Camel + ActiveMQ</a>
+ </li>
+</ul>
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/sample/toc.ssp
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/sample/toc.ssp?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/sample/toc.ssp (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/sample/toc.ssp Thu Feb 3 21:02:10 2011
@@ -0,0 +1,17 @@
+<ul>
+ <li id="introduction">
+ <a href="${uri("/quickstart/index.html")}">Install and start servicemix</a>
+ </li>
+ <li id="basic-commands">
+ <a href="${uri("/quickstart/console-guide/index.html")}">Basic console commands</a>
+ </li>
+ <li id="features">
+ <a href="${uri("/quickstart/features/index.html")}">Installing additional features</a>
+ </li>
+ <li id="sample">
+ <a href="${uri("/quickstart/sample/index.html")}">Deploying a camel route </a>
+ </li>
+ <li id="sample-activemq">
+ <a href="${uri("/quickstart/sample-activemq/index.html")}">Example Camel + ActiveMQ</a>
+ </li>
+</ul>
\ No newline at end of file
Added: servicemix/documentation/trunk/src/main/webapp/quickstart/toc.ssp
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/quickstart/toc.ssp?rev=1066967&view=auto
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/quickstart/toc.ssp (added)
+++ servicemix/documentation/trunk/src/main/webapp/quickstart/toc.ssp Thu Feb 3 21:02:10 2011
@@ -0,0 +1,20 @@
+<ul>
+ <li id="introduction">
+ <a href="${uri("/quickstart/index.html")}">Introduction</a>
+ </li>
+ <li id="basic-commands">
+ <a href="${uri("/quickstart/installation.html")}">Installing Apache ServiceMix</a>
+ </li>
+ <li id="features">
+ <a href="${uri("/quickstart/console.html")}">Console shell</a>
+ </li>
+ <li id="camel">
+ <a href="${uri("/quickstart/camel.html")}">Routing with Camel</a>
+ </li>
+ <li id="activemq">
+ <a href="${uri("/quickstart/activemq.html")}">Adding ActiveMQ to the 'Mix</a>
+ </li>
+ <li id="features">
+ <a href="${uri("/quickstart/features.html")}">Optional features</a>
+ </li>
+</ul>
\ No newline at end of file
Modified: servicemix/documentation/trunk/src/main/webapp/theme/master.css
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/main/webapp/theme/master.css?rev=1066967&r1=1066966&r2=1066967&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/main/webapp/theme/master.css (original)
+++ servicemix/documentation/trunk/src/main/webapp/theme/master.css Thu Feb 3 21:02:10 2011
@@ -204,6 +204,11 @@ div.note {
border-color: #F7DF92;
}
+div.code {
+ background-color: #FFFFDD;
+ border-color: #F7DF92;
+}
+
h1, h2, h3, h4, h5, h6 {
line-height: normal;
font-weight: bold;
Modified: servicemix/documentation/trunk/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala
URL: http://svn.apache.org/viewvc/servicemix/documentation/trunk/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala?rev=1066967&r1=1066966&r2=1066967&view=diff
==============================================================================
--- servicemix/documentation/trunk/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala (original)
+++ servicemix/documentation/trunk/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala Thu Feb 3 21:02:10 2011
@@ -20,8 +20,8 @@ package org.apache.servicemix.documentat
import org.apache.servicemix.documentation.Helper._
import org.junit.Test
import org.junit.Assert.{assertEquals,assertFalse,assertTrue}
-import org.fusesource.scalate.maven.DummyTemplateEngine
import org.fusesource.scalate.TemplateEngine
+import org.fusesource.scalate.support.DummyTemplateEngine
/**
* Test case for org.apache.servicemix.documentation.Helper