Browse Source

[MANUAL] English:

- several manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22755 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 15 years ago
parent
commit
1d8e2466b6

+ 18 - 18
documentation/manual/en/module_specs/Zend_Locale-Functions.xml

@@ -16,7 +16,7 @@
             Use <ulink url="http://php.net/language.oop5.cloning">object cloning</ulink> to
             duplicate a locale object exactly and efficiently. Most locale-aware methods also accept
             string representations of locales, such as the result of
-            <code>$locale->toString()</code>.
+            <command>$locale->toString()</command>.
         </para>
 
         <example id="zend.locale.copying.example-1">
@@ -77,10 +77,10 @@ if ($locale->equals($mylocale)) {
             for <classname>Zend_Locale</classname>, the first parameter selects a preference of
             which information to consider <link
                 linkend="zend.locale.selection">(<constant>BROWSER</constant>,
-                <constant>ENVIRONMENT</constant>, or <code>FRAMEWORK)</code></link> first. The
-            second parameter toggles between returning all matching locales or only the first/best
-            match. Locale-aware components normally use only the first locale. A quality rating is
-            included, when available.
+                <constant>ENVIRONMENT</constant>, or <constant>FRAMEWORK</constant></link> first.
+            The second parameter toggles between returning all matching locales or only the
+            first or best match. Locale-aware components normally use only the first locale. A
+            quality rating is included, when available.
         </para>
 
         <example id="zend.locale.getdefault.example-1">
@@ -1031,11 +1031,11 @@ print Zend_Locale::getTranslation('de', 'language', 'zh');
                             month as integer value. It has to be between 1 and 12. If you want to
                             receive data for other calendars, contexts or formats, then you must
                             give an array instead of an integer with the expected values. The array
-                            has to look like this:
-                            <code>array( 'calendar', 'context', 'format', 'month number')</code>. If
-                            you give only an integer then the default values are the 'gregorian'
-                            calendar, the context 'format' and the format 'wide'. Use
-                            <link linkend="zend.date.introduction">Zend_Date</link> for simplicity
+                            has to look like this: <command>array( 'calendar', 'context', 'format',
+                                'month number')</command>. If you give only an integer then the
+                            default values are the 'gregorian' calendar, the context 'format' and
+                            the format 'wide'. Use <link
+                                linkend="zend.date.introduction">Zend_Date</link> for simplicity
                         </entry>
                     </row>
 
@@ -1727,9 +1727,9 @@ echo Zend_Locale::getLanguageTranslation($frenchCode, 'de_AT');
             Similarly, <methodname>getCountryTranslationList()</methodname> and
             <methodname>getCountryTranslation()</methodname> could be used to create a table mapping
             your native language names for regions to the names of the regions shown in another
-            language. Use a <code>try .. catch</code> block to handle exceptions that occur when
-            using a locale that does not exist. Not all languages are also locales. In the example,
-            below exceptions are ignored to prevent early termination.
+            language. Use a <command>try .. catch</command> block to handle exceptions that occur
+            when using a locale that does not exist. Not all languages are also locales. In the
+            example, below exceptions are ignored to prevent early termination.
         </para>
 
         <example id="zend.locale.getdata.example-6">
@@ -1888,16 +1888,16 @@ if (Zend_Locale::isLocale($input)) {
         <para>
             You should also note that any given locale string will automatically be degraded if the
             region part does not exist for this locale. In our previous example the language
-            <code>'to'</code> does not exist in the region <code>'RU'</code>, but you will still get
-            <constant>TRUE</constant> returned as <classname>Zend_Locale</classname> can work with
-            the given input.
+            '<property>to</property>' does not exist in the region '<property>RU</property>', but
+            you will still get <constant>TRUE</constant> returned as
+            <classname>Zend_Locale</classname> can work with the given input.
         </para>
 
         <para>
             Still it's sometimes useful to prevent this automatic degrading, and this is where the
             second parameter of <methodname>isLocale()</methodname> comes in place. The
-            <code>strict</code> parameter defaults to <constant>FALSE</constant> and can be used to
-            prevent degrading when set to <constant>TRUE</constant>.
+            <property>strict</property> parameter defaults to <constant>FALSE</constant> and can be
+            used to prevent degrading when set to <constant>TRUE</constant>.
         </para>
 
         <example id="zend.locale.detection.example-2">

+ 28 - 34
documentation/manual/en/module_specs/Zend_Locale-Introduction.xml

@@ -22,9 +22,9 @@
         and date conventions, etc. Localization involves adding explicit support to systems for
         special needs of these unique groups, such as language translation, and support for local
         customs or conventions for communicating plurals, dates, times, currencies, names, symbols,
-        sorting and ordering, etc. <code>L10n</code> and <code>I18n</code> compliment each other.
-        Zend Framework provides support for these through a combination of components, including
-        <classname>Zend_Locale</classname>, <classname>Zend_Date</classname>,
+        sorting and ordering, etc. <emphasis>L10n</emphasis> and <emphasis>I18n</emphasis>
+        compliment each other. Zend Framework provides support for these through a combination of
+        components, including <classname>Zend_Locale</classname>, <classname>Zend_Date</classname>,
         <classname>Zend_Measure</classname>, <classname>Zend_Translate</classname>,
         <classname>Zend_Currency</classname>, and <classname>Zend_TimeSync</classname>.
     </para>
@@ -105,12 +105,6 @@
                         <acronym>CLDR</acronym></ulink>.
                 </para>
             </listitem>
-
-            <listitem>
-                <para>
-                    <code>TODO</code> - Localization of collations
-                </para>
-            </listitem>
         </itemizedlist>
     </sect2>
 
@@ -121,8 +115,8 @@
             Each computer user makes use of Locales, even when they don't know it. Applications
             lacking localization support, normally have implicit support for one particular locale
             (the locale of the author). When a class or function makes use of localization, we say
-            it is <code>locale-aware</code>. How does the code know which localization the user is
-            expecting?
+            it is <emphasis>locale-aware</emphasis>. How does the code know which localization the
+            user is expecting?
         </para>
 
         <para>
@@ -140,9 +134,9 @@
             Locale identifiers consist of information about the user's language and
             preferred/primary geographic region (e.g. state or province of home or workplace). The
             locale identifier strings used in Zend Framework are internationally defined standard
-            abbreviations of language and region, written as <code>language_REGION</code>. Both the
-            language and region parts are abbreviated to alphabetic, <acronym>ASCII</acronym>
-            characters.
+            abbreviations of language and region, written as <emphasis>language_REGION</emphasis>.
+            Both the language and region parts are abbreviated to alphabetic,
+            <acronym>ASCII</acronym> characters.
         </para>
 
         <note>
@@ -157,9 +151,9 @@
         </note>
 
         <para>
-            A user from USA would expect the language <code>English</code> and the region
+            A user from USA would expect the language English and the region
             <constant>USA</constant>, yielding the locale identifier "en_US". A user in Germany
-            would expect the language <code>German</code> and the region <code>Germany</code>,
+            would expect the language German and the region Germany,
             yielding the locale identifier "de_DE". See the <ulink
                 url="http://unicode.org/cldr/data/diff/supplemental/languages_and_territories.html">list
                 of pre-defined locale and region combinations</ulink>, if you need to select a
@@ -175,7 +169,7 @@ $locale = new Zend_Locale('de_DE'); // German language _ Germany
         </example>
 
         <para>
-            A German user in America might expect the language <code>German</code> and the region
+            A German user in America might expect the language German and the region
             <constant>USA</constant>, but these non-standard mixes are not supported directly as
             recognized "locales". Instead, if an invalid combination is used, then it will
             automatically be truncated by dropping the region code. For example, "de_IS" would be
@@ -205,9 +199,9 @@ $locale = new Zend_Locale('de_DE'); // German language _ Germany
         <title>Selecting the Right Locale</title>
 
         <para>
-            For most situations, <code>new Zend_Locale()</code> will automatically select the
+            For most situations, <command>new Zend_Locale()</command> will automatically select the
             correct locale, with preference given to information provided by the user's web browser.
-            However, if <code>new Zend_Locale(Zend_Locale::ENVIRONMENT)</code> is used, then
+            However, if <command>new Zend_Locale(Zend_Locale::ENVIRONMENT)</command> is used, then
             preference will be given to using the host server's environment configuration, as
             described below.
         </para>
@@ -288,9 +282,9 @@ $locale3 = new Zend_Locale(Zend_Locale::FRAMEWORK);
             <orderedlist>
                 <listitem>
                     <para>
-                        <code>'browser'</code> - <classname>Zend_Locale</classname> should work with
-                        the information which is provided by the user's Web browser. It is published
-                        by <acronym>PHP</acronym> in the global variable
+                        '<property>browser</property>' - <classname>Zend_Locale</classname> should
+                        work with the information which is provided by the user's Web browser. It
+                        is published by <acronym>PHP</acronym> in the global variable
                         <constant>$_SERVER['HTTP_ACCEPT_LANGUAGE']</constant>.
                     </para>
 
@@ -298,30 +292,30 @@ $locale3 = new Zend_Locale(Zend_Locale::FRAMEWORK);
                         If a user provides more than one locale within his browser,
                         <classname>Zend_Locale</classname> will use the first found locale. If the
                         user does not provide a locale or the script is being called from the
-                        command line the automatic locale <code>'environment'</code> will
+                        command line the automatic locale '<property>environment</property>' will
                         automatically be used and returned.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>'environment'</code> - <classname>Zend_Locale</classname> should work
-                        with the information which is provided by the host server. It is published
-                        by <acronym>PHP</acronym> via the internal function
+                        '<property>environment</property>' - <classname>Zend_Locale</classname>
+                        should work with the information which is provided by the host server. It
+                        is published by <acronym>PHP</acronym> via the internal function
                         <methodname>setlocale()</methodname>.
                     </para>
 
                     <para>
                         If a environment provides more than one locale,
                         <classname>Zend_Locale</classname> will use the first found locale. If the
-                        host does not provide a locale the automatic locale <code>'browser'</code>
-                        will automatically be used and returned.
+                        host does not provide a locale the automatic locale
+                        '<property>browser</property>' will automatically be used and returned.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
-                        <code>'auto'</code> - <classname>Zend_Locale</classname> should
+                        '<property>auto</property>' - <classname>Zend_Locale</classname> should
                         automatically detect any locale which can be worked with. It will first
                         search for a users locale and then, if not successful, search for the host
                         locale.
@@ -532,10 +526,10 @@ Zend_Locale_Format::setOptions(array('locale' => 'en_US',
         <para>
             For working with the standard definitions of a locale the option
             <constant>Zend_Locale_Format::STANDARD</constant> can be used. Setting the option
-            <constant>Zend_Locale_Format::STANDARD</constant> for <code>date_format</code> uses the
-            standard definitions from the actual set locale. Setting it for number_format uses the
-            standard number format for this locale. And setting it for locale uses the standard
-            locale for this environment or browser.
+            <constant>Zend_Locale_Format::STANDARD</constant> for <property>date_format</property>
+            uses the standard definitions from the actual set locale. Setting it for
+            <property>number_format</property> uses the standard number format for this locale.
+            And setting it for locale uses the standard locale for this environment or browser.
         </para>
 
         <example id="zend.locale.formatoptions.example-2">
@@ -564,7 +558,7 @@ Zend_Locale_Format::setOptions(array('locale' => Zend_Locale_Format::STANDARD,
             <classname>Zend_Cache</classname>. Use the static method
             <methodname>Zend_Locale::setCache($cache)</methodname> if you are using
             <classname>Zend_Locale</classname>. <classname>Zend_Locale_Format</classname> can be
-            speeded up the using the option <code>cache</code> within
+            speeded up the using the option <property>cache</property> within
             <classname>Zend_Locale_Format::setOptions(array('cache' => $adapter));</classname>.
             If you are using both classes you should only set the cache for
             <classname>Zend_Locale</classname>, otherwise the last set cache will overwrite the

+ 9 - 9
documentation/manual/en/module_specs/Zend_Locale-Parsing.xml

@@ -67,26 +67,26 @@ print $number; // will return 13524.678
                 Since <methodname>getNumber($value, array $options = array())</methodname> can
                 normalize extremely large numbers, check the result carefully before using finite
                 precision calculations, such as ordinary <acronym>PHP</acronym> math operations. For
-                example, <code>if ((string)int_val($number) != $number) { use <ulink
+                example, <command>if ((string)int_val($number) != $number) {</command> use <ulink
                     url="http://www.php.net/bc">BCMath</ulink> or <ulink
-                    url="http://www.php.net/gmp">GMP</ulink></code>. Most <acronym>PHP</acronym>
+                    url="http://www.php.net/gmp">GMP</ulink>. Most <acronym>PHP</acronym>
                 installations support the BCMath extension.
             </para>
 
             <para>
                 Also, the precision of the resulting decimal representation can be rounded to a
                 desired length with <methodname>getNumber()</methodname> with the option
-                <code>'precision'</code>. If no precision is given, no rounding occurs. Use only
-                <acronym>PHP</acronym> integers to specify the precision.
+                '<property>precision</property>'. If no precision is given, no rounding occurs. Use
+                only <acronym>PHP</acronym> integers to specify the precision.
             </para>
 
             <para>
                 If the resulting decimal representation should be truncated to a desired length
-                instead of rounded the option <code>'number_format'</code> can be used instead.
-                Define the length of the decimal representation with the desired length of zeros.
-                The result will then not be rounded. So if the defined precision within
-                <code>number_format</code> is zero the value "1.6" will return "1", not "2. See the
-                example nearby:
+                instead of rounded the option '<property>number_format</property>' can be used
+                instead. Define the length of the decimal representation with the desired length
+                of zeros. The result will then not be rounded. So if the defined precision within
+                <property>number_format</property> is zero the value "1.6" will return "1", not "2.
+                See the example nearby:
             </para>
 
             <example id="zend.locale.number.normalize.precision.example-1">

+ 4 - 4
documentation/manual/en/module_specs/Zend_Log-Formatters.xml

@@ -4,7 +4,7 @@
     <title>Formatters</title>
 
     <para>
-        A Formatter is an object that is responsible for taking an <code>event</code> array
+        A Formatter is an object that is responsible for taking an <property>event</property> array
         describing a log event and outputting a string with a formatted log line.
     </para>
 
@@ -50,7 +50,7 @@ $logger->info('there');
         <para>
             The constructor of <classname>Zend_Log_Formatter_Simple</classname> accepts a single
             parameter: the format string. This string contains keys surrounded by
-            percent signs (e.g. <code>%message%</code>). The format string may
+            percent signs (e.g. <command>%message%</command>). The format string may
             contain any key from the event data array.
             You can retrieve the default keys by using the DEFAULT_FORMAT constant from
             <classname>Zend_Log_Formatter_Simple</classname>.
@@ -114,8 +114,8 @@ $logger->info('informational message');
 
         <para>
             The code above changes the root element from its default of
-            <code>logEntry</code> to <code>log</code>. It also maps the element
-            <code>msg</code> to the event data item <code>message</code>. This
+            <property>logEntry</property> to <property>log</property>. It also maps the element
+            <property>msg</property> to the event data item <property>message</property>. This
             results in the following output:
         </para>