summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Godfrey <rgodfrey@apache.org>2012-01-04 01:50:00 +0000
committerRobert Godfrey <rgodfrey@apache.org>2012-01-04 01:50:00 +0000
commit4aaa28b671fdb62ccf8f267102f906fb8a981b80 (patch)
tree0fce91b2e0ee7751c6ead9acb601e4a674bb1ceb
parent632098a71beded1a01ce7e1677ec87c3dd79f4ef (diff)
downloadqpid-python-4aaa28b671fdb62ccf8f267102f906fb8a981b80.tar.gz
QPID-3722 : Initial improvements to the HTML presentation of the docbook
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1227022 13f79535-47bb-0310-9956-ffa450edef68
-rwxr-xr-xqpid/doc/book/build-book.sh6
-rw-r--r--qpid/doc/book/src/AMQP-Messaging-Broker-Java-Book.xml50
-rw-r--r--qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml4
-rw-r--r--qpid/doc/book/src/Broker-Configuration-Guide.xml2
-rw-r--r--qpid/doc/book/src/Configure-ACLs.xml2
-rw-r--r--qpid/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml2
-rw-r--r--qpid/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml2
-rw-r--r--qpid/doc/book/src/Configure-the-Broker-via-config.xml.xml2
-rw-r--r--qpid/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml2
-rw-r--r--qpid/doc/book/src/Debug-using-log4j.xml2
-rw-r--r--qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml2
-rw-r--r--qpid/doc/book/src/Java-Environment-Variables.xml2
-rw-r--r--qpid/doc/book/src/Qpid-Java-Broker-Management-CLI.xml2
-rw-r--r--qpid/doc/book/src/Qpid-Java-Build-How-To.xml2
-rw-r--r--qpid/doc/book/src/Qpid-Java-FAQ.xml2
-rw-r--r--qpid/doc/book/src/Qpid-Troubleshooting-Guide.xml2
-rw-r--r--qpid/doc/book/src/Use-Priority-Queues.xml2
-rw-r--r--qpid/doc/book/src/css/style.css129
18 files changed, 199 insertions, 18 deletions
diff --git a/qpid/doc/book/build-book.sh b/qpid/doc/book/build-book.sh
index 46192907e6..59b9a3fd50 100755
--- a/qpid/doc/book/build-book.sh
+++ b/qpid/doc/book/build-book.sh
@@ -34,6 +34,8 @@
DOCBOOK_XSL=/usr/share/sgml/docbook/xsl-stylesheets
# Ubuntu:
# DOCBOOK_XSL=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh
+# Ubuntu 10.4 installed it here:
+# DOCBOOK_XSL=/usr/share/xml/docbook/stylesheet/docbook-xsl-ns
rm -rf build/$1
mkdir -p build/$1
@@ -42,6 +44,8 @@ mkdir -p build/$1/html
mkdir -p build/$1/pdf
cp -r src/images build/$1/html-single
cp -r src/images build/$1/html
+cp -r src/css build/$1/html-single
+cp -r src/css build/$1/html
# Create single-page .html
xsltproc --xinclude --stringparam section.autolabel 1 --stringparam callout.graphics 0 --stringparam callout.unicode 0 --stringparam section.label.includes.component.label 1 ${DOCBOOK_XSL}/html/docbook.xsl src/$1.xml >build/$1/html-single/$1.html
@@ -49,7 +53,7 @@ xsltproc --xinclude --stringparam section.autolabel 1 --stringparam callout.g
# Create chunked .html
INFILE=$(readlink -f src/$1.xml)
pushd build/$1/html
-xsltproc --xinclude --stringparam chunk.section.depth 1 --stringparam section.autolabel 1 --stringparam callout.graphics 0 --stringparam callout.unicode 0 --stringparam section.label.includes.component.label 1 ${DOCBOOK_XSL}/html/chunk.xsl $INFILE
+xsltproc --xinclude --stringparam chunk.section.depth 1 --stringparam section.autolabel 1 --stringparam callout.graphics 0 --stringparam callout.unicode 0 --stringparam section.label.includes.component.label 1 --stringparam use.id.as.filename 1 --stringparam html.stylesheet css/style.css --stringparam section.autolabel.max.depth 3 --stringparam toc.section.depth 2 ${DOCBOOK_XSL}/html/chunk.xsl $INFILE
popd
# Create the .fo
diff --git a/qpid/doc/book/src/AMQP-Messaging-Broker-Java-Book.xml b/qpid/doc/book/src/AMQP-Messaging-Broker-Java-Book.xml
index 8d2e2218ff..0bb40052cd 100644
--- a/qpid/doc/book/src/AMQP-Messaging-Broker-Java-Book.xml
+++ b/qpid/doc/book/src/AMQP-Messaging-Broker-Java-Book.xml
@@ -21,5 +21,53 @@
-->
<book>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AMQP-Messaging-Broker-Java.xml"/>
+ <title>AMQP Messaging Broker (Implemented in Java)</title>
+ <preface>
+ <title>Introduction</title>
+ <para>Qpid provides two AMQP messaging brokers:</para>
+
+ <itemizedlist>
+ <listitem><para>Implemented in C++ - high performance, low latency, and RDMA support.</para></listitem>
+ <listitem><para>Implemented in Java - Fully JMS compliant, runs on any Java platform.</para></listitem>
+ </itemizedlist>
+
+ <para>Both AMQP messaging brokers support clients in multiple languages, as long as the messaging client and the messaging broker use the same version of AMQP. See <link linkend="AMQP-Compatibility"/> to see which messaging clients work with each broker.</para>
+
+ <para>This manual contains information specific to the broker that is implemented in Java.</para>
+ </preface>
+
+<chapter id="Java-General-User-Guides">
+ <title>General User Guides</title>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Feature-Guide.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid-Java-FAQ.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Environment-Variables.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid-Troubleshooting-Guide.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Broker-Configuration-Guide.xml"/>
+</chapter>
+
+<chapter id="Qpid-Java-Broker-HowTos">
+<title>How Tos</title>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Add-New-Users.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configure-ACLs.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configure-Java-Qpid-to-use-a-SSL-connection.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configure-Log4j-CompositeRolling-Appender.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configure-the-Broker-via-config.xml.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Debug-using-log4j.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="How-to-Tune-M3-Java-Broker-Performance.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid-Java-Build-How-To.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Use-Priority-Queues.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="How-to-Use-SlowConsumerDisconnect.xml"/>
+</chapter>
+
+
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid-JMX-Management-Console.xml"/>
+
+<chapter id="QpidJavaBroker-ManagementTools">
+<title>Management Tools</title>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="MessageStore-Tool.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Qpid-Java-Broker-Management-CLI.xml"/>
+</chapter>
</book>
diff --git a/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml b/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml
index d2a3427674..6cd7ce915e 100644
--- a/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml
+++ b/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml
@@ -20,7 +20,7 @@
-->
-<part>
+<part id="Java-Broker">
<title>AMQP Messaging Broker (Implemented in Java)</title>
<partintro>
<para>Qpid provides two AMQP messaging brokers:</para>
@@ -35,7 +35,7 @@
<para>This section contains information specific to the broker that is implemented in Java.</para>
</partintro>
-<chapter>
+<chapter id="Java-General-User-Guides">
<title>General User Guides</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Feature-Guide.xml"/>
diff --git a/qpid/doc/book/src/Broker-Configuration-Guide.xml b/qpid/doc/book/src/Broker-Configuration-Guide.xml
index c52e1fbfd4..63d2748eee 100644
--- a/qpid/doc/book/src/Broker-Configuration-Guide.xml
+++ b/qpid/doc/book/src/Broker-Configuration-Guide.xml
@@ -20,7 +20,7 @@
-->
-<section>
+<section id="Java-Broker-Configuration-Guide">
<title>Broker Configuration Guide </title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
diff --git a/qpid/doc/book/src/Configure-ACLs.xml b/qpid/doc/book/src/Configure-ACLs.xml
index 32764217f4..e82f2a86d0 100644
--- a/qpid/doc/book/src/Configure-ACLs.xml
+++ b/qpid/doc/book/src/Configure-ACLs.xml
@@ -21,7 +21,7 @@
-->
-<section>
+<section id="Configuring-ACLS">
<title>
Configuring ACLs
</title>
diff --git a/qpid/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml b/qpid/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml
index 1ffd4b4050..838b899337 100644
--- a/qpid/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml
+++ b/qpid/doc/book/src/Configure-Java-Qpid-to-use-a-SSL-connection.xml
@@ -21,7 +21,7 @@
-->
-<section><title>
+<section id="Qpid-Java-SSL"><title>
Configure Java Qpid to use a SSL connection.
</title>
diff --git a/qpid/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml b/qpid/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml
index 2c21f9e76d..f52bc55399 100644
--- a/qpid/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml
+++ b/qpid/doc/book/src/Configure-Log4j-CompositeRolling-Appender.xml
@@ -21,7 +21,7 @@
-->
-<section><title>
+<section id="Qpid-Java-Log4j"><title>
Configure Log4j CompositeRolling Appender
</title>
<section role="h2" id="ConfigureLog4jCompositeRollingAppender-HowtoconfiguretheCompositeRollinglog4jAppender"><title>
diff --git a/qpid/doc/book/src/Configure-the-Broker-via-config.xml.xml b/qpid/doc/book/src/Configure-the-Broker-via-config.xml.xml
index b91e0796b8..6a7729acd8 100644
--- a/qpid/doc/book/src/Configure-the-Broker-via-config.xml.xml
+++ b/qpid/doc/book/src/Configure-the-Broker-via-config.xml.xml
@@ -21,7 +21,7 @@
-->
-<section>
+<section id="Qpid-Java-Broker-Config-File">
<title>
Configure the Broker via config.xml
</title>
diff --git a/qpid/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml b/qpid/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml
index 690175d57e..804970b923 100644
--- a/qpid/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml
+++ b/qpid/doc/book/src/Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml
@@ -21,7 +21,7 @@
-->
-<section><title>
+<section id="Qpid-Java-Broker-Virtualhosts-Config"><title>
Configure the Virtual Hosts via virtualhosts.xml
</title><section role="h2" id="ConfiguretheVirtualHostsviavirtualhosts.xml-virtualhosts.xmlOverview"><title>
virtualhosts.xml Overview
diff --git a/qpid/doc/book/src/Debug-using-log4j.xml b/qpid/doc/book/src/Debug-using-log4j.xml
index c4ec107cd0..615fd9e560 100644
--- a/qpid/doc/book/src/Debug-using-log4j.xml
+++ b/qpid/doc/book/src/Debug-using-log4j.xml
@@ -21,7 +21,7 @@
-->
-<section><title>
+<section id="Java-Broker-Debug-Logging"><title>
Debug using log4j
</title>
diff --git a/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml b/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml
index 5f4c627430..4e0ce0f7e0 100644
--- a/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml
+++ b/qpid/doc/book/src/How-to-Use-SlowConsumerDisconnect.xml
@@ -21,7 +21,7 @@
under the License.
-->
-<section>
+<section id="Java-Broker-Slow-Consumer-Disconnect">
<title>Slow Consumer Disconnect - User Guide</title>
<section>
diff --git a/qpid/doc/book/src/Java-Environment-Variables.xml b/qpid/doc/book/src/Java-Environment-Variables.xml
index e4da38a260..12703190f2 100644
--- a/qpid/doc/book/src/Java-Environment-Variables.xml
+++ b/qpid/doc/book/src/Java-Environment-Variables.xml
@@ -20,7 +20,7 @@
-->
-<section>
+<section id="Java-Environment-Variables">
<title>
Java Environment Variables
</title>
diff --git a/qpid/doc/book/src/Qpid-Java-Broker-Management-CLI.xml b/qpid/doc/book/src/Qpid-Java-Broker-Management-CLI.xml
index 3042e53a3f..84c4b7b7a4 100644
--- a/qpid/doc/book/src/Qpid-Java-Broker-Management-CLI.xml
+++ b/qpid/doc/book/src/Qpid-Java-Broker-Management-CLI.xml
@@ -20,7 +20,7 @@
-->
-<section><title>
+<section id="Qpid-Java-Broker-Management-CLI"><title>
Qpid Java Broker Management CLI
</title>
<section role="h2" id="QpidJavaBrokerManagementCLI-HowtobuildApacheQpidCLI"><title>
diff --git a/qpid/doc/book/src/Qpid-Java-Build-How-To.xml b/qpid/doc/book/src/Qpid-Java-Build-How-To.xml
index f38109a3fb..9f3625760a 100644
--- a/qpid/doc/book/src/Qpid-Java-Build-How-To.xml
+++ b/qpid/doc/book/src/Qpid-Java-Build-How-To.xml
@@ -20,7 +20,7 @@
-->
-<section><title>
+<section id="Qpid-Java-Build-HowTo"><title>
Qpid Java Build How To
</title>
diff --git a/qpid/doc/book/src/Qpid-Java-FAQ.xml b/qpid/doc/book/src/Qpid-Java-FAQ.xml
index 2144d3a533..845c343350 100644
--- a/qpid/doc/book/src/Qpid-Java-FAQ.xml
+++ b/qpid/doc/book/src/Qpid-Java-FAQ.xml
@@ -20,7 +20,7 @@
-->
-<section><title>
+<section id="Qpid-Java-FAQ"><title>
Qpid Java FAQ
</title>
diff --git a/qpid/doc/book/src/Qpid-Troubleshooting-Guide.xml b/qpid/doc/book/src/Qpid-Troubleshooting-Guide.xml
index cc642f2cdb..0920f18798 100644
--- a/qpid/doc/book/src/Qpid-Troubleshooting-Guide.xml
+++ b/qpid/doc/book/src/Qpid-Troubleshooting-Guide.xml
@@ -20,7 +20,7 @@
-->
-<section>
+<section id="Qpid-Troubleshooting-Guide">
<title>
Qpid Troubleshooting Guide
diff --git a/qpid/doc/book/src/Use-Priority-Queues.xml b/qpid/doc/book/src/Use-Priority-Queues.xml
index eeac3de06d..466d958d43 100644
--- a/qpid/doc/book/src/Use-Priority-Queues.xml
+++ b/qpid/doc/book/src/Use-Priority-Queues.xml
@@ -20,7 +20,7 @@
-->
-<section><title>
+<section id="Priority-Queues"><title>
Use Priority Queues
</title>
diff --git a/qpid/doc/book/src/css/style.css b/qpid/doc/book/src/css/style.css
new file mode 100644
index 0000000000..2a1bee8623
--- /dev/null
+++ b/qpid/doc/book/src/css/style.css
@@ -0,0 +1,129 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ *
+ */
+ul {
+ list-style-type:square;
+}
+
+th {
+ font-weight: bold;
+}
+
+.navfooter td {
+ font-size:10pt;
+}
+
+.navheader td {
+ font-size:10pt;
+}
+
+body {
+ width:950px;
+ margin-left:100px;
+ margin-top:40px;
+
+ background:#FFFFFF;
+ font-family:"Verdana", sans-serif;
+ font-size:10pt;
+}
+
+body a {
+ color:#000000;
+}
+
+
+div.book {
+ margin-left:10pt;
+ margin-right:10pt;
+}
+
+div.preface {
+ margin-left:10pt;
+ margin-right:10pt;
+}
+
+div.chapter {
+ margin-left:10pt;
+ margin-right:10pt;
+}
+
+div.section {
+ margin-left:10pt;
+ margin-right:10pt;
+}
+
+div.titlepage {
+ margin-left:-10pt;
+ margin-right:-10pt;
+}
+
+.calloutlist td {
+ font-size:10pt;
+}
+
+.table-contents table {
+ border-spacing: 0px;
+}
+
+.table-contents td {
+ font-size:10pt;
+ padding-left:6px;
+ padding-right:6px;
+}
+
+.chapter h2.title {
+ font-size:20pt;
+ color:#0c3b82;
+}
+
+.chapter .section h2.title {
+ font-size:18pt;
+ color:#0c3b82;
+}
+
+.section h2.title {
+ font-size:16pt;
+ color:#0c3b82;
+}
+
+.section h3.title {
+ font-size:14pt;
+ color:#0c3b82;
+}
+
+.section h4.title {
+ font-size:12pt;
+ color:#0c3b82;
+}
+
+.section h5.title {
+ font-size:12pt;
+ color:#0c3b82;
+}
+
+.section h6.title {
+ font-size:12pt;
+ color:#0c3b82;
+}
+
+.toc a {
+ font-size:9pt;
+}
+