[MANUAL] English:

- manual corrections

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

documentation/manual/en/module_specs/Zend_Application-AvailableResources-Dojo.xml

@@ -20,11 +20,10 @@
 resources.dojo.enable = true ; Always load the Dojo javascript files
 ]]></programlisting>
 
-
         <para>
             The <classname>Zend_Dojo</classname> resource plugin utilises the options for the
-            <command>Zend_Dojo_View_Helper_Dojo_Container::setOptions()</command> to configure the
-            viewhelpers. Please see the <classname><link linkend="zend.dojo">Zend_Dojo</link></classname>
+            <methodname>Zend_Dojo_View_Helper_Dojo_Container::setOptions()</methodname> to
+            configure the viewhelpers. Please see the <link linkend="zend.dojo">Zend_Dojo</link>
             chapter for full descriptions and available options.
         </para>
     </example>

documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Application.xml

@@ -149,7 +149,7 @@
                                             single key "configs" whose value is an array of the
                                             files to merge. Note: this means you either pass a
                                             literal path, or
-                                            <command>array("configs"=>array("/path1","/path2"[,...]))</command>.
+                                            <command>array("configs"=>array("/path1","/path2"[,...]));</command>.
                                         </para>
                                     </listitem>
 

documentation/manual/en/module_specs/Zend_Dojo-BuildLayers.xml

@@ -91,8 +91,8 @@ $view->dojo()->registerModulePath('custom', '../custom/')
 
         <para>
             As an example, let's say you wanted to create the module layer
-            "custom.main". Assuming you follow the recommended project directory
-            structure, and that you are storing your JavaScript files under
+            "<filename>custom.main</filename>". Assuming you follow the recommended project
+            directory structure, and that you are storing your JavaScript files under
             <filename>public/js/</filename>, you could do the following:
         </para>
 

documentation/manual/en/module_specs/Zend_Dojo-Data.xml

@@ -5,14 +5,14 @@
 
     <para>
         Dojo provides data abstractions for data-enabled widgets via its
-        dojo.data component. This component provides the ability to attach a
+        <command>dojo.data</command> component. This component provides the ability to attach a
         data store, provide some metadata regarding the identity field and
         optionally a label field, and an <acronym>API</acronym> for querying, sorting, and
         retrieving records and sets of records from the datastore.
     </para>
 
     <para>
-        dojo.data is often used with XmlHttpRequest to pull dynamic data from
+        <command>dojo.data</command> is often used with XmlHttpRequest to pull dynamic data from
         the server. The primary mechanism for this is to extend the
         QueryReadStore to point at a <acronym>URL</acronym> and specify the query information. The
         server side then returns data in the following <acronym>JSON</acronym> format:
@@ -39,7 +39,7 @@
         <title>Zend_Dojo_Data Usage</title>
 
         <para>
-            At its simplest, dojo.data requires that you provide the name of the
+            At its simplest, <command>dojo.data</command> requires that you provide the name of the
             identifier field in each item, and a set of items (data). You
             can either pass these in via the constructor, or via mutators:
         </para>
@@ -82,7 +82,7 @@ $data->addItems($someMoreItems);
             <title>Always use an identifier!</title>
 
             <para>
-                Every dojo.data datastore requires that the identifier column
+                Every <command>dojo.data</command> datastore requires that the identifier column
                 be provided as metadata, including <classname>Zend_Dojo_Data</classname>. In fact,
                 if you attempt to add items without an identifier, it will raise an exception.
             </para>
@@ -100,7 +100,10 @@ $data->addItems($someMoreItems);
             </listitem>
 
             <listitem>
-                <para>Any other objects (will serialize via get_object_vars())</para>
+                <para>
+                    Any other objects (will serialize via
+                    <methodname>get_object_vars()</methodname>)
+                </para>
             </listitem>
         </itemizedlist>
 
@@ -137,8 +140,8 @@ $data->setLabel('name');
 
         <para>
             Finally, you can also load a <classname>Zend_Dojo_Data</classname> item from a
-            dojo.data <acronym>JSON</acronym> array, using the <methodname>fromJson()</methodname>
-            method.
+            <command>dojo.data</command> <acronym>JSON</acronym> array, using the
+            <methodname>fromJson()</methodname> method.
         </para>
 
         <example id="zend.dojo.data.usage.populate">
@@ -155,8 +158,8 @@ $data->fromJson($json);
 
         <para>
             Some Dojo components require additional metadata along with
-            the dojo.data payload. As an example, <command>dojox.grid.Grid</command>
-            can pull data dynamically from a
+            the <command>dojo.data</command> payload. As an example,
+            <command>dojox.grid.Grid</command> can pull data dynamically from a
             <command>dojox.data.QueryReadStore</command>. For pagination to work
             correctly, each return payload should contain a <property>numRows</property>
             key with the total number of rows that could be returned by the

documentation/manual/en/module_specs/Zend_Dojo-Form-Elements.xml

@@ -249,7 +249,7 @@ $form->addElement(
         <para>
             The ComboBox and FilteringSelect form elements provide accessors and mutators for
             examining and setting the select options as well as specifying a
-            dojo.data datastore (if used). They extend from DijitMulti, which
+            <command>dojo.data</command> datastore (if used). They extend from DijitMulti, which
             allows you to specify select options via the
             <methodname>setMultiOptions()</methodname> and <methodname>setMultiOption()</methodname>
             methods. In addition, the following methods are available:
@@ -281,7 +281,7 @@ $form->addElement(
             <listitem>
                 <para>
                     <methodname>setStoreType($dojoType)</methodname>: set the datastore class
-                    to use; e.g., "dojo.data.ItemFileReadStore".
+                    to use; e.g., "<command>dojo.data.ItemFileReadStore</command>".
                 </para>
             </listitem>
 
@@ -295,9 +295,9 @@ $form->addElement(
                 <para>
                     <methodname>setStoreParams(array $params)</methodname>: set any parameters
                     used to configure the datastore object. As an example,
-                    dojo.data.ItemFileReadStore datastore would expect a 'url'
+                    <command>dojo.data.ItemFileReadStore</command> datastore would expect a 'url'
                     parameter pointing to a location that would return the
-                    dojo.data object.
+                    <command>dojo.data</command> object.
                 </para>
             </listitem>
 
@@ -324,7 +324,7 @@ $form->addElement(
         </itemizedlist>
 
         <para>
-            By default, if no dojo.data store is registered with the element,
+            By default, if no <command>dojo.data</command> store is registered with the element,
             this element registers an <classname>InArray</classname> validator which
             validates against the array keys of registered options. You can
             disable this behavior by either calling
@@ -488,7 +488,7 @@ $form->addElement(
             <listitem>
                 <para>
                     <methodname>setAmPm($flag)</methodname> and <methodname>getAmPm()</methodname>:
-                    Whether or not to use AM/PM strings in times.
+                    Whether or not to use AM or PM strings in times.
                 </para>
             </listitem>
 
@@ -557,9 +557,9 @@ $form->addElement(
         <title>Editor</title>
 
         <para>
-            Editor provides a WYSIWYG editor that can be used to both create and
-            edit rich HTML content. dijit.Editor is pluggable and may be
-            extended with custom plugins if desired; see <ulink
+            Editor provides a <acromyn>WYSIWYG</acromyn> editor that can be used to both create and
+            edit rich <acromyn>HTML</acromyn> content. <command>dijit.Editor</command> is pluggable
+            and may be extended with custom plugins if desired; see <ulink
                 url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/advanced-editing-and-display/editor-rich-text">the
                 dijit.Editor documentation</ulink> for more details.
         </para>
@@ -608,7 +608,7 @@ $form->addElement(
 
             <listitem>
                 <para>
-                    <emphasis>events</emphasis> are standard DOM events, such as
+                    <emphasis>events</emphasis> are standard <acromyn>DOM</acromyn> events, such as
                     onClick, onKeyUp, etc. The following accessors and mutators
                     are available for manipulating events:
                 </para>
@@ -766,15 +766,15 @@ $form->addElement('editor', 'content', array(
 
             <para>
                 The Editor dijit uses an <acronym>HTML</acronym> <acronym>DIV</acronym> by default.
-                The <classname>dijit._editor.RichText</classname> documentation indicates that
-                having it built on an HTML <acronym>TEXTAREA</acronym> can potentially have security
-                implications.
+                The <command>dijit._editor.RichText</command> documentation indicates that
+                having it built on an <acromyn>HTML</acromyn> <acronym>TEXTAREA</acronym> can
+                potentially have security implications.
             </para>
 
             <para>
                 That said, there may be times when you want an Editor widget that can gracefully
                 degrade to a <acronym>TEXTAREA</acronym>. In such situations, you can do so by
-                setting the <varname>degrade</varname> property to <constant>TRUE</constant>:
+                setting the <property>degrade</property> property to <constant>TRUE</constant>:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -855,8 +855,8 @@ $editor->degrade = true;
                 <para>
                     <methodname>setTopDecorationAttribs(array $attribs)</methodname> and
                     <methodname>setBottomDecorationAttribs(array $attribs)</methodname>:
-                    HTML attributes to specify for the given Rule or RuleLabels
-                    HTML element container.
+                    <acromyn>HTML</acromyn> attributes to specify for the given Rule or RuleLabels
+                    <acromyn>HTML</acromyn> element container.
                 </para>
             </listitem>
 
@@ -1203,8 +1203,8 @@ $form->addElement(
         <title>SimpleTextarea</title>
 
         <para>
-            SimpleTextarea acts primarily like a standard HTML textarea. However, it
-            does not support either the rows or cols settings. Instead, the
+            SimpleTextarea acts primarily like a standard <acromyn>HTML</acromyn> textarea. However,
+            it does not support either the rows or cols settings. Instead, the
             textarea width should be specified using standard <acronym>CSS</acronym> measurements.
             Unlike Textarea, it will not grow automatically
         </para>
@@ -1359,7 +1359,8 @@ $form->addElement(
                 <para>
                     <methodname>setUppercase($flag)</methodname> and
                     <methodname>getUppercase()</methodname>: set and retrieve
-                    the flag indicating whether or not the input should be cast to UPPERCASE.
+                    the flag indicating whether or not the input should be cast to
+                    <acromyn>UPPERCASE</acromyn>.
                 </para>
             </listitem>
 
@@ -1402,7 +1403,7 @@ $form->addElement(
         <title>Textarea</title>
 
         <para>
-            Textarea acts primarily like a standard HTML textarea. However, it
+            Textarea acts primarily like a standard <acromyn>HTML</acromyn> textarea. However, it
             does not support either the rows or cols settings. Instead, the
             textarea width should be specified using standard <acronym>CSS</acronym> measurements;
             rows should be omitted entirely. The textarea will then grow
@@ -1459,7 +1460,7 @@ $form->addElement(
                 <para>
                     <methodname>setClickableIncrement($format)</methodname> and
                     <methodname>getClickableIncrement()</methodname>: set the <ulink
-                        url="http://en.wikipedia.org/wiki/ISO_8601">ISO-8601</ulink>
+                        url="http://en.wikipedia.org/wiki/ISO_8601">ISO_8601</ulink>
                     string representing the amount by which every clickable element
                     in the time picker increases.
                 </para>
@@ -1469,7 +1470,7 @@ $form->addElement(
                 <para>
                     <methodname>setVisibleIncrement($format)</methodname> and
                     <methodname>getVisibleIncrement()</methodname>: set the increment visible
-                    in the time chooser; must follow ISO-8601 formats.
+                    in the time chooser; must follow <acromyn>ISO_8601</acromyn> formats.
                 </para>
             </listitem>
 
@@ -1478,7 +1479,7 @@ $form->addElement(
                     <methodname>setVisibleRange($format)</methodname> and
                     <methodname>getVisibleRange()</methodname>: set and retrieve the range of
                     time visible in the time chooser at any given moment; must
-                    follow ISO-8601 formats.
+                    follow <acromyn>ISO_8601</acromyn> formats.
                 </para>
             </listitem>
         </itemizedlist>

documentation/manual/en/module_specs/Zend_Dojo-View.xml

@@ -10,9 +10,9 @@
     <itemizedlist>
         <listitem>
             <para>
-                <emphasis>dojo():</emphasis> setup the Dojo environment
-                for your page, including dojo configuration values, custom module
-                paths, module require statements, theme stylesheets, CDN usage, and more.
+                <emphasis><methodname>dojo()</methodname>:</emphasis> setup the Dojo environment
+                for your page, including dojo configuration values, custom module paths, module
+                require statements, theme stylesheets, <acromyn>CDN</acromyn> usage, and more.
             </para>
         </listitem>
     </itemizedlist>

documentation/manual/en/module_specs/Zend_Dojo.xml

@@ -11,8 +11,8 @@
     </para>
 
     <itemizedlist>
-        <listitem><para>JSON-RPC support</para></listitem>
-        <listitem><para>dojo.data compatibility</para></listitem>
+        <listitem><para><acromyn>JSON-RPC</acromyn> support</para></listitem>
+        <listitem><para><command>dojo.data</command> compatibility</para></listitem>
         <listitem><para>View helper to help setup the Dojo environment</para></listitem>
         <listitem><para>Dijit-specific <classname>Zend_View</classname> helpers</para></listitem>
 
@@ -23,13 +23,14 @@
 
     <para>
         The Dojo distribution itself may be found in the
-        <filename>externals/dojo/</filename> directory of the Zend Framework
+        <filename>externals/dojo/</filename> directory of Zend Framework's
         distribution. This is a source distribution, which includes Dojo's full
         javascript source, unit tests, and build tools. You can symlink this
         into your javascript directory, copy it, or use the build tool to create
         your own custom build to include in your project. Alternatively, you can
         use one of the Content Delivery Networks that offer Dojo (Zend Framework supports
-        both the official AOL CDN as well as the Google CDN).
+        both the official <acromyn>AOL</acromyn> <acromyn>CDN</acromyn> as well as the Google
+        <acromyn>CDN</acromyn>).
     </para>
 </sect1>
 <!--

documentation/manual/en/module_specs/Zend_Dom.xml

@@ -4,9 +4,9 @@
     <title>Introduction</title>
 
     <para>
-        <classname>Zend_Dom</classname> provides tools for working with DOM documents and
-        structures. Currently, we offer <classname>Zend_Dom_Query</classname>, which
-        provides a unified interface for querying DOM documents utilizing both
+        <classname>Zend_Dom</classname> provides tools for working with <acromyn>DOM</acromyn>
+        documents and structures. Currently, we offer <classname>Zend_Dom_Query</classname>, which
+        provides a unified interface for querying <acromyn>DOM</acromyn> documents utilizing both
         XPath and <acronym>CSS</acronym> selectors.
     </para>
 </sect1>