1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
The documentation in this directory is written in DocBook 4.5. The
original content was taken from the Apache Qpid Wiki.
1. Building the Documentation
You need the following to build the documentation:
- Apache FOP, version 0.95 or higher
- Docbook 4.5
- Docbook XSL stylesheets - Tested with xsl-stylesheets (1.75.2 & 1.65.1-2)
- xsltproc
- xmllint
On many Linux machines, these can usually be installed from standard
repos. For instance, on Fedora they can be installed as follows:
$ sudo yum install fop docbook-dtds docbook-style-xsl libxslt libxml2
After installing, use make to build the documentation:
$ make
The Makefile supports the following targets:
all Builds the cpp, java, and programming targets.
cpp Build html+pdf for the C++ broker.
java Build html+pdf for the Java broker.
programming Build html+pdf for Programming In Apache Qpid.
clean Delete the build directory
You will see quite a few error messages. Many of these are due to
unresolved links, and these should go away. Many are due to the
verbosity of Apache FOP, which generates many warnings.
2. Editing Tools
For Emacs, I like nxml-mode, especially if you learn how to use tag
completion, outlining, etc. This is described in some detail in
http://www.dpawson.co.uk/relaxng/nxml/info.html.
For vi, the macros described in this Linux Journal article may be
helpful: http://www.linuxjournal.com/article/7737.
Commercial XML editors provide good support for DocBook. On Windows, I
like Stylus Studio (http://www.stylusstudio.com/). On Linux, I like
Oxygen (http://www.oxygenxml.com/).
Here's a page on authoring tools for DocBook:
http://wiki.docbook.org/topic/DocBookAuthoringTools
3. File Structure
The source files are in qpid/doc/book/src.
The following XInclude tree shows the organization of files in the
document.
Book.xml
Book-Info.xml
Introduction.xml
AMQP.xml
Getting-Started.xml
Download.xml
AMQP-Messaging-Broker-CPP.xml
Running-CPP-Broker.xml
Cheat-Sheet-for-configuring-Queue-Options.xml
Cheat-Sheet-for-configuring-Exchange-Options.xml
Using-Broker-Federation.xml
SSL.xml
LVQ.xml
queue-state-replication.xml
Starting-a-cluster.xml
ACL.xml
Managing-CPP-Broker.xml
QMan-Qpid-Management-bridge.xml
Qpid-Management-Framework.xml
Management-Design-notes.xml
QMF-Python-Console-Tutorial.xml
AMQP-Messaging-Broker-Java.xml
Java-Broker-Feature-Guide.xml
Qpid-Java-FAQ.xml
Java-Environment-Variables.xml
Qpid-Troubleshooting-Guide.xml
Add-New-Users.xml
Configure-ACLs.xml
Configure-Java-Qpid-to-use-a-SSL-connection.xml
Configure-Log4j-CompositeRolling-Appender.xml
Configure-the-Broker-via-config.xml.xml
Configure-the-Virtual-Hosts-via-virtualhosts.xml.xml
Debug-using-log4j.xml
How-to-Tune-M3-Java-Broker-Performance.xml
Qpid-Java-Build-How-To.xml
Use-Priority-Queues.xml
Qpid-JMX-Management-Console.xml
Configuring-Management-Users.xml
Configuring-Qpid-JMX-Management-Console.xml
Management-Console-Security.xml
Qpid-JMX-Management-Console-FAQ.xml
Qpid-JMX-Management-Console-User-Guide.xml
Qpid-Management-Features.xml
MessageStore-Tool.xml
Qpid-Java-Broker-Management-CLI.xml
AMQP-Java-JMS-Messaging-Client.xml
System-Properties.xml
Connection-URL-Format.xml
Binding-URL-Format.xml
AMQP-C++-Messaging-Client.xml
AMQP-.NET-Messaging-Client.xml
NET-User-Guide.xml
Excel-AddIn.xml
WCF.xml
AMQP-Python-Messaging-Client.xml
PythonBrokerTest.xml
AMQP-Ruby-Messaging-Client.xml
AMQP-Compatibility.xml
Qpid-Interoperability-Documentation.xml
|
