[DOCUMENTATION] English:

 - manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@16599 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Queue-Adapters.xml

@@ -54,17 +54,17 @@
         </para>
 
         <sect3 id="zend.queue.adapters.configuration.Apachemq">
-            <title>ApacheMQ - <classname>Zend_Queue_Adapter_Apachemq</classname></title>
+            <title>ApacheMQ - Zend_Queue_Adapter_Apachemq</title>
 
             <para>
-                Options here listed here are known requirements.  Not all
+                Options here listed here are known requirements. Not all
                 messaging servers require username or password.
             </para>
 
             <itemizedlist>
                 <listitem>
                     <para>
-                         <code>$options['name'] = '/temp/queue1';</code>
+                         <emphasis>$options['name'] = '/temp/queue1';</emphasis>
                     </para>
 
                     <para>
@@ -75,11 +75,11 @@
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['host'] = 'host.domain.tld';</code>
+                        <emphasis>$options['driverOptions']['host'] = 'host.domain.tld';</emphasis>
                     </para>
 
                     <para>
-                        <code>$options['driverOptions']['host'] = '127.0.0.1';</code>
+                        <emphasis>$options['driverOptions']['host'] = '127.0.0.1';</emphasis>
                     </para>
 
                     <para>
@@ -93,7 +93,7 @@
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['port'] = 61613;</code>
+                        <emphasis>$options['driverOptions']['port'] = 61613;</emphasis>
                     </para>
 
                     <para>Default setting for port is 61613.</para>
@@ -101,57 +101,58 @@
 
                 <listitem>
                     <para>
-                         <code>$options['driverOptions']['username'] = 'username';</code>
+                         <emphasis>$options['driverOptions']['username'] = 'username';</emphasis>
                     </para>
 
                     <para>
-                        Optional for some messaging servers.  Read the manual
+                        Optional for some messaging servers. Read the manual
                         for your messaging server.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['password'] = 'password';</code>
+                        <emphasis>$options['driverOptions']['password'] = 'password';</emphasis>
                     </para>
 
                     <para>
-                        Optional for some messaging servers.  Read the manual
+                        Optional for some messaging servers. Read the manual
                         for your messaging server.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['timeout_sec'] = 2;</code>
+                        <emphasis>$options['driverOptions']['timeout_sec'] = 2;</emphasis>
                     </para>
 
                     <para>
-                        <code>$options['driverOptions']['timeout_usec'] = 0;</code>
+                        <emphasis>$options['driverOptions']['timeout_usec'] = 0;</emphasis>
                     </para>
 
                     <para>
-                        This is the amount of time that Zend_Queue_Adapter_Activemq
-                        will wait for read activity on a socket before returning
-                        no messages.
+                        This is the amount of time that
+                        <classname>Zend_Queue_Adapter_Activemq</classname> will wait for
+                        read activity on a socket before returning no messages.
                     </para>
                 </listitem>
             </itemizedlist>
         </sect3>
 
         <sect3 id="zend.queue.adapters.configuration.Db">
-            <title>Db - <code>Zend_Queue_Adapter_Db</code></title>
+            <title>Db - Zend_Queue_Adapter_Db</title>
 
             <para>
                 Driver options are checked for a few required options such
-                as <code>type</code>, <code>host</code>, <code>username</code>,
-                <code>password</code>, and <code>dbname</code>.  You may pass along
+                as <emphasis>type</emphasis>, <emphasis>host</emphasis>,
+                <emphasis>username</emphasis>, <emphasis>password</emphasis>,
+                and <emphasis>dbname</emphasis>. You may pass along
                 additional parameters for <methodname>Zend_DB::factory()</methodname> as parameters
-                in <code>$options['driverOptions']</code>.  An example of an additional
-                option not listed here, but could be passed would be <code>port</code>.
+                in <varname>$options['driverOptions']</varname>. An example of an additional
+                option not listed here, but could be passed would be <emphasis>port</emphasis>.
             </para>
 
-            <programlisting role="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $options = array(
     'driverOptions' => array(
         'host'      => 'db1.domain.tld',
@@ -175,7 +176,7 @@ $queue = Zend_Queue::factory('Db', $options);
             <itemizedlist>
                 <listitem>
                     <para>
-                         <code>$options['name'] = 'queue1';</code>
+                         <emphasis>$options['name'] = 'queue1';</emphasis>
                     </para>
 
                     <para>
@@ -185,25 +186,25 @@ $queue = Zend_Queue::factory('Db', $options);
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['type'] = 'Pdo';</code>
+                        <emphasis>$options['driverOptions']['type'] = 'Pdo';</emphasis>
                     </para>
 
                     <para>
-                        <code>type</code> is the adapter you wish to have
-                        <methodname>Zend_Db::factory</methodname> use. This is
+                        <emphasis>type</emphasis> is the adapter you wish to have
+                        <methodname>Zend_Db::factory()</methodname> use. This is
                         the first parameter for the
-                        <methodname>Zend::Db::factory()</methodname> class
+                        <methodname>Zend_Db::factory()</methodname> class
                         method call.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['host'] = 'host.domain.tld';</code>
+                        <emphasis>$options['driverOptions']['host'] = 'host.domain.tld';</emphasis>
                     </para>
 
                     <para>
-                        <code>$options['driverOptions']['host'] = '127.0.0.1';</code>
+                        <emphasis>$options['driverOptions']['host'] = '127.0.0.1';</emphasis>
                     </para>
 
                     <para>You may set host to an IP address or a hostname.</para>
@@ -213,19 +214,19 @@ $queue = Zend_Queue::factory('Db', $options);
 
                 <listitem>
                     <para>
-                         <code>$options['driverOptions']['username'] = 'username';</code>
+                         <emphasis>$options['driverOptions']['username'] = 'username';</emphasis>
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['password'] = 'password';</code>
+                        <emphasis>$options['driverOptions']['password'] = 'password';</emphasis>
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['dbname'] = 'dbname';</code>
+                        <emphasis>$options['driverOptions']['dbname'] = 'dbname';</emphasis>
                     </para>
 
                     <para>
@@ -237,12 +238,12 @@ $queue = Zend_Queue::factory('Db', $options);
         </sect3>
 
         <sect3 id="zend.queue.adapters.configuration.memcacheq">
-            <title>MemcacheQ - <classname>Zend_Queue_Adapter_Memcacheq</classname></title>
+            <title>MemcacheQ - Zend_Queue_Adapter_Memcacheq</title>
 
             <itemizedlist>
                 <listitem>
                     <para>
-                         <code>$options['name'] = 'queue1';</code>
+                         <emphasis>$options['name'] = 'queue1';</emphasis>
                     </para>
 
                     <para>
@@ -252,11 +253,11 @@ $queue = Zend_Queue::factory('Db', $options);
 
                 <listitem>
                     <para>
-                         <code>$options['driverOptions']['host'] = 'host.domain.tld';</code>
+                         <emphasis>$options['driverOptions']['host'] = 'host.domain.tld';</emphasis>
                     </para>
 
                     <para>
-                         <code>$options['driverOptions']['host'] = '127.0.0.1;'</code>
+                         <emphasis>$options['driverOptions']['host'] = '127.0.0.1;'</emphasis>
                     </para>
 
                     <para>You may set host to an IP address or a hostname.</para>
@@ -266,7 +267,7 @@ $queue = Zend_Queue::factory('Db', $options);
 
                 <listitem>
                     <para>
-                        <code>$options['driverOptions']['port'] = 22201;</code>
+                        <emphasis>$options['driverOptions']['port'] = 22201;</emphasis>
                     </para>
 
                     <para>The default setting for port is 22201.</para>
@@ -275,12 +276,12 @@ $queue = Zend_Queue::factory('Db', $options);
         </sect3>
 
         <sect3 id="zend.queue.adapters.configuration.array">
-            <title>Array - <classname>Zend_Queue_Adapter_Array</classname></title>
+            <title>Array - Zend_Queue_Adapter_Array</title>
 
             <itemizedlist>
                 <listitem>
                     <para>
-                         <code>$options['name'] = 'queue1';</code>
+                         <emphasis>$options['name'] = 'queue1';</emphasis>
                     </para>
 
                     <para>
@@ -307,40 +308,40 @@ $queue = Zend_Queue::factory('Db', $options);
 
             <para>
                 While Apache's ActiveMQ will support multiple subscriptions, the
-                <classname>Zend_Queue</classname> does not.  You must create a
+                <classname>Zend_Queue</classname> does not. You must create a
                 new <classname>Zend_Queue</classname> object for each individual
                 subcription.
             </para>
 
             <para>
-                ActiveMQ queue/topic names must begine with one of:
+                ActiveMQ queue/topic names must begin with one of:
             </para>
 
             <itemizedlist>
                 <listitem>
                     <para>
-                        <code>/queue/</code>
+                        <filename>/queue/</filename>
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <code>/topic/</code>
+                        <filename>/topic/</filename>
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <code>/temp-queue/</code>
+                        <filename>/temp-queue/</filename>
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <code>/temp-topic/</code>
+                        <filename>/temp-topic/</filename>
                     </para>
                 </listitem>
             </itemizedlist>
 
             <para>
-                For example: <code>/queue/testing</code>
+                For example: <filename>/queue/testing</filename>
             </para>
 
             <para>
@@ -350,21 +351,21 @@ $queue = Zend_Queue::factory('Db', $options);
             <itemizedlist>
                 <listitem>
                     <para>
-                         <code>create()</code> - create queue.
+                         <methodname>create()</methodname> - create queue.
                          Calling this function will throw an exception.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>delete()</code> - delete queue.
+                        <methodname>delete()</methodname> - delete queue.
                         Calling this function will throw an exception.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>getQueues()</code> - list queues.
+                        <methodname>getQueues()</methodname> - list queues.
                         Calling this function will throw an exception.
                     </para>
                 </listitem>
@@ -375,8 +376,8 @@ $queue = Zend_Queue::factory('Db', $options);
             <title>Zend_Db</title>
 
             <para>
-                The database <code>CREATE TABLE ( ... )</code> SQL statement
-                can be found in <filename>Zend/Queue/Adapter/Db/queue.sql</filename>.
+                The database <emphasis>CREATE TABLE ( ... )</emphasis> <acronym>SQL</acronym>
+                statement can be found in <filename>Zend/Queue/Adapter/Db/queue.sql</filename>.
             </para>
         </sect3>
 
@@ -384,20 +385,20 @@ $queue = Zend_Queue::factory('Db', $options);
             <title>MemcacheQ</title>
 
             <para>
-                Memcache can be downloaded from
-                <ulink url="http://www.danga.com/memcached/">http://www.danga.com/memcached/</ulink>.
+                Memcache can be downloaded from <ulink
+                    url="http://www.danga.com/memcached/">http://www.danga.com/memcached/</ulink>.
             </para>
 
             <para>
-                MemcacheQ can be downloaded from
-                A <ulink url="http://memcachedb.org/memcacheq/">http://memcachedb.org/memcacheq/</ulink>.
+                MemcacheQ can be downloaded from <ulink
+                    url="http://memcachedb.org/memcacheq/">http://memcachedb.org/memcacheq/</ulink>.
             </para>
 
             <itemizedlist>
                 <listitem>
                     <para>
-                        <code>deleteMessage()</code> - Messages are deleted upon
-                        reception from the queue.  calling this function would
+                        <methodname>deleteMessage()</methodname> - Messages are deleted upon
+                        reception from the queue. Calling this function would
                         have no effect. Calling this function will throw an
                         error.
                     </para>
@@ -405,9 +406,9 @@ $queue = Zend_Queue::factory('Db', $options);
 
                 <listitem>
                     <para>
-                        <code>count() or count($adapter)</code> - MemcacheQ does
-                        not support a method for counting the number of items in
-                        a queue.  Calling this function will throw an error.
+                        <methodname>count()</methodname> or <methodname>count($adapter)</methodname>
+                        - MemcacheQ does not support a method for counting the number of items in
+                        a queue. Calling this function will throw an error.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -417,8 +418,8 @@ $queue = Zend_Queue::factory('Db', $options);
             <title>Array (local)</title>
 
             <para>
-                The Array queue is a PHP <code>array()</code> in local memory.
-                The <classname>Zend_Queue_Adapter_Array</classname> is good for
+                The Array queue is a <acronym>PHP</acronym> <methodname>array()</methodname>
+                in local memory. The <classname>Zend_Queue_Adapter_Array</classname> is good for
                 unit testing.
             </para>
         </sect3>

documentation/manual/en/module_specs/Zend_Queue-Custom.xml

@@ -9,15 +9,15 @@
         <para>
             <classname>Zend_Queue</classname> will accept any adapter that
             implements
-            <classname>Zend_Queue_Adapter_AdapterAbstract</classname>.  You can
+            <classname>Zend_Queue_Adapter_AdapterAbstract</classname>. You can
             create your own adapter by extending one of the existing adapters,
             or the abstract class
-            <classname>Zend_Queue_Adapter_AdapterAbstract</classname>.  I
+            <classname>Zend_Queue_Adapter_AdapterAbstract</classname>. I
             suggest reviewing <classname>Zend_Queue_Adapter_Array</classname> as
             this adapter is the easist to conceptualize.
         </para>
 
-        <programlisting role="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 class Custom_DbForUpdate extends Zend_Queue_Adapter_Db
 {
     /**
@@ -54,7 +54,7 @@ $queue = Zend_Queue($adapter, $options);
             You can also change the adapter on the fly as well.
         </para>
 
-        <programlisting role="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $adapter = new MyCustom_Adapter($options);
 $queue   = Zend_Queue($options);
 $queue->setAdapter($adapter);
@@ -63,7 +63,7 @@ echo "Adapter: ", get_class($queue->getAdapter()), "\n";
 
         <para>or</para>
 
-        <programlisting role="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $options = array(
     'name'           => 'queue1',
     'namespace'      => 'Custom',
@@ -88,7 +88,7 @@ $queue = Zend_Queue('DbForUpdate', $config); // loads Custom_DbForUpdate
             Our variables start with an underscore. For example:
         </para>
 
-        <programlisting role="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 class Zend_Queue_Message
 {
     protected $_data = array();
@@ -106,7 +106,7 @@ class Zend_Queue_Message
 
         <para>
             <classname>Zend_Queue</classname> will also accept your own message
-            iterator class.  The message iterator class is used to return
+            iterator class. The message iterator class is used to return
             messages from
             <methodname>Zend_Queue_Adapter_Abstract::recieve()</methodname>.
             <methodname>Zend_Queue_Abstract::receive()</methodname> should aways

documentation/manual/en/module_specs/Zend_Queue-Example.xml

@@ -4,12 +4,12 @@
     <title>Example usage</title>
 
     <para>
-        The below example of <code>Zend_Queue</code> shows a variety of
+        The below example of <classname>Zend_Queue</classname> shows a variety of
         features, including queue creation, queue retrieval, message retrieval,
         message deletion, and sending messages.
     </para>
 
-    <programlisting role="php"><![CDATA[
+    <programlisting language="php"><![CDATA[
 // For configuration options
 // @see Zend_Queue_Adapater::__construct()
 $options = array(

documentation/manual/en/module_specs/Zend_Queue-Framework.xml

@@ -6,7 +6,7 @@
     <para>
         The <classname>Zend_Queue</classname> is a proxy that hides the details
         of the queue services. The queue services are represented by
-        <classname>Zend_Queue_Adapter_(service)</classname>.  For example,
+        <classname>Zend_Queue_Adapter_&lt;service&gt;</classname>. For example,
         <classname>Zend_Queue_Adapter_Db</classname> is a queue that will use
         database tables to store and retrieve messages.
     </para>
@@ -15,7 +15,7 @@
         Below is an example for using database tables for a queuing system:
     </para>
 
-    <programlisting role="php"><![CDATA[
+    <programlisting language="php"><![CDATA[
 $options = array(
     'name'          => 'queue1',
     'driverOptions' => array(
@@ -41,19 +41,19 @@ $queue = Zend_Queue('Db', $options);
 
     <para>
         The accepted configuration settings for each adapter are provided
-        in the <xref linkend="zend.queue.adapters">adapter notes</xref>.
+        in the <ulink linkend="zend.queue.adapters">adapter notes</ulink>.
     </para>
 
     <para>
         <classname>Zend_Queue</classname> returns messages using the class
         <classname>Zend_Queue_Message_Iterator</classname>, which is an
-        implementation of SPL <classname>Iterator</classname> and
+        implementation of <acronym>SPL</acronym> <classname>Iterator</classname> and
         <classname>Countable</classname>.
         <classname>Zend_Queue_Message_Iterator</classname> contains an array of
         <classname>Zend_Queue_Message</classname> objects.
     </para>
 
-    <programlisting role="php"><![CDATA[
+    <programlisting language="php"><![CDATA[
 $messages = $queue->receive(5);
 foreach ($messages as $i => $message) {
     echo "$i) Message => ", $message->body, "\n";
@@ -92,7 +92,7 @@ foreach ($messages as $i => $message) {
 
         <para>
             The queue services supported by <classname>Zend_Queue</classname> do
-            not all support the same functions.  For example,
+            not all support the same functions. For example,
             <classname>Zend_Queue_Adapter_Array</classname>,
             <classname>Zend_Queue_Adapter_Db</classname>, support all functions,
             while <classname>Zend_Queue_Adapter_Activemq</classname> does not
@@ -108,55 +108,55 @@ foreach ($messages as $i => $message) {
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>create</code> - create a queue
+                    <methodname>create()</methodname> - create a queue
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>delete</code> - delete a queue
+                    <methodname>delete()</methodname> - delete a queue
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>send</code> - send a message
+                    <methodname>send()</methodname> - send a message
                 </para>
 
                 <para>
-                    <code>send</code> is not available in all adapters; the
+                    <methodname>send()</methodname> is not available in all adapters; the
                     <classname>Zend_Queue_Adapter_Null</classname> does not
-                    support <code>send</code>.
+                    support <methodname>send()</methodname>.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>receive</code> - receive messages
+                    <methodname>receive()</methodname> - receive messages
                 </para>
 
                 <para>
-                    <code>receive</code> is not available in all adapters;
+                    <methodname>receive()</methodname> is not available in all adapters;
                     the <classname>Zend_Queue_Adapter_Null</classname> does not
-                    support <code>receive</code>.
+                    support <methodname>receive()</methodname>.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>deleteMessage</code> - delete a message
+                    <methodname>deleteMessage()</methodname> - delete a message
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>count</code> - count the number of messages in a queue
+                    <methodname>count()</methodname> - count the number of messages in a queue
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>isExists</code> - checks the existance of a queue
+                    <methodname>isExists()</methodname> - checks the existance of a queue
                 </para>
             </listitem>
         </itemizedlist>

documentation/manual/en/module_specs/Zend_Queue-Introduction.xml

@@ -9,23 +9,23 @@
     </para>
 
     <para>
-        A message queue is a method for distributed processing.  For example, a
+        A message queue is a method for distributed processing. For example, a
         Job Broker application may accept multiple applications for jobs from
         a varity of sources.
     </para>
 
     <para>
-        You could create a queue "/queue/applications" that would have a sender
-        and a receiver. The sender would be any available source that could
-        connect to your message service or indirectly to an application (web)
-        that could connect to the message service.
+        You could create a queue "<filename>/queue/applications</filename>" that
+        would have a sender and a receiver. The sender would be any available
+        source that could connect to your message service or indirectly to an
+        application (web) that could connect to the message service.
     </para>
 
     <para>
         The sender sends a message to the queue:
     </para>
 
-    <programlisting role="xml"><![CDATA[
+    <programlisting language="xml"><![CDATA[
 <resume>
     <name>John Smith</name>
     <location>
@@ -49,7 +49,10 @@
         There many messaging patterns that can be applied to queues to abstract
         the flow of control from the code and provide metrics, transformations,
         and monitoring of messages queues. A good book on messaging patterns is
-        <ulink url="http://www.amazon.com/Enterprise-Integration-Patterns-Designing-Addison-Wesley/dp/0321200683">Enterprise Integration Patterns: Designing, Building, and Deploying Messaging Solutions (Addison-Wesley Signature Series)</ulink>
+        <ulink
+            url="http://www.amazon.com/Enterprise-Integration-Patterns-Designing-Addison-Wesley/dp/0321200683">Enterprise
+            Integration Patterns: Designing, Building, and Deploying Messaging Solutions
+            (Addison-Wesley Signature Series)</ulink>
         (ISBN-10 0321127420; ISBN-13 978-0321127426).
     </para>
 </sect1>

documentation/manual/en/module_specs/Zend_Queue-Stomp.xml

@@ -6,8 +6,9 @@
     <para>
         <classname>Zend_Queue_Stomp</classname> provides a basic client to
         communicate with <ulink url="http://stomp.codehaus.org/">Stomp</ulink>
-        compatible servers.  Some servers, such as ApacheMQ and RabbitMQ, will
-        allow you to communicate by other methods, such as HTTP, and XMPP.
+        compatible servers. Some servers, such as ApacheMQ and RabbitMQ, will
+        allow you to communicate by other methods, such as <acronym>HTTP</acronym>,
+        and <acronym>XMPP</acronym>.
     </para>
 
     <para>