[DOCUMENTATION] English:

-  manual fixes

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

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

@@ -18,9 +18,9 @@
             Normally it is expected that users would use one of the adapter classes such as <link
                 linkend="zend.config.adapters.ini"><classname>Zend_Config_Ini</classname></link> or
             <link linkend="zend.config.adapters.xml"><classname>Zend_Config_Xml</classname></link>,
-            but if configuration data are available in a PHP array, one may simply pass the data to
-            the <classname>Zend_Config</classname> constructor in order to utilize a simple
-            object-oriented interface:
+            but if configuration data are available in a <acronym>PHP</acronym> array, one may
+            simply pass the data to the <classname>Zend_Config</classname> constructor in order to
+            utilize a simple object-oriented interface:
         </para>
         <programlisting language="php"><![CDATA[
 // Given an array of configuration data
@@ -67,8 +67,8 @@ $host = $config->database->get('host', 'localhost');
     <example id="zend.config.introduction.example.file.php">
         <title>Using Zend_Config with a PHP Configuration File</title>
         <para>
-            It is often desirable to use a pure PHP-based configuration file. The following code
-            illustrates how easily this can be accomplished:
+            It is often desirable to use a pure <acronym>PHP</acronym>-based configuration file.
+            The following code illustrates how easily this can be accomplished:
         </para>
         <programlisting language="php"><![CDATA[
 // config.php

documentation/manual/en/module_specs/Zend_Config-TheoryOfOperation.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.config.theory_of_operation">
     <title>Theory of Operation</title>
+
     <para>
         Configuration data are made accessible to the <classname>Zend_Config</classname> constructor
         through an associative array, which may be multi-dimensional, in order to support
@@ -11,6 +12,7 @@
         directly to the <classname>Zend_Config</classname> constructor, without using an adapter
         class, since it may be appropriate to do so in certain situations.
     </para>
+
     <para>
         Each configuration data array value becomes a property of the
         <classname>Zend_Config</classname> object. The key is used as the property name. If a value
@@ -19,72 +21,83 @@
         recursively, such that a hierarchy of configuration data may be created with any number of
         levels.
     </para>
+
     <para>
-        <classname>Zend_Config</classname> implements the <code>Countable</code> and
-        <code>Iterator</code> interfaces in order to facilitate simple access to configuration data.
-        Thus, one may use the <ulink url="http://php.net/count"><code>count()</code></ulink>
-        function and PHP constructs such as
-        <ulink url="http://php.net/foreach"><code>foreach</code></ulink> with
+        <classname>Zend_Config</classname> implements the <emphasis>Countable</emphasis> and
+        <emphasis>Iterator</emphasis> interfaces in order to facilitate simple access to
+        configuration data. Thus, one may use the
+        <ulink url="http://php.net/count"><methodname>count()</methodname></ulink>
+        function and <acronym>PHP</acronym> constructs such as
+        <ulink url="http://php.net/foreach"><emphasis>foreach</emphasis></ulink> with
         <classname>Zend_Config</classname> objects.
     </para>
+
     <para>
         By default, configuration data made available through <classname>Zend_Config</classname> are
-        read-only, and an assignment (e.g., <code>$config->database->host = 'example.com'</code>)
+        read-only, and an assignment (e.g., $config->database->host = 'example.com')
         results in a thrown exception. This default behavior may be overridden through the
         constructor, however, to allow modification of data values. Also, when modifications are
         allowed, <classname>Zend_Config</classname> supports unsetting of values (i.e.
-        <code>unset($config->database->host);</code>). The <code>readOnly()</code> method can be
-        used to determine if modifications to a given <classname>Zend_Config</classname> object are
-        allowed and the <code>setReadOnly()</code> method can be used to stop any further
-        modifications to a <classname>Zend_Config</classname> object that was created allowing
-        modifications.
-        <note>
-            <para>
-                It is important not to confuse such in-memory modifications with saving
-                configuration data out to specific storage media. Tools for creating and modifying
-                configuration data for various storage media are out of scope with respect to
-                <classname>Zend_Config</classname>. Third-party open source solutions are readily
-                available for the purpose of creating and modifying configuration data for various
-                storage media.
-            </para>
-        </note>
+        <methodname>unset($config->database->host);</methodname>). The
+        <methodname>readOnly()</methodname> method can be used to determine if modifications to a
+        given <classname>Zend_Config</classname> object are allowed and the
+        <methodname>setReadOnly()</methodname> method can be used to stop any further modifications
+        to a <classname>Zend_Config</classname> object that was created allowing modifications.
     </para>
+
+    <note>
+        <para>
+            It is important not to confuse such in-memory modifications with saving
+            configuration data out to specific storage media. Tools for creating and modifying
+            configuration data for various storage media are out of scope with respect to
+            <classname>Zend_Config</classname>. Third-party open source solutions are readily
+            available for the purpose of creating and modifying configuration data for various
+            storage media.
+        </para>
+    </note>
+
     <para>
         Adapter classes inherit from the <classname>Zend_Config</classname> class since they utilize
         its functionality.
     </para>
+
     <para>
         The <classname>Zend_Config</classname> family of classes enables configuration data to be
         organized into sections. <classname>Zend_Config</classname> adapter objects may be loaded
         with a single specified section, multiple specified sections, or all sections
         (if none are specified).
     </para>
+
     <para>
         <classname>Zend_Config</classname> adapter classes support a single inheritance model that
         enables configuration data to be inherited from one section of configuration data
         into another. This is provided in order to reduce or eliminate the need for
         duplicating configuration data for different purposes. An inheriting section
         may also override the values that it inherits through its parent section.
-        Like PHP class inheritance, a section may inherit from a parent section,
+        Like <acronym>PHP</acronym> class inheritance, a section may inherit from a parent section,
         which may inherit from a grandparent section, and so on, but multiple inheritance
         (i.e., section C inheriting directly from parent sections A and B) is not supported.
     </para>
+
     <para>
         If you have two <classname>Zend_Config</classname> objects, you can merge them into a single
-        object using the <code>merge()</code> function. For example, given
+        object using the <methodname>merge()</methodname> function. For example, given
         <varname>$config</varname> and <varname>$localConfig</varname>, you can merge data from
         <varname>$localConfig</varname> to <varname>$config</varname> using
-        <code>$config->merge($localConfig);</code>. The items in <varname>$localConfig</varname>
-        will override any items with the same name in <varname>$config</varname>.
-        <note>
-            <para>
-                The <classname>Zend_Config</classname> object that is performing the merge must have
-                been constructed to allow modifications, by passing <constant>TRUE</constant> as the
-                second parameter of the constructor. The <code>setReadOnly()</code> method can then
-                be used to prevent any further modifications after the merge is complete.
-            </para>
-        </note>
+        <methodname>$config->merge($localConfig);</methodname>. The items in
+        <varname>$localConfig</varname> will override any items with the same name in
+        <varname>$config</varname>.
     </para>
+
+    <note>
+        <para>
+            The <classname>Zend_Config</classname> object that is performing the merge must have
+            been constructed to allow modifications, by passing <constant>TRUE</constant> as the
+            second parameter of the constructor. The <methodname>setReadOnly()</methodname>
+            method can then be used to prevent any further modifications after the merge is
+            complete.
+        </para>
+    </note>
 </sect1>
 <!--
 vim:se ts=4 sw=4 et: