Allow Karaf manual contents to be included
git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/trunk@1023675 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/pom.xml b/pom.xml
index d771b2d..9810e49 100644
--- a/pom.xml
+++ b/pom.xml
@@ -86,6 +86,33 @@
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>src-dependencies</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>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
@@ -199,8 +226,8 @@
<tasks>
<echo message="Generating PDF using Prince XML (http://www.princexml.com/)"/>
<exec executable="prince">
- <arg value="${project.build.directory}/sitegen/manual.html" />
- <arg value="${project.build.directory}/sitegen/manual.pdf" />
+ <arg value="${project.build.directory}/sitegen/users-guide/manual.html" />
+ <arg value="${project.build.directory}/sitegen/users-guide/manual.pdf" />
<arg value="--log"/>
<arg value="${project.build.directory}/prince.log"/>
</exec>
@@ -228,8 +255,9 @@
<configuration>
<artifacts>
<artifact>
- <file>${project.build.directory}/sitegen/manual.pdf</file>
+ <file>${project.build.directory}/sitegen/users-guide/users-guide.pdf</file>
<type>pdf</type>
+ <classifier>users-guide</classifier>
</artifact>
</artifacts>
</configuration>
diff --git a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
index 8d27e6b..ec38326 100644
--- a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
+++ b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
@@ -17,6 +17,7 @@
--%>
<%@ var body: String %>
<%@ var title: String = "Apache ServiceMix ${servicemix.version}" %>
+<%@ var navigation: Boolean = true %>
<!DOCTYPE html>
<html>
<head>
@@ -49,12 +50,13 @@
<div id="main">
+ <% if (navigation) { %>
<nav>
<div id="navigation">
${include("/toc.ssp")}
</div>
-
</nav>
+ <% } %>
<div id="body">
<%= body %>
diff --git a/src/main/webapp/index.ssp b/src/main/webapp/index.ssp
new file mode 100644
index 0000000..55ee0d9
--- /dev/null
+++ b/src/main/webapp/index.ssp
@@ -0,0 +1,10 @@
+<% attributes("navigation") = false %>
+<h1>Welcome to the Apache ServiceMix documentation</h1>
+
+If you're new to Apache ServiceMix, we recommend you start here
+
+<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>
+</ul>
\ No newline at end of file
diff --git a/src/main/webapp/manual.conf b/src/main/webapp/manual.conf
deleted file mode 100644
index eee7de1..0000000
--- a/src/main/webapp/manual.conf
+++ /dev/null
@@ -1,43 +0,0 @@
-{attributes:layout=/WEB-INF/scalate/layouts/print.ssp}
-
-h1. Getting started
-{include:getting-started/what-is-smx4.conf}
-{include:getting-started/installation.conf}
-{include:getting-started/discover.conf}
-{include:getting-started/technology-selection.conf}
-
-h1. Camel
-{include:camel/camel-index.conf}
-{include:camel/camel-deployment.conf}
-
-h1. NMR
-{include:nmr-index}
-{include:nmr-camel}
-{include:nmr-event-listeners}
-
-h1. JBI
-
-h1. JBI Component Reference
-{include:jbi/servicemix-bean.conf}
-{include:jbi/servicemix-camel.conf}
-{include:jbi/servicemix-cxf-bc.conf}
-{include:jbi/servicemix-cxf-se.conf}
-{include:jbi/servicemix-drools.conf}
-{include:jbi/servicemix-eip.conf}
-{include:jbi/servicemix-file.conf}
-{include:jbi/servicemix-ftp.conf}
-{include:jbi/servicemix-http.conf}
-{include:jbi/servicemix-jms.conf}
-{include:jbi/servicemix-mail.conf}
-{include:jbi/servicemix-osworkflow.conf}
-{include:jbi/servicemix-quartz.conf}
-{include:jbi/servicemix-saxon.conf}
-{include:jbi/servicemix-scripting.conf}
-{include:jbi/servicemix-snmp.conf}
-{include:jbi/servicemix-validation.conf}
-{include:jbi/servicemix-vfs.conf}
-{include:jbi/servicemix-wsn2005.conf}
-{include:jbi/servicemix-xmpp.conf}
-
-h1. Appendices
-{include:appendices/migration.conf}
diff --git a/src/main/webapp/appendices/migration.conf b/src/main/webapp/users-guide/appendices/migration.conf
similarity index 100%
rename from src/main/webapp/appendices/migration.conf
rename to src/main/webapp/users-guide/appendices/migration.conf
diff --git a/src/main/webapp/camel/camel-deployment.conf b/src/main/webapp/users-guide/camel/camel-deployment.conf
similarity index 100%
rename from src/main/webapp/camel/camel-deployment.conf
rename to src/main/webapp/users-guide/camel/camel-deployment.conf
diff --git a/src/main/webapp/camel/camel-index.conf b/src/main/webapp/users-guide/camel/camel-index.conf
similarity index 100%
rename from src/main/webapp/camel/camel-index.conf
rename to src/main/webapp/users-guide/camel/camel-index.conf
diff --git a/src/main/webapp/getting-started/discover.conf b/src/main/webapp/users-guide/getting-started/discover.conf
similarity index 100%
rename from src/main/webapp/getting-started/discover.conf
rename to src/main/webapp/users-guide/getting-started/discover.conf
diff --git a/src/main/webapp/getting-started/installation.conf b/src/main/webapp/users-guide/getting-started/installation.conf
similarity index 100%
rename from src/main/webapp/getting-started/installation.conf
rename to src/main/webapp/users-guide/getting-started/installation.conf
diff --git a/src/main/webapp/getting-started/technology-selection.conf b/src/main/webapp/users-guide/getting-started/technology-selection.conf
similarity index 100%
rename from src/main/webapp/getting-started/technology-selection.conf
rename to src/main/webapp/users-guide/getting-started/technology-selection.conf
diff --git a/src/main/webapp/getting-started/what-is-smx4.conf b/src/main/webapp/users-guide/getting-started/what-is-smx4.conf
similarity index 100%
rename from src/main/webapp/getting-started/what-is-smx4.conf
rename to src/main/webapp/users-guide/getting-started/what-is-smx4.conf
diff --git a/src/main/webapp/index.conf b/src/main/webapp/users-guide/index.conf
similarity index 100%
rename from src/main/webapp/index.conf
rename to src/main/webapp/users-guide/index.conf
diff --git a/src/main/webapp/jbi/servicemix-bean.conf b/src/main/webapp/users-guide/jbi/servicemix-bean.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-bean.conf
rename to src/main/webapp/users-guide/jbi/servicemix-bean.conf
diff --git a/src/main/webapp/jbi/servicemix-camel.conf b/src/main/webapp/users-guide/jbi/servicemix-camel.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-camel.conf
rename to src/main/webapp/users-guide/jbi/servicemix-camel.conf
diff --git a/src/main/webapp/jbi/servicemix-cxf-bc.conf b/src/main/webapp/users-guide/jbi/servicemix-cxf-bc.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-cxf-bc.conf
rename to src/main/webapp/users-guide/jbi/servicemix-cxf-bc.conf
diff --git a/src/main/webapp/jbi/servicemix-cxf-se.conf b/src/main/webapp/users-guide/jbi/servicemix-cxf-se.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-cxf-se.conf
rename to src/main/webapp/users-guide/jbi/servicemix-cxf-se.conf
diff --git a/src/main/webapp/jbi/servicemix-drools.conf b/src/main/webapp/users-guide/jbi/servicemix-drools.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-drools.conf
rename to src/main/webapp/users-guide/jbi/servicemix-drools.conf
diff --git a/src/main/webapp/jbi/servicemix-eip.conf b/src/main/webapp/users-guide/jbi/servicemix-eip.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-eip.conf
rename to src/main/webapp/users-guide/jbi/servicemix-eip.conf
diff --git a/src/main/webapp/jbi/servicemix-file.conf b/src/main/webapp/users-guide/jbi/servicemix-file.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-file.conf
rename to src/main/webapp/users-guide/jbi/servicemix-file.conf
diff --git a/src/main/webapp/jbi/servicemix-ftp.conf b/src/main/webapp/users-guide/jbi/servicemix-ftp.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-ftp.conf
rename to src/main/webapp/users-guide/jbi/servicemix-ftp.conf
diff --git a/src/main/webapp/jbi/servicemix-http.conf b/src/main/webapp/users-guide/jbi/servicemix-http.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-http.conf
rename to src/main/webapp/users-guide/jbi/servicemix-http.conf
diff --git a/src/main/webapp/jbi/servicemix-jms.conf b/src/main/webapp/users-guide/jbi/servicemix-jms.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-jms.conf
rename to src/main/webapp/users-guide/jbi/servicemix-jms.conf
diff --git a/src/main/webapp/jbi/servicemix-mail.conf b/src/main/webapp/users-guide/jbi/servicemix-mail.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-mail.conf
rename to src/main/webapp/users-guide/jbi/servicemix-mail.conf
diff --git a/src/main/webapp/jbi/servicemix-osworkflow.conf b/src/main/webapp/users-guide/jbi/servicemix-osworkflow.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-osworkflow.conf
rename to src/main/webapp/users-guide/jbi/servicemix-osworkflow.conf
diff --git a/src/main/webapp/jbi/servicemix-quartz.conf b/src/main/webapp/users-guide/jbi/servicemix-quartz.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-quartz.conf
rename to src/main/webapp/users-guide/jbi/servicemix-quartz.conf
diff --git a/src/main/webapp/jbi/servicemix-saxon.conf b/src/main/webapp/users-guide/jbi/servicemix-saxon.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-saxon.conf
rename to src/main/webapp/users-guide/jbi/servicemix-saxon.conf
diff --git a/src/main/webapp/jbi/servicemix-scripting.conf b/src/main/webapp/users-guide/jbi/servicemix-scripting.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-scripting.conf
rename to src/main/webapp/users-guide/jbi/servicemix-scripting.conf
diff --git a/src/main/webapp/jbi/servicemix-snmp.conf b/src/main/webapp/users-guide/jbi/servicemix-snmp.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-snmp.conf
rename to src/main/webapp/users-guide/jbi/servicemix-snmp.conf
diff --git a/src/main/webapp/jbi/servicemix-validation.conf b/src/main/webapp/users-guide/jbi/servicemix-validation.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-validation.conf
rename to src/main/webapp/users-guide/jbi/servicemix-validation.conf
diff --git a/src/main/webapp/jbi/servicemix-vfs.conf b/src/main/webapp/users-guide/jbi/servicemix-vfs.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-vfs.conf
rename to src/main/webapp/users-guide/jbi/servicemix-vfs.conf
diff --git a/src/main/webapp/jbi/servicemix-wsn2005.conf b/src/main/webapp/users-guide/jbi/servicemix-wsn2005.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-wsn2005.conf
rename to src/main/webapp/users-guide/jbi/servicemix-wsn2005.conf
diff --git a/src/main/webapp/jbi/servicemix-xmpp.conf b/src/main/webapp/users-guide/jbi/servicemix-xmpp.conf
similarity index 100%
rename from src/main/webapp/jbi/servicemix-xmpp.conf
rename to src/main/webapp/users-guide/jbi/servicemix-xmpp.conf
diff --git a/src/main/webapp/users-guide/manual.conf b/src/main/webapp/users-guide/manual.conf
new file mode 100644
index 0000000..359014c
--- /dev/null
+++ b/src/main/webapp/users-guide/manual.conf
@@ -0,0 +1,43 @@
+{attributes:layout=/WEB-INF/scalate/layouts/print.ssp}
+
+h1. Getting started
+{include:users-guide/getting-started/what-is-smx4.conf}
+{include:users-guide/getting-started/installation.conf}
+{include:users-guide/getting-started/discover.conf}
+{include:users-guide/getting-started/technology-selection.conf}
+
+h1. Camel
+{include:users-guide/camel/camel-index.conf}
+{include:users-guide/camel/camel-deployment.conf}
+
+h1. NMR
+{include:users-guide/nmr-index}
+{include:users-guide/nmr-camel}
+{include:users-guide/nmr-event-listeners}
+
+h1. JBI
+
+h1. JBI Component Reference
+{include:users-guide/jbi/servicemix-bean.conf}
+{include:users-guide/jbi/servicemix-camel.conf}
+{include:users-guide/jbi/servicemix-cxf-bc.conf}
+{include:users-guide/jbi/servicemix-cxf-se.conf}
+{include:users-guide/jbi/servicemix-drools.conf}
+{include:users-guide/jbi/servicemix-eip.conf}
+{include:users-guide/jbi/servicemix-file.conf}
+{include:users-guide/jbi/servicemix-ftp.conf}
+{include:users-guide/jbi/servicemix-http.conf}
+{include:users-guide/jbi/servicemix-jms.conf}
+{include:users-guide/jbi/servicemix-mail.conf}
+{include:users-guide/jbi/servicemix-osworkflow.conf}
+{include:users-guide/jbi/servicemix-quartz.conf}
+{include:users-guide/jbi/servicemix-saxon.conf}
+{include:users-guide/jbi/servicemix-scripting.conf}
+{include:users-guide/jbi/servicemix-snmp.conf}
+{include:users-guide/jbi/servicemix-validation.conf}
+{include:users-guide/jbi/servicemix-vfs.conf}
+{include:users-guide/jbi/servicemix-wsn2005.conf}
+{include:users-guide/jbi/servicemix-xmpp.conf}
+
+h1. Appendices
+{include:users-guide/appendices/migration.conf}
diff --git a/src/main/webapp/nmr/nmr-camel.conf b/src/main/webapp/users-guide/nmr/nmr-camel.conf
similarity index 100%
rename from src/main/webapp/nmr/nmr-camel.conf
rename to src/main/webapp/users-guide/nmr/nmr-camel.conf
diff --git a/src/main/webapp/nmr/nmr-event-listeners.conf b/src/main/webapp/users-guide/nmr/nmr-event-listeners.conf
similarity index 100%
rename from src/main/webapp/nmr/nmr-event-listeners.conf
rename to src/main/webapp/users-guide/nmr/nmr-event-listeners.conf
diff --git a/src/main/webapp/nmr/nmr-index.conf b/src/main/webapp/users-guide/nmr/nmr-index.conf
similarity index 100%
rename from src/main/webapp/nmr/nmr-index.conf
rename to src/main/webapp/users-guide/nmr/nmr-index.conf
