[hornetq-commits] JBoss hornetq SVN: r7833 - in trunk/docs/quickstart-guide: en and 1 other directories.

Author: jmesnil Date: 2009-08-20 12:35:13 -0400 (Thu, 20 Aug 2009) New Revision: 7833 Added: trunk/docs/quickstart-guide/en/images/hornetQ_logo_600px.png Modified: trunk/docs/quickstart-guide/build.xml trunk/docs/quickstart-guide/en/about.xml trunk/docs/quickstart-guide/en/download.xml trunk/docs/quickstart-guide/en/examples.xml trunk/docs/quickstart-guide/en/installation.xml trunk/docs/quickstart-guide/en/introduction.xml trunk/docs/quickstart-guide/en/master.xml trunk/docs/quickstart-guide/en/running.xml Log: updated user manual for HornetQ Modified: trunk/docs/quickstart-guide/build.xml =================================================================== --- trunk/docs/quickstart-guide/build.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/build.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,7 +1,7 @@ -<project name="hornetq.quickstart.documentation" default="all" basedir="."> +<project name="HornetQ QuickStart Guide" default="all" basedir="."> <property name="build.dir" value="build"/> - <property name="pdf.name" value="JBossMessaging_QuickStartGuide.pdf"/> + <property name="pdf.name" value="HornetQ_QuickStartGuide.pdf"/> <import file="${basedir}/../../lib/docbook-support/support.xml"/> <target name="all" depends="clean"> Modified: trunk/docs/quickstart-guide/en/about.xml =================================================================== --- trunk/docs/quickstart-guide/en/about.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/en/about.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,4 +1,23 @@ <?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ Copyright © 2009 Red Hat, Inc. and others. + ~ + ~ The text of and illustrations in this document are licensed by Red Hat under + ~ a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). + ~ + ~ An explanation of CC-BY-SA is available at + ~ + ~ http://creativecommons.org/licenses/by-sa/3.0/. + ~ + ~ In accordance with CC-BY-SA, if you distribute this document or an adaptation + ~ of it, you must provide the URL for the original version. + ~ + ~ Red Hat, as the licensor of this document, waives the right to enforce, + ~ and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + ~ permitted by applicable law. +--> + <chapter id="about"> <title>About HornetQ</title> <para>The goal of HornetQ is simple and uncompromising: to bring unrivaled levels of @@ -22,8 +41,8 @@ and others you won't find anywhere else.</para> </listitem> <listitem> - <para>Elegant POJO based design with minimal third party dependencies. Run JBoss - Messaging stand-alone, run it in integrated in your favourite Java EE Application + <para>Elegant POJO based design with minimal third party dependencies. Run HornetQ + stand-alone, run it in integrated in your favourite Java EE Application Server or IoC container, or run it embedded inside your own product.</para> </listitem> <listitem> Modified: trunk/docs/quickstart-guide/en/download.xml =================================================================== --- trunk/docs/quickstart-guide/en/download.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/en/download.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,26 +1,44 @@ <?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ Copyright © 2009 Red Hat, Inc. and others. + ~ + ~ The text of and illustrations in this document are licensed by Red Hat under + ~ a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). + ~ + ~ An explanation of CC-BY-SA is available at + ~ + ~ http://creativecommons.org/licenses/by-sa/3.0/. + ~ + ~ In accordance with CC-BY-SA, if you distribute this document or an adaptation + ~ of it, you must provide the URL for the original version. + ~ + ~ Red Hat, as the licensor of this document, waives the right to enforce, + ~ and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + ~ permitted by applicable law. +--> + <chapter id="download"> <title>Download</title> <para>The official HornetQ project page is <ulink - url="http://www.jboss.org/jbossmessaging/">http://www.jboss.... + url="http://hornetq.org/">http://hornetq.org/</ulink>.... <section id="download.software"> <title>Software Download</title> - <para>The download location is the JBoss Labs Messaging Project download - zone: <ulink - url="http://www.jboss.org/jbossmessaging/downloads/">http://... + <para>The software can be download from the Download page:<ulink + url="http://hornetq.org/downloads.html/">http://hornetq.org/... </section> <section id="download.svn"> <title>Project Information</title> <para>If you have any user questions please use our <ulink - url="http://www.jboss.org/index.html?module=bb&amp;op=viewforum&... + url="http://n2.nabble.com/hornetq-users-f3404100.html">user forum</ulink></para> <para>If you have development related questions, please use our <ulink - url="http://www.jboss.org/index.html?module=bb&amp;op=viewforum&... + url="http://n2.nabble.com/hornetq-dev-f3404069.html">develop... forum</ulink></para> - <para>Pop in and chat to us in our <ulink url="irc://irc.freenode.net:6667/jbossmessaging">IRC channel</ulink></para> - <para>HornetQ Subversion TRUNK is <ulink url="http://anonsvn.jboss.org/repos/messaging/trunk">here<... - <para>All our release tags are <ulink url="http://anonsvn.jboss.org/repos/messaging/tags">here<... + <para>Pop in and chat to us in our <ulink url="irc://irc.freenode.net:6667/hornetq">IRC channel</ulink></para> + <para>HornetQ Subversion trunk is <ulink url="http://anonsvn.jboss.org/repos/hornetq/trunk">http://an... + <para>All release tags are available from <ulink url="http://anonsvn.jboss.org/repos/hornetq/tags">http://ano... </section> </chapter> \ No newline at end of file Modified: trunk/docs/quickstart-guide/en/examples.xml =================================================================== --- trunk/docs/quickstart-guide/en/examples.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/en/examples.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,4 +1,23 @@ <?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ Copyright © 2009 Red Hat, Inc. and others. + ~ + ~ The text of and illustrations in this document are licensed by Red Hat under + ~ a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). + ~ + ~ An explanation of CC-BY-SA is available at + ~ + ~ http://creativecommons.org/licenses/by-sa/3.0/. + ~ + ~ In accordance with CC-BY-SA, if you distribute this document or an adaptation + ~ of it, you must provide the URL for the original version. + ~ + ~ Red Hat, as the licensor of this document, waives the right to enforce, + ~ and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + ~ permitted by applicable law. +--> + <chapter id="examples"> <title>Running the Examples</title> <para>In the directory <literal>examples</literal> there are 2 sets of examples, these are </para> @@ -48,8 +67,8 @@ init: compile: - [echo] src.example.dir=/home/andy/projects/HornetQTrunk/examples/jms/queue/src - [javac] Compiling 5 source files to /home/andy/projects/HornetQTrunk/examples/jms/queue + [echo] src.example.dir=/home/andy/projects/hornetq/trunk/examples/jms/queue/src + [javac] Compiling 5 source files to /home/andy/projects/hornetq/trunk/examples/jms/queue /build/classes runExample: @@ -58,7 +77,7 @@ logServerOutput true [java] 10:41:04,149 INFO @main [JMSExample] and vm args: -Xms512M,-Xmx512M,-XX:+U seParallelGC,-XX:+AggressiveOpts,-XX:+UseFastAccessorMethods,-Djava.util.logging.config. -file=/home/andy/projects/HornetQTrunk/examples/jms/common/../../../src/config/stand-alone/no +file=/home/andy/projects/hornetq/trunk/examples/jms/common/../../../src/config/stand-alone/no n-clustered/logging.properties [java] org.hornetq.jms.example.SpawnedJMSServer out:10:41:08,437 INFO @main [Journal StorageManager] AIO journal selected @@ -81,7 +100,7 @@ [java] org.hornetq.jms.example.SpawnedJMSServer out:10:41:10,991 WARN @main [JMSServ erManagerImpl] Binding for java:/XAConnectionFactory already exists [java] org.hornetq.jms.example.SpawnedJMSServer out:10:41:11,241 INFO @main [Messagi -ngServerImpl] HornetQ Server version 2.0.0.BETA1-SNAPSHOT (Stilton, 101) started +ngServerImpl] HornetQ Server version 2.0.0.BETA5 (buzz-buzz, 107) started [java] org.hornetq.jms.example.SpawnedJMSServer out:10:41:11,241 INFO @main [HornetQBoot strapServer] HornetQ server started [java] org.hornetq.jms.example.SpawnedJMSServer out:STARTED:: @@ -97,7 +116,7 @@ BUILD SUCCESSFUL Total time: 13 seconds </programlisting> - <para>Congratulations! You have succesfully run your first HornetQ example. Try some + <para>Congratulations! You have successfully run your first HornetQ example. Try some of the others.</para> </section> <section id="examples.messaging"> @@ -136,11 +155,11 @@ compile: jar: - [jar] Building jar: /home/andy/projects/HornetQTrunk/examples/javaee/mdb/build/mdb-exa + [jar] Building jar: /home/andy/projects/hornetq/trunk/examples/javaee/mdb/build/mdb-exa mple.jar ear: - [jar] Building jar: /home/andy/projects/HornetQTrunk/examples/javaee/mdb/build/mdb-exa + [jar] Building jar: /home/andy/projects/hornetq/trunk/examples/javaee/mdb/build/mdb-exa mple.ear deploy-ear: @@ -209,10 +228,10 @@ Total time: 1 second </programlisting> <para>You can verify that the application has been undeployed by checking the output from the - JBoss Application Server, in this isntance it will be something like:</para> - <programlisting>16:36:45,277 INFO [EJBContainer] STOPPED EJB: org.hornetq.javaee.example.server.MDBExample + JBoss Application Server, in this instance it will be something like:</para> + <programlisting>16:36:45,277 INFO [EJBContainer] STOPPED EJB: org.jboss.javaee.example.server.MDBExample ejbName: MessageMDBExample </programlisting> - <para>Congratulations! you have sucessfully deployed and run a Java EE example.</para> + <para>Congratulations! you have successfully deployed and run a Java EE example.</para> </section> </chapter> Added: trunk/docs/quickstart-guide/en/images/hornetQ_logo_600px.png =================================================================== (Binary files differ) Property changes on: trunk/docs/quickstart-guide/en/images/hornetQ_logo_600px.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/docs/quickstart-guide/en/installation.xml =================================================================== --- trunk/docs/quickstart-guide/en/installation.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/en/installation.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,4 +1,23 @@ <?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ Copyright © 2009 Red Hat, Inc. and others. + ~ + ~ The text of and illustrations in this document are licensed by Red Hat under + ~ a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). + ~ + ~ An explanation of CC-BY-SA is available at + ~ + ~ http://creativecommons.org/licenses/by-sa/3.0/. + ~ + ~ In accordance with CC-BY-SA, if you distribute this document or an adaptation + ~ of it, you must provide the URL for the original version. + ~ + ~ Red Hat, as the licensor of this document, waives the right to enforce, + ~ and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + ~ permitted by applicable law. +--> + <chapter id="installation"> <title>Installation</title> <para>This section describes how to install HornetQ. </para> @@ -76,7 +95,7 @@ </section> <section id="installation.jboss"> <title>HornetQ In JBoss AS 5</title> - <para>HornetQ 2.0 can be deployed in <ulink url="http://www.jboss.org/jbossas/">JBoss + <para>HornetQ can be deployed in <ulink url="http://www.jboss.org/jbossas/">JBoss AS 5</ulink>. It is not shipped by default with the application server and you need to create new AS 5 profiles to run AS 5 with HornetQ.</para> <para>To create AS 5 profiles:</para> @@ -97,12 +116,12 @@ <itemizedlist> <listitem> <para><literal>default-with-hornetq</literal> -- it corresponds to AS 5 <literal - >default</literal> profile with HornetQ 2 as its JMS provider. In this + >default</literal> profile with HornetQ as its JMS provider. In this profile, HornetQ is <emphasis>non-clustered</emphasis></para> </listitem> <listitem> <para><literal>all-with-hornetq</literal> -- it corresponds to AS 5 <literal>all</literal> - profile with HornetQ 2 as its JMS provider. In this profile, HornetQ + profile with HornetQ as its JMS provider. In this profile, HornetQ is <emphasis>clustered</emphasis></para> </listitem> </itemizedlist> Modified: trunk/docs/quickstart-guide/en/introduction.xml =================================================================== --- trunk/docs/quickstart-guide/en/introduction.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/en/introduction.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,8 +1,26 @@ <?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ Copyright © 2009 Red Hat, Inc. and others. + ~ + ~ The text of and illustrations in this document are licensed by Red Hat under + ~ a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). + ~ + ~ An explanation of CC-BY-SA is available at + ~ + ~ http://creativecommons.org/licenses/by-sa/3.0/. + ~ + ~ In accordance with CC-BY-SA, if you distribute this document or an adaptation + ~ of it, you must provide the URL for the original version. + ~ + ~ Red Hat, as the licensor of this document, waives the right to enforce, + ~ and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + ~ permitted by applicable law. +--> + <chapter id="introduction"> <title>Getting Started</title> - <para>This short guide explains how to download, install and quickly get started with JBoss - Messaging.</para> + <para>This short guide explains how to download, install and quickly get started with HornetQ.</para> <para>After downloading and installing we highly recommend you run the examples to get acquainted with HornetQ. We ship with over 50 examples demonstrating most of the features.</para> Modified: trunk/docs/quickstart-guide/en/master.xml =================================================================== --- trunk/docs/quickstart-guide/en/master.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/en/master.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,4 +1,23 @@ <?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ Copyright © 2009 Red Hat, Inc. and others. + ~ + ~ The text of and illustrations in this document are licensed by Red Hat under + ~ a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). + ~ + ~ An explanation of CC-BY-SA is available at + ~ + ~ http://creativecommons.org/licenses/by-sa/3.0/. + ~ + ~ In accordance with CC-BY-SA, if you distribute this document or an adaptation + ~ of it, you must provide the URL for the original version. + ~ + ~ Red Hat, as the licensor of this document, waives the right to enforce, + ~ and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + ~ permitted by applicable law. +--> + <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "../../../lib/docbook-support/support/docbook-dtd/docbookx.dtd" [ <!ENTITY about SYSTEM "about.xml"> @@ -10,8 +29,28 @@ ]> <book lang="en"> <bookinfo> - <title>HornetQ 2.0 Quickstart Guide</title> - <subtitle>Setting the Standard for High Performance Messaging</subtitle> + <title>HornetQ Quickstart Guide</title> + <subtitle>Putting the buzz in messaging</subtitle> + <legalnotice> + <para>Copyright © 2009 Red Hat, Inc. and others.</para> + <para>The text of and illustrations in this document are licensed by Red Hat under + a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA").</para> + <para>An explanation of CC-BY-SA is available at + <ulink url="http://creativecommons.org/licenses/by-sa/3.0/">http://...;. + In accordance with CC-BY-SA, if you distribute this document or an adaptation + of it, you must provide the URL for the original version.</para> + <para>Red Hat, as the licensor of this document, waives the right to enforce, + and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + permitted by applicable law.</para> + </legalnotice> + <mediaobject> + <imageobject> + <imagedata fileref="images/hornetQ_logo_600px.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>HornetQ - Putting the buzz in messaging</phrase> + </textobject> + </mediaobject> </bookinfo> <toc></toc> Modified: trunk/docs/quickstart-guide/en/running.xml =================================================================== --- trunk/docs/quickstart-guide/en/running.xml 2009-08-20 16:30:30 UTC (rev 7832) +++ trunk/docs/quickstart-guide/en/running.xml 2009-08-20 16:35:13 UTC (rev 7833) @@ -1,4 +1,23 @@ <?xml version="1.0" encoding="UTF-8"?> + +<!-- + ~ Copyright © 2009 Red Hat, Inc. and others. + ~ + ~ The text of and illustrations in this document are licensed by Red Hat under + ~ a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). + ~ + ~ An explanation of CC-BY-SA is available at + ~ + ~ http://creativecommons.org/licenses/by-sa/3.0/. + ~ + ~ In accordance with CC-BY-SA, if you distribute this document or an adaptation + ~ of it, you must provide the URL for the original version. + ~ + ~ Red Hat, as the licensor of this document, waives the right to enforce, + ~ and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent + ~ permitted by applicable law. +--> + <chapter id="running"> <title>Starting The Server</title> <section id="running.standalone"> @@ -12,7 +31,7 @@ 15:05:54,108 INFO @main [HornetQBootstrapServer] Starting HornetQ server ... 15:06:02,566 INFO @main [MessagingServerImpl] HornetQ Server version - 2.0.0.BETA1-SNAPSHOT (Stilton, 101) started + 2.0.0.BETA5 (buzz-buzz, 107) started </programlisting> <para>HornetQ is now running. If any errors are displayed or if the server was not started properly, please refer to the troubleshooting guide for help</para> @@ -36,7 +55,7 @@ SVNTag=JBoss_5_1_0_CR1 date=200904091504) ... 15:19:30,305 INFO [MessagingServerImpl] HornetQ Server version - 2.0.0.BETA1-SNAPSHOT (Stilton, 101) started + 2.0.0.BETA5 (buzz-buzz, 107) started ... 15:19:43,601 INFO [ServerImpl] JBoss (Microcontainer) [5.1.0.CR1 (build: SVNTag=JBoss_5_1_0_CR1 date=200904091504)] Started in 1m:8s:121ms