Add the Karaf docs to site
git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/trunk@1023676 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/pom.xml b/pom.xml
index 9810e49..6a1b3cf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -68,6 +68,13 @@
<artifactId>slf4j-api</artifactId>
<version>1.6.0</version>
</dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>4.8</version>
+ <scope>test</scope>
+ </dependency>
</dependencies>
<build>
@@ -84,33 +91,54 @@
</execution>
</executions>
</plugin>
+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
- <id>src-dependencies</id>
+ <!-- Unpack the manual sources into the /karaf subdirectory -->
+ <id>unpack-karaf-manual</id>
<phase>generate-resources</phase>
<goals>
- <!-- use copy-dependencies instead if you don't want to explode the sources -->
<goal>unpack</goal>
</goals>
- <configuration>
- <artifactItems>
- <artifactItem>
- <groupId>org.fusesource.doc</groupId>
- <artifactId>karaf</artifactId>
- <version>2.1.99-SNAPSHOT</version>
- <type>war</type>
- <outputDirectory>${project.build.directory}/webapp/karaf</outputDirectory>
- <includes>commands/*.conf,developers-guide/*.conf,users-guide/*.conf</includes>
- </artifactItem>
- </artifactItems>
-
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>org.fusesource.doc</groupId>
+ <artifactId>karaf</artifactId>
+ <version>2.1.99-SNAPSHOT</version>
+ <type>war</type>
+ <outputDirectory>${project.build.directory}/webapp/karaf</outputDirectory>
+ <includes>developers-guide/*.conf,users-guide/*.conf</includes>
+ </artifactItem>
+ </artifactItems>
</configuration>
</execution>
+ <execution>
+ <!-- Unpack the commands documentation sources into the /commands -->
+ <id>unpack-karaf-commands</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>unpack</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>org.fusesource.doc</groupId>
+ <artifactId>karaf</artifactId>
+ <version>2.1.99-SNAPSHOT</version>
+ <type>war</type>
+ <outputDirectory>${project.build.directory}/webapp</outputDirectory>
+ <includes>commands/*.conf</includes>
+ </artifactItem>
+ </artifactItems>
+ </configuration>
+ </execution>
</executions>
</plugin>
+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
@@ -150,6 +178,7 @@
</plugin>
<plugin>
<artifactId>maven-war-plugin</artifactId>
+ <version>2.1</version>
<configuration>
<warSourceDirectory>${project.build.directory}/webapp</warSourceDirectory>
<archive>
@@ -191,6 +220,7 @@
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
+ <version>2.1.0</version>
<executions>
<execution>
<id>bundle-manifest</id>
diff --git a/src/main/scala/org/apache/servicemix/documentation/Helper.scala b/src/main/scala/org/apache/servicemix/documentation/Helper.scala
new file mode 100644
index 0000000..8bda958
--- /dev/null
+++ b/src/main/scala/org/apache/servicemix/documentation/Helper.scala
@@ -0,0 +1,34 @@
+/**
+ * Copyright (C) 2009-2010 the original author or authors.
+ * See the notice.md file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.servicemix.documentation
+
+/**
+ * Helper methods for buildings the templates
+ */
+object Helper {
+
+ val TOC = "/toc.ssp"
+
+ /**
+ * Determine the right toc file to include for a given uri
+ */
+ def toc(uri: String) = {
+ "/" + uri.substring(1).split("/").head + TOC
+ }
+
+}
\ No newline at end of file
diff --git a/src/main/scala/scalate/Boot.scala b/src/main/scala/scalate/Boot.scala
index 6cbd330..4f96a2b 100644
--- a/src/main/scala/scalate/Boot.scala
+++ b/src/main/scala/scalate/Boot.scala
@@ -1,9 +1,26 @@
+/**
+ * Copyright (C) 2009-2010 the original author or authors.
+ * See the notice.md file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package scalate
-class Boot {
+import org.fusesource.scalate.util.Logging
- def run = {
- System.out.println("---> Starting the bloody thing")
- }
+class Boot extends Logging {
+
+ def run = debug("Boot class started")
}
\ No newline at end of file
diff --git a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
index ec38326..328912f 100644
--- a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
+++ b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
@@ -18,6 +18,8 @@
<%@ var body: String %>
<%@ var title: String = "Apache ServiceMix ${servicemix.version}" %>
<%@ var navigation: Boolean = true %>
+<% import org.fusesource.scalate.servlet.ServletRenderContext._ %>
+<% import org.apache.servicemix.documentation.Helper._ %>
<!DOCTYPE html>
<html>
<head>
@@ -53,7 +55,7 @@
<% if (navigation) { %>
<nav>
<div id="navigation">
- ${include("/toc.ssp")}
+ ${include(toc(requestUri))}
</div>
</nav>
<% } %>
diff --git a/src/main/webapp/commands/index.conf b/src/main/webapp/commands/index.conf
new file mode 100644
index 0000000..20305d9
--- /dev/null
+++ b/src/main/webapp/commands/index.conf
@@ -0,0 +1,2 @@
+h1. ServiceMix ${servicemix.version} Documentation
+Commands available in the
\ No newline at end of file
diff --git a/src/main/webapp/commands/toc.ssp b/src/main/webapp/commands/toc.ssp
new file mode 100644
index 0000000..5891dea
--- /dev/null
+++ b/src/main/webapp/commands/toc.ssp
@@ -0,0 +1,69 @@
+<!-- TODO: generate this file automatically, this is just a subset of the available commands for demo purposes -->
+<ul>
+ <li id="comfig-commands">
+ <a href="#">Using ConfigAdmin</a>
+ <ul>
+ <li id="config-cancel">
+ <a href="${uri("/commands/config-cancel.html")}">config:cancel</a>
+ </li>
+ <li id="config-edit">
+ <a href="${uri("/commands/config-edit.html")}">config:edit</a>
+ </li>
+ <li id="config-list">
+ <a href="${uri("/commands/config-list.html")}">config:list</a>
+ </li>
+ <li id="config-propappend">
+ <a href="${uri("/commands/config-propappend.html")}">config:propappend</a>
+ </li>
+ <li id="config-propdel">
+ <a href="${uri("/commands/config-propdel.html")}">config:propdel</a>
+ </li>
+ <li id="config-proplist">
+ <a href="${uri("/commands/config-proplist.html")}">config:proplist</a>
+ </li>
+ <li id="config-propset">
+ <a href="${uri("/commands/config-propset.html")}">config:propset</a>
+ </li>
+ <li id="config-update">
+ <a href="${uri("/commands/config-update.html")}">config:update</a>
+ </li>
+ </ul>
+ </li>
+ <li id="dev-commands">
+ <a href="#">Development</a>
+ <ul>
+ <li id="dev-dynamic-import">
+ <a href="${uri("/commands/dev-dynamic-import.html")}">dev:dynamic-import</a>
+ </li>
+ <li id="dev-framework">
+ <a href="${uri("/commands/dev-framework.html")}">dev:framework</a>
+ </li>
+ <li id="dev-print-stack-traces">
+ <a href="${uri("/commands/dev-print-stack-traces.html")}">dev:print-stack-traces</a>
+ </li>
+ <li id="dev-restart">
+ <a href="${uri("/commands/dev-restart.html")}">dev:restart</a>
+ </li>
+ <li id="dev-show-tree">
+ <a href="${uri("/commands/dev-show-tree.html")}">dev:show-tree</a>
+ </li>
+ </ul>
+ </li>
+ <li id="log-commands">
+ <a href="#">Logging</a>
+ <ul>
+ <li id="log-display-exception">
+ <a href="${uri("/commands/log-display-exception.html")}">log:display-exception</a>
+ </li>
+ <li id="log-display">
+ <a href="${uri("/commands/log-display.html")}">log:display</a>
+ </li>
+ <li id="log-get">
+ <a href="${uri("/commands/log-get.html")}">log:get</a>
+ </li>
+ <li id="log-set">
+ <a href="${uri("/commands/log-set.html")}">log:set</a>
+ </li>
+ </ul>
+ </li>
+</ul>
\ No newline at end of file
diff --git a/src/main/webapp/index.ssp b/src/main/webapp/index.ssp
index 55ee0d9..4e8845d 100644
--- a/src/main/webapp/index.ssp
+++ b/src/main/webapp/index.ssp
@@ -5,6 +5,7 @@
<h2>Related projects' reference manuals</h2>
<ul>
- <li><a href="karaf/users-guide">Karaf Users' Guide</a></li>
- <li><a href="karaf/developers-guide">Karaf Developers' Guide</a></li>
+ <li><a href="users-guide/index.html">Apache ServiceMix User's Guide</a></li>
+ <li><a href="commands/index.html">Console commands reference</a></li>
+ <li><a href="karaf/index.html">Apache Karaf</a></li>
</ul>
\ No newline at end of file
diff --git a/src/main/webapp/karaf/index.conf b/src/main/webapp/karaf/index.conf
new file mode 100644
index 0000000..e95794b
--- /dev/null
+++ b/src/main/webapp/karaf/index.conf
@@ -0,0 +1,2 @@
+h1. ServiceMix ${servicemix.version} Documentation
+ServiceMix ${servicemix.version} uses Apache Karaf.
\ No newline at end of file
diff --git a/src/main/webapp/karaf/toc.ssp b/src/main/webapp/karaf/toc.ssp
new file mode 100644
index 0000000..8cc7ce5
--- /dev/null
+++ b/src/main/webapp/karaf/toc.ssp
@@ -0,0 +1,75 @@
+<ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="${uri("/karaf/users-guide/installation.html")}">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="${uri("/karaf/users-guide/directory-structure.html")}">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="${uri("/karaf/users-guide/start-stop.html")}">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="${uri("/karaf/users-guide/using-console.html")}">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="${uri("/karaf/users-guide/web-console.html")}">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="${uri("/karaf/users-guide/remote-console.html")}">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="${uri("/karaf/users-guide/child-instances.html")}">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="${uri("/karaf/users-guide/security.html")}">Security</a>
+ </li>
+ <li id="failover">
+ <a href="${uri("/karaf/users-guide/failover.html")}">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="${uri("/karaf/users-guide/logging-system.html")}">Logging system</a>
+ </li>
+ <li id="installing-features">
+ <a href="${uri("/karaf/users-guide/installing-features.html")}">Installing additional features</a>
+ </li>
+ <li id="deployer">
+ <a href="${uri("/karaf/users-guide/deployer.html")}">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="${uri("/karaf/users-guide/configuration.html")}">Configuration</a>
+ </li>
+ <li id="provisioning">
+ <a href="${uri("/karaf/users-guide/provisioning.html")}">Provisioning</a>
+ </li>
+ </ul>
+ </li>
+ <li id="karaf-developers-guide">
+ <a href="#">Developer's Guide</a>
+ <ul>
+ <li id="extending-console">
+ <a href="${uri("/karaf/developers-guide/extending-console.html")}">Extending Console</a>
+ </li>
+ <li id="security-framework">
+ <a href="${uri("/karaf/developers-guide/security-framework.html")}">Security Framework</a>
+ </li>
+ <li id="writing-tests">
+ <a href="${uri("/karaf/developers-guide/writing-tests.html")}">Tests with Pax Exam</a>
+ </li>
+ <li id="debugging">
+ <a href="${uri("/karaf/developers-guide/debugging.html")}">Debug Karaf</a>
+ </li>
+ <li id="creating-bundles">
+ <a href="${uri("/karaf/developers-guide/creating-bundles.html")}">Creating bundles</a>
+ </li>
+ <li id="connect-console">
+ <a href="${uri("/karaf/developers-guide/connect-console.html")}">Connect to the console</a>
+ </li>
+ <li id="shell-syntax">
+ <a href="${uri("/karaf/developers-guide/shell-syntax.html")}">Console shell syntax</a>
+ </li>
+ </ul>
+ </li>
+</ul>
diff --git a/src/main/webapp/toc.ssp b/src/main/webapp/toc.ssp
deleted file mode 100644
index 59bd9cb..0000000
--- a/src/main/webapp/toc.ssp
+++ /dev/null
@@ -1,57 +0,0 @@
-<ul>
- <li id="getting-started">
- <a href="${uri("/getting-started/index.html")}">Getting Started</a>
- <ul>
- <li id="what-is-smx4"><a href="${uri("/getting-started/what-is-smx4.html")}">What is ServiceMix 4?</a></li>
- <li id="installation"><a href="${uri("/getting-started/installation.html")}">Installing ServiceMix</a></li>
- <li id="discover"><a href="${uri("/getting-started/discover")}">Discover ServiceMix</a></li>
- <li id="technology-selection"><a href="${uri("/getting-started/technology-selection.html")}">Technology selection guidelines</a></li>
- </ul>
- </li>
- <li id="camel">
- <a href="${uri("/camel/camel-index.html")}">Using Camel</a>
- <ul>
- <li id="camel-deploy"><a href="${uri("/camel/camel-deployment.html")}">Deployment options</a></li>
- </ul>
- </li>
-
- <li id="nmr">
- <a href="${uri("/nmr/nmr-index.html")}">Using the NMR</a>
- <ul>
- <li id="camel-nmr"><a href="${uri("/nmr/nmr-camel.html")}">Camel NMR</a></li>
- <li id="nmr-event-listeners"><a href="${uri("/nmr/nmr-event-listeners.html")}">Event Listeners</a></li>
- </ul>
- </li>
- <li id="jbi-components">
- <a href="#">JBI Components</a>
- <ul>
- <li id="servicemix-bean"><a href="${uri("/jbi/servicemix-bean.html")}">servicemix-bean</a></li>
- <li id="servicemix-camel"><a href="${uri("/jbi/servicemix-camel.html")}">servicemix-camel</a></li>
- <li id="servicemix-cxf-bc"><a href="${uri("/jbi/servicemix-cxf-bc.html")}">servicemix-cxf-bc</a></li>
- <li id="servicemix-cxf-se"><a href="${uri("/jbi/servicemix-cxf-se.html")}">servicemix-cxf-se</a></li>
- <li id="servicemix-drools"><a href="${uri("/jbi/servicemix-drools.html")}">servicemix-drools</a></li>
- <li id="servicemix-eip"><a href="${uri("/jbi/servicemix-eip.html")}">servicemix-eip</a></li>
- <li id="servicemix-file"><a href="${uri("/jbi/servicemix-file.html")}">servicemix-file</a></li>
- <li id="servicemix-ftp"><a href="${uri("/jbi/servicemix-ftp.html")}">servicemix-ftp</a></li>
- <li id="servicemix-http"><a href="${uri("/jbi/servicemix-http.html")}">servicemix-http</a></li>
- <li id="servicemix-jms"><a href="${uri("/jbi/servicemix-jms.html")}">servicemix-jms</a></li>
- <li id="servicemix-mail"><a href="${uri("/jbi/servicemix-mail.html")}">servicemix-mail</a></li>
- <li id="servicemix-osworkflow"><a href="${uri("/jbi/servicemix-osworkflow.html")}">servicemix-osworkflow</a></li>
- <li id="servicemix-quartz"><a href="${uri("/jbi/servicemix-quartz.html")}">servicemix-quartz</a></li>
- <li id="servicemix-saxon"><a href="${uri("/jbi/servicemix-saxon.html")}">servicemix-saxon</a></li>
- <li id="servicemix-scripting"><a href="${uri("/jbi/servicemix-scripting.html")}">servicemix-scripting</a></li>
- <li id="servicemix-snmp"><a href="${uri("/jbi/servicemix-snmp.html")}">servicemix-snmp</a></li>
- <li id="servicemix-validation"><a href="${uri("/jbi/servicemix-validation.html")}">servicemix-validation</a></li>
- <li id="servicemix-vfs"><a href="${uri("/jbi/servicemix-vfs.html")}">servicemix-vfs</a></li>
- <li id="servicemix-wsn2005"><a href="${uri("/jbi/servicemix-wsn2005.html")}">servicemix-wsn2005</a></li>
- <li id="servicemix-xmpp"><a href="${uri("/jbi/servicemix-xmpp.html")}">servicemix-xmpp</a></li>
- </ul>
- </li>
- <li id="appendices">
- <a href="#">Appendices</a>
- <ul>
- <li id="migration"><a href="${uri("/appendices/migration.html")}">Migrating from ServiceMix 3</a></li>
- </ul>
- </li>
-
-</ul>
\ No newline at end of file
diff --git a/src/main/webapp/users-guide/toc.ssp b/src/main/webapp/users-guide/toc.ssp
new file mode 100644
index 0000000..91ac1d1
--- /dev/null
+++ b/src/main/webapp/users-guide/toc.ssp
@@ -0,0 +1,57 @@
+<ul>
+ <li id="getting-started">
+ <a href="${uri("/users-guide/getting-started/index.html")}">Getting Started</a>
+ <ul>
+ <li id="what-is-smx4"><a href="${uri("/users-guide/getting-started/what-is-smx4.html")}">What is ServiceMix 4?</a></li>
+ <li id="installation"><a href="${uri("/users-guide/getting-started/installation.html")}">Installing ServiceMix</a></li>
+ <li id="discover"><a href="${uri("/users-guide/getting-started/discover")}">Discover ServiceMix</a></li>
+ <li id="technology-selection"><a href="${uri("/users-guide/getting-started/technology-selection.html")}">Technology selection guidelines</a></li>
+ </ul>
+ </li>
+ <li id="camel">
+ <a href="${uri("/users-guide/camel/camel-index.html")}">Using Camel</a>
+ <ul>
+ <li id="camel-deploy"><a href="${uri("/users-guide/camel/camel-deployment.html")}">Deployment options</a></li>
+ </ul>
+ </li>
+
+ <li id="nmr">
+ <a href="${uri("/users-guide/nmr/nmr-index.html")}">Using the NMR</a>
+ <ul>
+ <li id="camel-nmr"><a href="${uri("/users-guide/nmr/nmr-camel.html")}">Camel NMR</a></li>
+ <li id="nmr-event-listeners"><a href="${uri("/users-guide/nmr/nmr-event-listeners.html")}">Event Listeners</a></li>
+ </ul>
+ </li>
+ <li id="jbi-components">
+ <a href="#">JBI Components</a>
+ <ul>
+ <li id="servicemix-bean"><a href="${uri("/users-guide/jbi/servicemix-bean.html")}">servicemix-bean</a></li>
+ <li id="servicemix-camel"><a href="${uri("/users-guide/jbi/servicemix-camel.html")}">servicemix-camel</a></li>
+ <li id="servicemix-cxf-bc"><a href="${uri("/users-guide/jbi/servicemix-cxf-bc.html")}">servicemix-cxf-bc</a></li>
+ <li id="servicemix-cxf-se"><a href="${uri("/users-guide/jbi/servicemix-cxf-se.html")}">servicemix-cxf-se</a></li>
+ <li id="servicemix-drools"><a href="${uri("/users-guide/jbi/servicemix-drools.html")}">servicemix-drools</a></li>
+ <li id="servicemix-eip"><a href="${uri("/users-guide/jbi/servicemix-eip.html")}">servicemix-eip</a></li>
+ <li id="servicemix-file"><a href="${uri("/users-guide/jbi/servicemix-file.html")}">servicemix-file</a></li>
+ <li id="servicemix-ftp"><a href="${uri("/users-guide/jbi/servicemix-ftp.html")}">servicemix-ftp</a></li>
+ <li id="servicemix-http"><a href="${uri("/users-guide/jbi/servicemix-http.html")}">servicemix-http</a></li>
+ <li id="servicemix-jms"><a href="${uri("/users-guide/jbi/servicemix-jms.html")}">servicemix-jms</a></li>
+ <li id="servicemix-mail"><a href="${uri("/users-guide/jbi/servicemix-mail.html")}">servicemix-mail</a></li>
+ <li id="servicemix-osworkflow"><a href="${uri("/users-guide/jbi/servicemix-osworkflow.html")}">servicemix-osworkflow</a></li>
+ <li id="servicemix-quartz"><a href="${uri("/users-guide/jbi/servicemix-quartz.html")}">servicemix-quartz</a></li>
+ <li id="servicemix-saxon"><a href="${uri("/users-guide/jbi/servicemix-saxon.html")}">servicemix-saxon</a></li>
+ <li id="servicemix-scripting"><a href="${uri("/users-guide/jbi/servicemix-scripting.html")}">servicemix-scripting</a></li>
+ <li id="servicemix-snmp"><a href="${uri("/users-guide/jbi/servicemix-snmp.html")}">servicemix-snmp</a></li>
+ <li id="servicemix-validation"><a href="${uri("/users-guide/jbi/servicemix-validation.html")}">servicemix-validation</a></li>
+ <li id="servicemix-vfs"><a href="${uri("/users-guide/jbi/servicemix-vfs.html")}">servicemix-vfs</a></li>
+ <li id="servicemix-wsn2005"><a href="${uri("/users-guide/jbi/servicemix-wsn2005.html")}">servicemix-wsn2005</a></li>
+ <li id="servicemix-xmpp"><a href="${uri("/users-guide/jbi/servicemix-xmpp.html")}">servicemix-xmpp</a></li>
+ </ul>
+ </li>
+ <li id="appendices">
+ <a href="#">Appendices</a>
+ <ul>
+ <li id="migration"><a href="${uri("/users-guide/appendices/migration.html")}">Migrating from ServiceMix 3</a></li>
+ </ul>
+ </li>
+
+</ul>
\ No newline at end of file
diff --git a/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala b/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala
new file mode 100644
index 0000000..221618d
--- /dev/null
+++ b/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala
@@ -0,0 +1,35 @@
+/**
+ * Copyright (C) 2009-2010 the original author or authors.
+ * See the notice.md file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.servicemix.documentation
+
+import org.apache.servicemix.documentation.Helper._
+import org.junit.Test
+import org.junit.Assert.{assertEquals}
+
+/**
+ * Test case for org.apache.servicemix.documentation.Helper
+ */
+class HelperTest {
+
+ @Test
+ def testTocHelper = {
+ assertEquals("Should return valid TOC for /users-guide/index.conf",
+ "/users-guide/toc.ssp", toc("/users-guide/index.conf"))
+ }
+
+}
