SMX4-1289: Improve readability of Karaf manual pages
Thanks to Filippo Balicchia for the patch!
git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/trunk@1441516 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/pom.xml b/pom.xml
index eeab06c..3a3e8d3 100644
--- a/pom.xml
+++ b/pom.xml
@@ -300,7 +300,7 @@
<executions>
<execution>
<!-- Unpack the manual sources into the /karaf subdirectory -->
- <id>unpack-karaf-manual</id>
+ <id>unpack-developer-karaf-manual</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
@@ -312,12 +312,35 @@
<artifactId>manual</artifactId>
<version>${karaf.version}</version>
<type>war</type>
- <outputDirectory>${project.build.directory}/webapp/karaf</outputDirectory>
- <includes>developers-guide/*.conf,users-guide/*.conf</includes>
+ <outputDirectory>${project.build.directory}/webapp</outputDirectory>
+ <includes>developers-guide/*.conf</includes>
<!-- TODO: figure out how to handle these files that refer to the karaf codebase -->
<excludes>
- developers-guide/security-framework.conf,
- users-guide/provisioning-schema.conf
+ developers-guide/security-framework.conf
+ </excludes>
+ </artifactItem>
+ </artifactItems>
+ </configuration>
+ </execution>
+ <execution>
+ <!-- Unpack the manual sources into the /karaf subdirectory -->
+ <id>unpack-user-karaf-manual</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>unpack</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>org.apache.karaf</groupId>
+ <artifactId>manual</artifactId>
+ <version>${karaf.version}</version>
+ <type>war</type>
+ <outputDirectory>${project.build.directory}/webapp</outputDirectory>
+ <includes>users-guide/*.conf</includes>
+ <excludes>
+ users-guide/security-framework.conf,
+ users-guide/provisioning-schema.conf
</excludes>
</artifactItem>
</artifactItems>
@@ -345,7 +368,6 @@
</execution>
</executions>
</plugin>
-
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
diff --git a/src/main/webapp/developers-guide/toc.ssp b/src/main/webapp/developers-guide/toc.ssp
new file mode 100644
index 0000000..a0f2bd4
--- /dev/null
+++ b/src/main/webapp/developers-guide/toc.ssp
@@ -0,0 +1,25 @@
+<ul>
+ <li id="karaf-developers-guide">
+ <a href="#">Developer's Guide</a>
+ <ul>
+ <li id="extending-console">
+ <a href="${uri("/developers-guide/extending-console.html")}">Extending Console</a>
+ </li>
+ <li id="writing-tests">
+ <a href="${uri("/developers-guide/writing-tests.html")}">Tests with Pax Exam</a>
+ </li>
+ <li id="debugging">
+ <a href="${uri("/developers-guide/debugging.html")}">Debug Karaf</a>
+ </li>
+ <li id="creating-bundles">
+ <a href="${uri("/developers-guide/creating-bundles.html")}">Creating bundles</a>
+ </li>
+ <li id="connect-console">
+ <a href="${uri("/developers-guide/connect-console.html")}">Connect to the console</a>
+ </li>
+ <li id="shell-syntax">
+ <a href="${uri("/developers-guide/shell-syntax.html")}">Console shell syntax</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 324e556..3a15633 100644
--- a/src/main/webapp/index.ssp
+++ b/src/main/webapp/index.ssp
@@ -85,16 +85,6 @@
</div>
<div class="left">
- <a href="karaf/index.html">
- <h2>Karaf Manual</h2>
- </a>
-</div>
-
-<div class="right">
- <p>Apache ServiceMix uses Apache Karaf as the underlying OSGi server runtime. This manual will explain the features and functionality provided by Karaf.</p>
-</div>
-
-<div class="left">
<a href="commands/index.html">
<h2>Command Reference</h2>
</a>
@@ -105,6 +95,27 @@
</div>
<div class="left">
+ <a href="users-guide/index.html">
+ <h2>Karaf User guide</h2>
+ </a>
+</div>
+
+<div class="right">
+ <p>Apache ServiceMix uses Apache Karaf as the underlying OSGi server runtime. This manual explains about the features and functionality provided by Karaf.</p>
+</div>
+
+<div class="left">
+ <a href="developers-guide/index.html">
+ <h2>Karaf Developer guide</h2>
+ </a>
+</div>
+
+<div class="right">
+ <p>The Apache Karaf Developer Guide gives you some information about developing with and for the OSGi server runtime.</p>
+</div>
+
+
+<div class="left">
<a href="commercial.html">
<h2>Commercial Guides</h2>
</a>
@@ -115,4 +126,4 @@
</div>
</div>
-<div class="clearing"></div>
\ No newline at end of file
+<div class="clearing"></div>
diff --git a/src/main/webapp/users-guide/toc.ssp b/src/main/webapp/users-guide/toc.ssp
new file mode 100644
index 0000000..0b54ad3
--- /dev/null
+++ b/src/main/webapp/users-guide/toc.ssp
@@ -0,0 +1,43 @@
+<ul>
+ <li id="karaf-users-guide">
+ <a href="#">User's Guide</a>
+ <ul>
+ <li id="karaf-installation">
+ <a href="${uri("/users-guide/installation.html")}">Installation</a>
+ </li>
+ <li id="karaf-directory-structure">
+ <a href="${uri("/users-guide/directory-structure.html")}">Directory structure</a>
+ </li>
+ <li id="karaf-starting-and-stopping">
+ <a href="${uri("/users-guide/start-stop.html")}">Starting and stopping Karaf</a>
+ </li>
+ <li id="using-console">
+ <a href="${uri("/users-guide/using-console.html")}">Using the console</a>
+ </li>
+ <li id="web-console">
+ <a href="${uri("/users-guide/web-console.html")}">Web console</a>
+ </li>
+ <li id="remote-console">
+ <a href="${uri("/users-guide/remote-console.html")}">Remote console</a>
+ </li>
+ <li id="child-instances">
+ <a href="${uri("/users-guide/child-instances.html")}">Child instances</a>
+ </li>
+ <li id="security">
+ <a href="${uri("/users-guide/security.html")}">Security</a>
+ </li>
+ <li id="failover">
+ <a href="${uri("/users-guide/failover.html")}">Failover deployments</a>
+ </li>
+ <li id="logging-system">
+ <a href="${uri("/users-guide/logging-system.html")}">Logging system</a>
+ </li>
+ <li id="deployer">
+ <a href="${uri("/users-guide/deployer.html")}">Deployer</a>
+ </li>
+ <li id="configuration">
+ <a href="${uri("/users-guide/configuration.html")}">Configuration</a>
+ </li>
+ </ul>
+ </li>
+</ul>
