Few minor style updates to the documentation pages
git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/trunk@1364402 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/pom.xml b/pom.xml
index ce88608..c251d41 100644
--- a/pom.xml
+++ b/pom.xml
@@ -53,7 +53,7 @@
<camel.version>2.8.3</camel.version>
<components.version>2011.01</components.version>
<karaf.version>2.2.3</karaf.version>
- <servicemix.version>4.4.0</servicemix.version>
+ <servicemix.version>4.4.2</servicemix.version>
</properties>
<dependencies>
diff --git a/src/main/scala/org/apache/servicemix/documentation/Helper.scala b/src/main/scala/org/apache/servicemix/documentation/Helper.scala
index 7d417cd..d69da56 100644
--- a/src/main/scala/org/apache/servicemix/documentation/Helper.scala
+++ b/src/main/scala/org/apache/servicemix/documentation/Helper.scala
@@ -31,7 +31,7 @@
/**
* No TOCs can be found in subfolders of the folders listed here
*/
- val PATH_LIMITS = Array("/jbi", "/users-guide/camel")
+ val PATH_LIMITS = Array("/jbi", "/camel")
/**
* Determine the right toc file to include for a given uri
diff --git a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
index 91b3459..a19bd53 100644
--- a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
+++ b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
@@ -60,74 +60,32 @@
</script>
</head>
<body>
+ <div id="page">
<div id="siteHeader">
<table width="100%">
<tr valign="middle">
<td align="left">
<a href="http://servicemix.apache.org/" title="An open source ESB">
- <img border="0" src="${uri("/images/logodesign.png")}" height="100"/><img border="0" src="${uri("/images/new-logo.png")}" />
+ <img border="0" src="${uri("/images/logodesign.png")}" height="80"/><img border="0" height="80" src="${uri("/images/new-logo.png")}" />
</a>
</td>
<td align="right">
<a href="http://www.apache.org/" title="The Apache Sofware Foundation">
- <img border="0" src="${uri("http://activemq.apache.org/images/asf-logo.png")}">
+ <img border="0" height="60" src="${uri("/images/ASF-logo.png")}">
</a>
- </td>
- </tr>
- <tr>
- <td colspan="2">
<ul class="siteNav">
- <li ><a href="http://servicemix.apache.org/" title="Overview">Overview</a></li>
- <li><a href="http://servicemix.apache.org/download.html" title="Download">Download</a></li>
- <li><a href="${uri("/index.html")}" title="Documentation">Documentation</a></li>
- <li>
- <a href="http://servicemix.apache.org/support/index.html" title="Support">Support</a>
- <ul>
- <li><a href="http://servicemix.apache.org/support/mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li>
- <li><a href="http://servicemix.apache.org/support/discussion-forums.html" title="Discussion Forums">Forums</a></li>
- <li><a href="http://servicemix.apache.org/irc.html" title="IRC">IRC</a></li>
- <li><a href="http://servicemix.apache.org/support/faq.html" title="FAQ">FAQ</a></li>
- <li><a href="http://servicemix.apache.org/support/presentations.html" title="Presentations">Presentations</a></li>
- </ul>
- </li>
- <li>
- <a href="http://servicemix.apache.org/contrib/index.html" title="Contributing">Contributing</a>
- <ul>
- <li><a href="http://servicemix.apache.org/contrib/becoming-a-committer.html" title="Committing">Become a committer</a></li>
- <li><a href="http://servicemix.apache.org/contrib/committers-guide.html" title="Committing Guide">Committer Guide</a></li>
- <li><a href="http://servicemix.apache.org/contrib/source.html" title="Source">Source</a></li>
- <li><a href="http://issues.apache.org/activemq/browse/SM" title="JIRA">JIRA</a></li>
- <li><a href="http://servicemix.apache.org/contrib/developers.html" title="Developers">Developer Resources</a></li>
- </ul>
- </li>
- <% if (sitegen(engine)) { %>
+ <li><a href="${uri("/index.html")}" title="Overview">Guides Overview</a></li>
+ <li><a href="${uri("/contribute.html")}" title="Contributing?">Contributing?</a></li>
<li>
<form action="http://www.google.com/search" method="get" style="font-size: 10px;">
- <input name="ie" type="hidden" value="UTF-8"></input>
- <input name="oe" type="hidden" value="UTF-8"></input>
+ <input name="ie" type="hidden" value="UTF-8"></input>
+ <input name="oe" type="hidden" value="UTF-8"></input>
<input maxlength="255" name="q" size="15" type="text" value=""></input>
<input name="btnG" type="submit" value="Search"></input>
- <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.3.0-SNAPSHOT/"></input>
- <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.3.0-SNAPSHOT/"></input>
+ <input name="domains" type="hidden" value="servicemix.apache.org/docs/4.4.0/"></input>
+ <input name="sitesearch" type="hidden" value="servicemix.apache.org/docs/4.4.0/"></input>
</form>
</li>
- <% } %>
- </ul>
- </td>
- </tr>
- </table>
- </div>
- <div id="sectHeader">
- <table width="100%">
- <tr>
- <td>
- <a href="${uri("/index.html")}><h1>Apache ServiceMix Guides</h1></a>
- </td>
- <td align="right" valign="middle">
- <ul class="sectNav">
- <li><a href="${uri("/index.html")}" title="Home">Home</a></li>
- <li>Guides</li>
- <li><a href="${uri("/contribute.html")}">Contribute</a></li>
</ul>
</td>
</tr>
@@ -155,9 +113,10 @@
<% } %>
</div>
<div id="siteFooter">
- © 2008-2011 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
+ © 2008-2012 The Apache Software Foundation - <a href="http://servicemix.apache.org/site/privacy-policy.html">Privacy Policy</a>
<br/>
Apache ServiceMix, ServiceMix, Apache, the Apache feather logo, and the Apache ServiceMix project logo are trademarks of The Apache Software Foundation.
</div>
+ </div>
</body>
</html>
\ No newline at end of file
diff --git a/src/main/webapp/camel/toc.ssp b/src/main/webapp/camel/toc.ssp
index 58e1757..9b374b7 100644
--- a/src/main/webapp/camel/toc.ssp
+++ b/src/main/webapp/camel/toc.ssp
@@ -1,20 +1,20 @@
<ul>
<li id="camel">
- <a href="${uri("/users-guide/camel/index.html")}">Using Camel</a>
+ <a href="${uri("/camel/index.html")}">Using Camel</a>
<ul>
- <li id="camel-deploy"><a href="${uri("/users-guide/camel/deployment/index.html")}">Deployment options</a>
+ <li id="camel-deploy"><a href="${uri("/camel/deployment/index.html")}">Deployment options</a>
<ul>
- <li id="plain-blueprint"><a href="${uri("/users-guide/camel/deployment/plain-blueprint.html")}">Plain Blueprint XML</a></li>
- <li id="plain-spring"><a href="${uri("/users-guide/camel/deployment/plain-spring.html")}">Plain Spring XML</a></li>
- <li id="osgi-bundle-spring"><a href="${uri("/users-guide/camel/deployment/osgi-bundle-spring.html")}">OSGi Bundle using Spring</a></li>
- <li id="osgi-bundle-blueprint"><a href="${uri("/users-guide/camel/deployment/osgi-bundle-blueprint.html")}">OSGi Bundle using Blueprint</a></li>
+ <li id="plain-blueprint"><a href="${uri("/camel/deployment/plain-blueprint.html")}">Plain Blueprint XML</a></li>
+ <li id="plain-spring"><a href="${uri("/camel/deployment/plain-spring.html")}">Plain Spring XML</a></li>
+ <li id="osgi-bundle-spring"><a href="${uri("/camel/deployment/osgi-bundle-spring.html")}">OSGi Bundle using Spring</a></li>
+ <li id="osgi-bundle-blueprint"><a href="${uri("/camel/deployment/osgi-bundle-blueprint.html")}">OSGi Bundle using Blueprint</a></li>
</ul>
</li>
<li id="installing-components">
- <a href="${uri("/users-guide/camel/installing-components.html")}">Installing components</a>
+ <a href="${uri("/camel/installing-components.html")}">Installing components</a>
</li>
<li id="troubleshooting">
- <a href="${uri("/users-guide/camel/troubleshooting.html")}">Troubleshooting</a>
+ <a href="${uri("/camel/troubleshooting.html")}">Troubleshooting</a>
</li>
</ul>
</li>
diff --git a/src/main/webapp/contribute.page b/src/main/webapp/contribute.page
index 3749487..98982ca 100644
--- a/src/main/webapp/contribute.page
+++ b/src/main/webapp/contribute.page
@@ -6,29 +6,20 @@
# Contributing to the Documentation
-## Getting the Source
+## Found an mistake or have a suggestion for improvement?
-## Editing the Source
+We welcome any feedback or contribution to the documentation.
-The documentation is written in a combination of mark-up languages. Most of the pages are written
-using Comfluence mark-up or Markdown. The pages can be editied in any text editor.
+Whether you spotted a mistake, have suggestions for new content or just want to say hi, feel to get in touch using the [mailing lists](http://servicemix.apache.org/community/mailing-lists.html), [IRC channel](http://servicemix.apache.org/community/irc.html) or on Twitter using the `#servicemix` hash tag.
-Pages are grouped into books using the `toc.ssp` file in the enclosing folder. This file contains
-an HTML formated list defining the TOC for a book.
+## Contributing to the documentation code
-## Building
-You can build the documentation as follows:
+The documentation is written in a combination of mark-up languages. Most of the pages are written
+using Confluence mark-up or Markdown. The pages can be edited in any text editor.
- {pygmentize:: text}
- mvn install
- {pygmentize}
+Pages are grouped into books using the `toc.ssp` file in the enclosing folder. This file contains
+an HTML formatted list defining the TOC for a book.
-If you want to edit the files in your text editor and be able to immediately see the site re-rendered in a browser then use
+You can find more information about how to get and build the documentation codebase [here](http://servicemix.apache.org/developers/source/documentation-source.html) and one more thing...
- {pygmentize:: text}
- mvn jetty:run
- {pygmentize}
-
-You can now surf the site and see changes immediately.
-
-If you are on OS X then we highly recommend [TextMate](http://macromates.com/) as a great editor which supports Textile and Markdown
\ No newline at end of file
+... we really love documentation patches ;)
\ No newline at end of file
diff --git a/src/main/webapp/images/ASF-logo.png b/src/main/webapp/images/ASF-logo.png
new file mode 100644
index 0000000..71adced
--- /dev/null
+++ b/src/main/webapp/images/ASF-logo.png
Binary files differ
diff --git a/src/main/webapp/index.ssp b/src/main/webapp/index.ssp
index cce3f83..3ec5f6d 100644
--- a/src/main/webapp/index.ssp
+++ b/src/main/webapp/index.ssp
@@ -113,4 +113,6 @@
<div class="right">
<p>Documentation from commercial providers and books you can buy.</p>
</div>
-</div>
\ No newline at end of file
+</div>
+
+<div class="clearing"></div>
\ No newline at end of file
diff --git a/src/main/webapp/theme/images/bg.png b/src/main/webapp/theme/images/bg.png
new file mode 100644
index 0000000..878a84f
--- /dev/null
+++ b/src/main/webapp/theme/images/bg.png
Binary files differ
diff --git a/src/main/webapp/theme/master.css b/src/main/webapp/theme/master.css
index bff2829..d09f521 100644
--- a/src/main/webapp/theme/master.css
+++ b/src/main/webapp/theme/master.css
@@ -5,7 +5,6 @@
body {
font-family: Verdana, Arial, sans-serif;
margin: 0px auto;
- width: 95%;
font-size: .8em;
}
@@ -17,13 +16,24 @@
margin: 1em;
}
+div#page {
+ padding-top: 12px;
+}
+
div#siteHeader {
- background-color: #76a3cd;
- padding-left: 20px;
- padding-right: 20px;
+ background-image: url("images/bg.png");
clear: both;
}
+img {
+ margin: 2px;
+}
+
+div#siteHeader table {
+ margin: 2px auto;
+ width: 85%;
+}
+
div#siteHeader a:link {
color: #ffffff;
text-decoration: none;
@@ -43,49 +53,21 @@
vertical-align: middle;
}
-ul.siteNav {
+div#siteHeader ul.siteNav {
list-style-type: none;
padding:0;
- margin:0;
- position: relative;
- left:40%;
- }
+ margin-top: 15px;
+ text-align: right;
+}
ul.siteNav li {
- display: inline;
- float: left;
- padding: 0 20px;
- }
-
-ul.siteNav li ul {
- position:absolute;
- margin-top:-1em;
- margin-left:.5em;
- display: none;
- }
-
-ul.siteNav li a {
- text-decoration: none;
- padding: 5px;
- }
-
-ul.siteNav li:hover ul {
-display: block;
+ display: inline;
+ padding-left: 40px;
+ font-weight: 300;
}
-ul.siteNav li ul {
- list-style-type: none;
- padding:0;
- margin:0;
- margin-top:5px;
- margin-bottom:5px;
- background-color: #76a3cd;
-}
-
-ul.siteNav li ul li {
- clear: both;
- margin:3px;
- padding:3px;
+ul.siteNav li form {
+ display: inline-block;
}
div#sectHeader {
@@ -133,21 +115,20 @@
}
div#siteFooter {
- height: 25px;
- background-color: #76a3cd;
+ background: url("images/bg.png") center;
margin-top: 30px;
color: #ffffff;
text-align: center;
vertical-align: bottom;
clear: both;
- padding-left: 20px;
- padding-right: 20px;
+ padding: 2px 20px;
font-size: 80%;
}
div#content {
- clear: both;
- margin: 30px;
+ clear: both;
+ margin: 50px auto;
+ width: 85%;
}
div#body {
@@ -163,6 +144,10 @@
margin-bottom: 30px;
}
+div.clearing {
+ clear: both;
+}
+
div.highlight pre {
font-family: 'Courier', Courier, monospace;
font-size: 1em;
diff --git a/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala b/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala
index fc8fa5c..01024f9 100644
--- a/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala
+++ b/src/test/scala/org/apache/servicemix/documentation/HelperTest.scala
@@ -32,9 +32,9 @@
@Test
def testTocHelper = {
assertValidToc("/users-guide/toc.ssp", "/users-guide/index.conf")
- assertValidToc("/users-guide/camel/toc.ssp", "/users-guide/camel/index.conf")
+ assertValidToc("/camel/toc.ssp", "/camel/index.conf")
+ assertValidToc("/camel/toc.ssp", "/camel/deployment/index.conf")
assertValidToc("/jbi/toc.ssp", "/jbi/components/index.html")
- assertValidToc("/users-guide/camel/toc.ssp", "/users-guide/camel/deployment/osgi-bundle.conf")
}
@Test
@@ -43,7 +43,6 @@
sitegen(new DummyTemplateEngine(null)))
assertFalse("Any other template engine means we're not in scalate:sitegen",
sitegen(new TemplateEngine()))
-
}
@Test
