Browse Source

[DOCUMENTATION] English:

-  manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@15981 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 years ago
parent
commit
36f9c5f6d3
1 changed files with 36 additions and 23 deletions
  1. 36 23
      documentation/manual/en/module_specs/Zend_Config_Ini.xml

+ 36 - 23
documentation/manual/en/module_specs/Zend_Config_Ini.xml

@@ -2,55 +2,65 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.config.adapters.ini">
     <title>Zend_Config_Ini</title>
+
     <para>
         <classname>Zend_Config_Ini</classname> enables developers to store configuration data in a
-        familiar INI format and read them in the application by using nested object property syntax.
-        The INI format is specialized to provide both the ability to have a hierarchy of
-        configuration data keys and inheritance between configuration data sections. Configuration
-        data hierarchies are supported by separating the keys with the dot or period character
-        ("<emphasis>.</emphasis>"). A section may extend or inherit from another section by
-        following the section name with a colon character ("<emphasis>:</emphasis>) and the name of
-        the section from which data are to be inherited.
+        familiar <acronym>INI</acronym> format and read them in the application by using nested
+        object property syntax. The <acronym>INI</acronym> format is specialized to provide both
+        the ability to have a hierarchy of configuration data keys and inheritance between
+        configuration data sections. Configuration data hierarchies are supported by separating the
+        keys with the dot or period character ("<emphasis>.</emphasis>"). A section may extend or
+        inherit from another section by following the section name with a colon character
+        ("<emphasis>:</emphasis>) and the name of the section from which data are to be inherited.
     </para>
+
     <note>
         <title>Parsing the INI File</title>
+
         <para>
             <classname>Zend_Config_Ini</classname> utilizes the <ulink
                 url="http://php.net/parse_ini_file"><methodname>parse_ini_file()</methodname></ulink>
-            PHP function. Please review this documentation to be aware of its specific behaviors,
-            which propagate to <classname>Zend_Config_Ini</classname>, such as how the special
-            values of "<constant>TRUE</constant>", "<constant>FALSE</constant>", "yes", "no",
-            and "<constant>NULL</constant>" are handled.
+            <acronym>PHP</acronym> function. Please review this documentation to be aware of its
+            specific behaviors, which propagate to <classname>Zend_Config_Ini</classname>, such as
+            how the special values of "<constant>TRUE</constant>", "<constant>FALSE</constant>",
+            "yes", "no", and "<constant>NULL</constant>" are handled.
         </para>
     </note>
+
     <note>
         <title>Key Separator</title>
+
         <para>
             By default, the key separator character is the period character
             ("<emphasis>.</emphasis>"). This can be changed, however, by changing the
             <varname>$options</varname> key <emphasis>'nestSeparator'</emphasis> when constructing
             the <classname>Zend_Config_Ini</classname> object. For example:
-            <programlisting language="php"><![CDATA[
+        </para>
+
+        <programlisting language="php"><![CDATA[
 $options['nestSeparator'] = ':';
 $config = new Zend_Config_Ini('/path/to/config.ini',
                               'staging',
                               $options);
 ]]></programlisting>
-        </para>
+
     </note>
+
     <example id="zend.config.adapters.ini.example.using">
         <title>Using Zend_Config_Ini</title>
+
         <para>
             This example illustrates a basic use of <classname>Zend_Config_Ini</classname> for
-            loading configuration data from an INI file. In this example there are configuration
-            data for both a production system and for a staging system. Because the staging system
-            configuration data are very similar to those for production, the staging section
-            inherits from the production section. In this case, the decision is arbitrary and could
-            have been written conversely, with the production section inheriting from the staging
-            section, though this may not be the case for more complex situations. Suppose, then,
-            that the following configuration data are contained in
+            loading configuration data from an <acronym>INI</acronym> file. In this example there
+            are configuration data for both a production system and for a staging system. Because
+            the staging system configuration data are very similar to those for production, the
+            staging section inherits from the production section. In this case, the decision is
+            arbitrary and could have been written conversely, with the production section
+            inheriting from the staging section, though this may not be the case for more complex
+            situations. Suppose, then, that the following configuration data are contained in
             <filename>/path/to/config.ini</filename>:
         </para>
+
         <programlisting language="ini"><![CDATA[
 ; Production site configuration data
 [production]
@@ -68,11 +78,13 @@ database.params.host     = dev.example.com
 database.params.username = devuser
 database.params.password = devsecret
 ]]></programlisting>
+
         <para>
             Next, assume that the application developer needs the staging configuration data from
-            the INI file. It is a simple matter to load these data by specifying the INI file and
-            the staging section:
+            the <acronym>INI</acronym> file. It is a simple matter to load these data by specifying
+            the <acronym>INI</acronym> file and the staging section:
         </para>
+
         <programlisting language="php"><![CDATA[
 $config = new Zend_Config_Ini('/path/to/config.ini', 'staging');
 
@@ -80,6 +92,7 @@ echo $config->database->params->host;   // prints "dev.example.com"
 echo $config->database->params->dbname; // prints "dbname"
 ]]></programlisting>
     </example>
+
     <note>
     <table id="zend.config.adapters.ini.table">
         <title>Zend_Config_Ini Constructor Parameters</title>
@@ -93,7 +106,7 @@ echo $config->database->params->dbname; // prints "dbname"
             <tbody>
                 <row>
                     <entry><varname>$filename</varname></entry>
-                    <entry>The INI file to load.</entry>
+                    <entry>The <acronym>INI</acronym> file to load.</entry>
                 </row>
                 <row>
                     <entry><varname>$section</varname></entry>