[jboss-cvs] JBoss Messaging SVN: r7015 - trunk/docs/user-manual/en.

[jboss-cvs-commits at lists.jboss.org]

Author: timfox
Date: 2009-05-26 07:21:37 -0400 (Tue, 26 May 2009)
New Revision: 7015

Added:
   trunk/docs/user-manual/en/client-classpath.xml
Modified:
   trunk/docs/user-manual/en/jar-dependencies.xml
   trunk/docs/user-manual/en/master.xml
Log:
added client classpath chapter

Added: trunk/docs/user-manual/en/client-classpath.xml
===================================================================
--- trunk/docs/user-manual/en/client-classpath.xml	                        (rev 0)
+++ trunk/docs/user-manual/en/client-classpath.xml	2009-05-26 11:21:37 UTC (rev 7015)
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="client-classpath">
+    <title>The Client Classpath</title>
+    <para>In this chapter we explain what jars you need on the Java classpath of a JBoss Messaging
+        client application. This depends on whether you're using just core, or JMS amongst other
+        things. We explain what jars are needed in each case.</para>
+    <para>All the jars mentioned here can be found in the <literal>lib</literal> directory of the
+        JBoss Messaging distribution. Be sure you only use the jars from the correct version of the
+        release, you <emphasis>must not</emphasis> mix and match versions of jars from different
+        JBoss Messaging versions.</para>
+    <section>
+        <title>Pure Core Client</title>
+        <para>If you're using just a pure JBoss Messaging core client (i.e. no JMS) then you need
+                <literal>jbm-core-client.jar</literal> on your client classpath. If you're using a
+            Netty transport then you will netty <literal>netty.jar</literal> too.</para>
+    </section>
+    <section>
+        <title>JMS Client</title>
+        <para>If you're using JMS on the client side, then you will need <literal
+                >jbm-core-client.jar</literal>, <literal>jbm-jms-client.jar</literal>.</para>
+        <para>TODO - clebert please complete.</para>
+        <para>What about javaee.jar, what about jndi client stuff etc etc???</para>
+    </section>
+    <section/>
+</chapter>

Modified: trunk/docs/user-manual/en/jar-dependencies.xml
===================================================================
--- trunk/docs/user-manual/en/jar-dependencies.xml	2009-05-26 11:02:22 UTC (rev 7014)
+++ trunk/docs/user-manual/en/jar-dependencies.xml	2009-05-26 11:21:37 UTC (rev 7015)
@@ -168,26 +168,4 @@
             </tgroup>
         </table>
     </section>
-    <section>
-        <title>Client Classpath</title>
-        <para>In this section we explain what jars you need on the client classpath, this depends on
-            how you're using JBoss Messaging</para>
-        <para>!!!!!!!!!!! TODO - clebert please complete this</para>
-        <itemizedlist>
-            <listitem>
-                <para>Core. If you're just using the JBoss Messaging core client API, you just need
-                    xyz</para>
-            </listitem>
-            <listitem>
-                <para>JMS. If you're using JMS, you need XYZ. If you're using JNDI with JMS you need
-                    XYZ</para>
-            </listitem>
-            <listitem>
-                <para>If you're using netty you need XYZ</para>
-            </listitem>
-            <listitem>
-                <para>etc</para>
-            </listitem>
-        </itemizedlist>
-    </section>
 </chapter>

Modified: trunk/docs/user-manual/en/master.xml
===================================================================
--- trunk/docs/user-manual/en/master.xml	2009-05-26 11:02:22 UTC (rev 7014)
+++ trunk/docs/user-manual/en/master.xml	2009-05-26 11:21:37 UTC (rev 7015)
@@ -4,6 +4,7 @@
         <!ENTITY appserver-integration   SYSTEM "appserver-integration.xml">
         <!ENTITY architecture            SYSTEM "architecture.xml">
         <!ENTITY client-reconnection     SYSTEM "client-reconnection.xml">
+        <!ENTITY client-classpath        SYSTEM "client-classpath.xml">
         <!ENTITY clusters                SYSTEM "clusters.xml">
         <!ENTITY configuration-index     SYSTEM "configuration-index.xml">
         <!ENTITY configuring-transports  SYSTEM "configuring-transports.xml">
@@ -61,6 +62,7 @@
    &using-server;
    &using-jms;
    &using-core;
+   &client-classpath;
    &jms-core-mapping;
    &examples;
    &embedding-jbm;