Author: jonathan
Date: Mon Jan 4 22:31:21 2010
New Revision: 895806
URL: http://svn.apache.org/viewvc?rev=895806&view=rev
Log:
Converting wiki documentation to DocBook.
This initial checkin is incomplete, and does not yet build.
Added:
qpid/trunk/qpid/doc/book/
qpid/trunk/qpid/doc/book/build/
qpid/trunk/qpid/doc/book/src/
qpid/trunk/qpid/doc/book/src/Book.xml
qpid/trunk/qpid/doc/book/src/Book_Info.xml
qpid/trunk/qpid/doc/book/src/Download.xml
qpid/trunk/qpid/doc/book/src/Getting_Started.xml
qpid/trunk/qpid/doc/book/src/Introduction.xml
qpid/trunk/qpid/doc/book/src/schemas.xml
Added: qpid/trunk/qpid/doc/book/src/Book.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Book.xml?rev=895806&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Book.xml (added)
+++ qpid/trunk/qpid/doc/book/src/Book.xml Mon Jan 4 22:31:21 2010
@@ -0,0 +1,49 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+]>
+
+<book xmlns:xi="http://www.w3.org/2001/XInclude";>
+ <xi:include href="Book_Info.xml"/>
+ <xi:include href="Introduction.xml"/>
+ <xi:include href="Getting_Started.xml"/>
+ <xi:include href="AMQP.xml"/>
+ <xi:include href="Brokers.xml"/>
+ <xi:include href="Clients.xml"/>
+ <xi:include href="Interoperability.xml"/>
+<!-- <xi:include href="FAQ.xml"/> -->
+</book>
+
+<!--
+Documentation
+Getting Started
+
+ * Download
+ * Getting Started
+
+AMQP (Advanced Message Queueing Protocol)
+
+ * Toward a Commodity Enterprise Middleware
+ * AMQP (Advanced Message Queueing Protocol)
+
+Qpid AMQP Brokers
+
+ * AMQP Messaging Broker (implemented in C++)
+ * AMQP Messaging Broker (implemented in Java)
+
+Qpid AMQP Clients
+
+ * AMQP Java JMS Messaging Client
+ * AMQP C++ Messaging Client
+ * AMQP .NET Messaging Client
+ * AMQP Python Messaging Client
+ * AMQP Ruby Messaging Client
+
+Interoperability
+
+ * AMQP Compatibility
+ * SASL Interoperability
+
+FAQ
+
+ * Frequently Asked Questions
+-->
Added: qpid/trunk/qpid/doc/book/src/Book_Info.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Book_Info.xml?rev=895806&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Book_Info.xml (added)
+++ qpid/trunk/qpid/doc/book/src/Book_Info.xml Mon Jan 4 22:31:21 2010
@@ -0,0 +1,28 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+]>
+
+<bookinfo id="book-Messaging_Installation_Guide-Messaging_Installation_Guide">
+ <title>Apache Qpid</title>
+ <subtitle>
+ <edition>1</edition>
+ <pubsnumber>0</pubsnumber>
+ <productname>Apache Qpid</productname>
+ <productnumber>6</productnumber>
+ <abstract>
+ <para>This is the user documentation for Apache Qpid. It
describes how to download and install###.
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="Common_Content/images/qpid-logo.png" format="PNG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <copyright>
+ <year>&YEAR;</year>
+ <holder>The Apache Software Foundation</holder>
+ </copyright>
+ <xi:include href="Common_Content/Legal_Notice.xml"
xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include>
+ <xi:include href="Author_Group.xml"
xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include>
+ </bookinfo>
+
Added: qpid/trunk/qpid/doc/book/src/Download.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Download.xml?rev=895806&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Download.xml (added)
+++ qpid/trunk/qpid/doc/book/src/Download.xml Mon Jan 4 22:31:21 2010
@@ -0,0 +1,142 @@
+<!--
+ [ ] <- ###############
+*<ulink>url</ulink>
+*Broker
+-->
+
+<chapter>
+<title>Download Apache Qpid</title>
+
+<section><title>Production Releases</title>
+
+<para>These releases are well tested and appropriate for production use. 0.5
is the latest release of Qpid.</para>
+
+<para>Qpid supports the latest version of AMQP 0-10, and some components also
the AMQP 0-8 and 0-9, earlier versions. The Java Broker and Client provide
protocol negotiation. Other versions can be found at <ulink
url="http://www.apache.org/dist/qpid/";>http://www.apache.org/dist/qpid/</ulink></para>
+
+<para>For details on cross component compatibility among releases, see: <ulink
url="### FIX ME ###">AMQP Release Compatibility for Qpid|AMQP
compatibility</ulink></para>
+
+<para>If you have any questions about these releases, please mail the user
list (<ulink
url="mailto:[email protected]";>[email protected]</ulink>).</para>
+
+</section>
+
+<section><title>0.5 Release</title>
+
+<section><title>Multiple Component Packages</title>
+
+<table><thead><tr><td> Component </td><td> Download </td><td> AMQP 0-10
</td><td> AMQP 0-8/0-9 </td></tr></thead>
+<tbody>
+<tr><td> Full release & keys </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/";>http://www.apache.org/dist/qpid/0.5/</ulink>
</td><td> Y </td><td> Y </td></tr>
+<tr><td> C+\+ broker & client </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-cpp-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-cpp-0.5.tar.gz</ulink>
</td><td> Y </td><td> </td></tr>
+<tr><td> Java broker, client & tools </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-java-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-java-0.5.tar.gz</ulink>
</td><td> client </td><td> Y </td></tr>
+</tbody></table>
+</section>
+
+<section><title>Single Component Package</title>
+
+
+<table>
+<title>Broker</title>
+<thead><tr><td> Language </td><td> Download </td><td> AMQP 0-10 </td><td> AMQP
0-8/0-9 </td></tr></thead>
+<tbody>
+<tr><td> Java </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-java-broker-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-java-broker-0.5.tar.gz</ulink>
</td><td> </td><td> Y </td></tr>
+</tbody>
+</table>
+
+
+<table>
+<title>Client</title>
+<thead><tr><td> Language </td><td> Download </td><td> AMQP 0-10 </td><td> AMQP
0-8/0-9 </td></tr></thead>
+<tbody>
+<tr><td> C# (.NET, WCF, Excel) 0-10 client (C+\+ Broker Compatible) </td><td>
<ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-10-0.5.zip";>http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-10-0.5.zip</ulink>
</td><td> Y </td><td> </td></tr>
+<tr><td> C# (.NET) 0-8 client (Java Broker Compatible) </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-8-0.5.zip";>http://www.apache.org/dist/qpid/0.5/qpid-dotnet-0-8-0.5.zip</ulink>
</td><td> </td><td> Y </td></tr>
+<tr><td> Java </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-java-client-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-java-client-0.5.tar.gz</ulink>
</td><td> Y </td><td> Y </td></tr>
+<tr><td> Python </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz</ulink>
</td><td> Y </td><td> Y </td></tr>
+<tr><td> Ruby </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-ruby-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-ruby-0.5.tar.gz</ulink>
</td><td> Y </td><td> Y </td></tr>
+</tbody>
+</table>
+
+
+<table>
+<title>C+\+ broker management</title>
+<thead><tr><td> Component </td><td> Download </td><td> AMQP 0-10
</td></tr></thead>
+<tbody>
+<tr><td> cmd line (packaged with python) </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-python-0.5.tar.gz</ulink>
</td><td> Y </td></tr>
+<tr><td> QMan JMX bridge, WS-DM </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-management-client-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-management-client-0.5.tar.gz</ulink>
</td><td> Y </td></tr>
+</tbody>
+</table>
+
+
+<table>
+<title>Java broker management</title>
+<thead><tr><td> Component </td><td> Download </td></tr></thead>
+<tbody>
+<tr><td> Eclipse RCP client </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-management-eclipse-plugin-0.5-linux-gtk-x86.tar.gz";>Linux
x86</ulink>
+<ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-management-eclipse-plugin-0.5-linux-gtk-x86_64.tar.gz";>Linux
x86_64</ulink>
+<ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-management-eclipse-plugin-0.5-macosx.zip";>Mac
OS X</ulink>
+<ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-management-eclipse-plugin-0.5-win32-win32-x86.zip";>Windows
x86</ulink>
+</td></tr>
+<tr><td> Command line interface </td><td> <ulink
url="http://www.apache.org/dist/qpid/0.5/qpid-management-tools-qpid-cli-0.5.tar.gz";>http://www.apache.org/dist/qpid/0.5/qpid-management-tools-qpid-cli-0.5.tar.gz</ulink>
</td></tr>
+</tbody>
+</table>
+</section>
+</section>
+
+
+<section><title>QpidComponents.org</title>
+
+<para><ulink url="http://QpidComponents.org";>http://QpidComponents.org</ulink>
provides further components for Apache Qpid, including both persistence and
management tools. These components are open source, but are not developed as
part of the Apache Qpid project due to licensing or other restrictions.</para>
+
+</section>
+
+
+<section><title>Contributed C++ Packages</title>
+
+<section><title>Pre-built Linux Packages</title>
+
+<section><title>Fedora 8, 9, 10</title>
+
+<para>On Fedora, Qpid can be installed using yum. Because Java RPMs are not
yet available in Fedora repos, the Java client is not in these
distributions.</para>
+
+<para>To install the server:</para>
+<programlisting>
+# yum install qpidd
+</programlisting>
+<para>To install C+\+ and Python clients:</para>
+<programlisting>
+# yum install qpidc-devel
+</programlisting>
+<programlisting>
+# yum install amqp python-qpid
+</programlisting>
+<para>To install documentation:</para>
+<programlisting>
+# yum install rhm-docs
+</programlisting>
+<para>To install persistence using an external store module:</para>
+<programlisting>
+# yum install rhm
+</programlisting>
+</section>
+</section>
+
+
+<section><title>Windows Installer</title>
+
+<para>The Windows installer is available from <ulink
url="http://www.apache.org/dist/qpid/0.5-windows/qpidc-0.5.msi";>http://www.apache.org/dist/qpid/0.5-windows/qpidc-0.5.msi</ulink>.
It is built from the 0.5 C+\+ broker and client source distribution listed
above. It has been tested for Windows XP SP2 and above.</para>
+
+<para>The Windows executables require the Visual C+\+ 2008 SP1 run-time
components. If the Visual C+\+ 2008 SP1 runtime is not available, the Qpid
broker will not execute. If you intend to run the broker and Visual C+\+ 2008
is not installed, you must install the Visual C+\+ 2008 SP1 Redistributable.
Please see <ulink
url="http://www.microsoft.com/downloads/details.aspx?familyid=A5C84275-3B97-4AB7-A40D-3802B2AF5FC2&displaylang=en";>http://www.microsoft.com/downloads/details.aspx?familyid=A5C84275-3B97-4AB7-A40D-3802B2AF5FC2&displaylang=en</ulink>
for download and installation instructions.</para>
+
+<para>If you intend to develop Qpid client applications using this kit, you
should install <ulink
url="http://www.boostpro.com/download/boost_1_35_0_setup.exe";>Boost version
1.35</ulink> (please be sure to select VC9 support when installing) in addition
to Visual Studio 2008 SP1.</para>
+
+</section>
+</section>
+
+<section><title>Source Code Repository</title>
+
+<para>The latest version of the code is always available in the <ulink
url="Source Repository">Source Repository</ulink>.
+</para>
+</section>
+
+<!-- ##################### -->
+
+</chapter>
Added: qpid/trunk/qpid/doc/book/src/Getting_Started.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Getting_Started.xml?rev=895806&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Getting_Started.xml (added)
+++ qpid/trunk/qpid/doc/book/src/Getting_Started.xml Mon Jan 4 22:31:21 2010
@@ -0,0 +1,78 @@
+<chapter>
+
+<section>
+<title>Downloading Apache Qpid</title>
+
+</section>
+
+<section>
+<title>Getting Started</title>
+<para>To get started with Apache Qpid, follow the steps below.</para>
+
+<orderedlist>
+<listitem><para>Download the software [Download]</para></listitem>
+<listitem>
+ <para>Start a broker. </para>
+ <itemizedlist>
+ <listitem><para>Instructions for [running a Qpid Java broker (AMQP 0-8,
0-9) | Getting Started Guide]</para></listitem>
+ <listitem><para>Instructions for [running a Qpid C++ broker (AMQP 0-10) |
RASC]</para></listitem>
+ <listitem><para>[Management tools | MgmtC++] (AMQP 0-10, works with the
Qpid C++ broker)</para></listitem>
+ </itemizedlist>
+</listitem>
+<listitem>
+ <para>Run an example program from the downloaded software, or from the
following URLs (these are svn URLs, which you can use to browse the examples or
check them out):</para>
+ <itemizedlist>
+ <listitem><para>C++ (AMQP 0-10):</para>
+ <itemizedlist>
+ <listitem><para>Examples:
[https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/ |
https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/]</para></listitem>
+ <listitem><para>[Running the C++ Examples |
https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/examples/README.txt]</para></listitem>
+ </itemizedlist>
+</listitem>
+<listitem>
+ <para>Java JMS (AMQP 0-10):</para>
+ <itemizedlist>
+ <listitem><para>Examples:
[https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/ |
https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/]</para></listitem>
+ <listitem><para>[Script for Running the Java JMS Examples |
https://svn.apache.org/repos/asf/qpid/trunk/qpid/java/client/example/src/main/java/runSample.sh]</para></listitem>
+ </itemizedlist>
+</listitem>
+<listitem>
+ <para>Python (AMQP 0-10):</para>
+ <itemizedlist>
+ <listitem><para>Examples:
[https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/ |
https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/]</para></listitem>
+ <listitem><para>[Running the Python Examples |
https://svn.apache.org/repos/asf/qpid/trunk/qpid/python/examples/README]</para></listitem>
+ </itemizedlist>
+</listitem>
+<listitem>
+ <para>Ruby (AMQP 0-10):</para>
+ <itemizedlist>
+ <listitem><para>Examples:
[https://svn.apache.org/repos/asf/qpid/trunk/qpid/ruby/examples/ |
https://svn.apache.org/repos/asf/qpid/trunk/qpid/ruby/examples/]</para></listitem>
+ </itemizedlist>
+</listitem>
+<listitem>
+ <para>.NET (AMQP 0-10):</para>
+ <itemizedlist>
+ <listitem><para>Examples:
[http://svn.apache.org/viewvc/qpid/trunk/qpid/dotnet/client-010/examples/ |
http://svn.apache.org/viewvc/qpid/trunk/qpid/dotnet/client-010/examples/]</para></listitem>
+ <listitem><para>[.NET Tutorial |
http://cwiki.apache.org/confluence/display/qpid/.NET+User+Guide]</para></listitem>
+ </itemizedlist>
+</listitem>
+</itemizedlist>
+</listitem>
+<listitem>
+ <para>Read the API Guides and Documentation</para>
+ <itemizedlist>
+ <listitem><para>[C++ Client API (AMQP 0-10) |
http://qpid.apache.org/docs/api/cpp/html/index.html]</para></listitem>
+ <listitem><para>[JNDI Configuration for Java JMS |
http://cwiki.apache.org/confluence/display/qpid/How+to+Use+JNDI]</para></listitem>
+ <listitem><para>[Python Client API (AMQP 0-10) |
http://qpid.apache.org/docs/api/python/html/index.html]</para></listitem>
+ <listitem><para>[Documentation]</para></listitem>
+ </itemizedlist>
+</listitem>
+<listitem>
+ <para>Get your Questions Answered</para>
+ <itemizedlist>
+ <listitem><para>Read the [FAQ|FAQ]</para></listitem>
+ <listitem><para>Ask a question on the user list
mailto:[email protected]</para></listitem>
+ </itemizedlist>
+</listitem>
+</orderedlist>
+</section>
+</chapter>
\ No newline at end of file
Added: qpid/trunk/qpid/doc/book/src/Introduction.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Introduction.xml?rev=895806&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Introduction.xml (added)
+++ qpid/trunk/qpid/doc/book/src/Introduction.xml Mon Jan 4 22:31:21 2010
@@ -0,0 +1,83 @@
+<chapter>
+<title>Apache Qpid: Open Source AMQP Messaging</title>
+
+<para>Enterprise Messaging systems let programs communicate by exchanging
messages, much as people communicate by exchanging email. Unlike email,
enterprise messaging systems provide guaranteed delivery, speed, security, and
freedom from spam. Until recently, there was no open standard for Enterprise
Messaging systems, so programmers either wrote their own, or used expensive
proprietary systems.</para>
+
+<para>AMQP Advanced Message Queuing Protocol is the first open standard for
Enterprise Messaging. It is designed to support messaging for just about any
distributed or business application. Routing can be configured flexibly, easily
supporting common messaging paradigms like point-to-point, fanout,
publish-subscribe, and request-response.</para>
+
+<para>Apache Qpid implements the latest AMQP specification, providing
transaction management, queuing, distribution, security, management,
clustering, federation and heterogeneous multi-platform support and a lot more.
And Apache Qpid is extremely fast. Apache Qpid <ulink url="### FIX ME ###">aims
to be 100% AMQP Compliant</ulink>.</para>
+
+<section>
+<title>AMQP Messaging Brokers</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 <ulink url="### FIX ME ###">Download</ulink> to see which messaging
clients work with each broker.</para>
+
+</section>
+
+<section>
+<title>AMQP Client APIs: C++, Java, JMS, Ruby, Python, and C#</title>
+
+<para>Qpid provides AMQP Client APIs for the following languages:</para>
+
+<itemizedlist>
+ <listitem><para>C++</para></listitem>
+ <listitem><para>Java, fully conformant with JMS 1.1</para></listitem>
+ <listitem><para>C# .NET, 0-10 using WCF</para></listitem>
+ <listitem><para>Ruby</para></listitem>
+ <listitem><para>Python</para></listitem>
+</itemizedlist>
+
+</section>
+
+<section>
+<title>Operating Systems and Platforms:</title>
+
+<para>The Qpid C++ broker runs on the following operating systems:</para>
+
+<itemizedlist>
+ <listitem><para>Linux systems</para></listitem>
+ <listitem><para>Windows</para></listitem>
+ <listitem><para>Solaris (coming soon)</para></listitem>
+</itemizedlist>
+
+<para>The Qpid Java broker runs on:</para>
+
+<itemizedlist>
+ <listitem><para>Any Java platform</para></listitem>
+</itemizedlist>
+
+<para>Qpid clients can be run on the following operating systems and
platforms:</para>
+
+<itemizedlist>
+ <listitem><para>Java:</para>
+ <itemizedlist>
+ <listitem><para>any platform, production proven on Windows, Linux,
Solaris</para></listitem>
+ </itemizedlist>
+ </listitem>
+
+
+ <listitem><para>C++:</para>
+ <itemizedlist>
+ <listitem><para>Linux</para></listitem>
+ <listitem><para>Windows</para></listitem>
+ <listitem><para>Solaris (coming soon)</para></listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem><para>C#</para>
+ <itemizedlist>
+ <listitem><para>.NET</para></listitem>
+ </itemizedlist>
+ </listitem>
+
+</itemizedlist>
+
+</section>
+</chapter>
\ No newline at end of file
Added: qpid/trunk/qpid/doc/book/src/schemas.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/schemas.xml?rev=895806&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/schemas.xml (added)
+++ qpid/trunk/qpid/doc/book/src/schemas.xml Mon Jan 4 22:31:21 2010
@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0";>
+ <uri resource="AMQP.xml" typeId="DocBook"/>
+ <uri resource="qpid-book.xml" typeId="DocBook"/>
+</locatingRules>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:[email protected]
