[DOCUMENTATION] English:

- manual fixes

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

documentation/manual/en/module_specs/Zend_Auth_Adapter_Http.xml

@@ -50,7 +50,7 @@
         </itemizedlist>
 
         <para>
-            There are a few notable features of RFC-2617 that are not
+            There are a few notable features of <acronym>RFC-2617</acronym> that are not
             implemented yet:
         </para>
 

documentation/manual/en/module_specs/Zend_Controller-ActionHelpers-ContextSwitch.xml

@@ -258,8 +258,8 @@ $this->_helper->contextSwitch()->setAutoJsonSerialization(false);
             </para></listitem>
 
             <listitem><para>
-                <methodname>hasContext($context)</methodname>: returns <constant>TRUE</constant> if the context
-                exists, <constant>FALSE</constant> otherwise.
+                <methodname>hasContext($context)</methodname>: returns <constant>TRUE</constant> if
+                the context exists, <constant>FALSE</constant> otherwise.
             </para></listitem>
 
             <listitem><para> <methodname>getContext($context)</methodname>: retrieve a
@@ -274,8 +274,8 @@ $this->_helper->contextSwitch()->setAutoJsonSerialization(false);
 
             <listitem><para>
                 <methodname>removeContext($context)</methodname>: remove a single context by
-                name. Returns <constant>TRUE</constant> if successful, <constant>FALSE</constant> if the context was not
-                found.
+                name. Returns <constant>TRUE</constant> if successful, <constant>FALSE</constant>
+                if the context was not found.
             </para></listitem>
 
             <listitem><para>

documentation/manual/en/module_specs/Zend_Controller-ActionHelpers-ViewRenderer.xml

@@ -544,11 +544,11 @@ $viewRenderer =
                 </para>
 
                 <para>
-                    Word delimiters occurring in module, controller, or action
-                    names will be replaced with dashes ('-'). Thus, if you have
-                    the controller name 'foo.bar' and the action 'baz:bat',
-                    using the default path specification will result in a view
-                    script path of '<filename>foo-bar/baz-bat.phtml</filename>'.
+                    Word delimiters occurring in module, controller, or action names will be
+                    replaced with dashes ('-'). Thus, if you have the controller name
+                    '<command>foo.bar</command>' and the action '<command>baz:bat</command>', using
+                    the default path specification will result in a view script path of
+                    '<filename>foo-bar/baz-bat.phtml</filename>'.
                 </para>
 
                 <note>

documentation/manual/en/module_specs/Zend_Controller-Request.xml

@@ -215,7 +215,7 @@ $front->setRequest($request);
                 then be stripped from the beginning of the path before
                 calculating any route matches. This frees one from the necessity
                 of prepending it to any of your routes. A route of
-                <filename>'user/:username'</filename> will match <acronym>URI</acronym>s like
+                <command>'user/:username'</command> will match <acronym>URI</acronym>s like
                 <filename>http://localhost/projects/myapp/user/martel</filename> and
                 <filename>http://example.com/user/martel</filename>.
             </para>

documentation/manual/en/module_specs/Zend_Currency-Migrating.xml

@@ -5,8 +5,8 @@
     <title>Migrating from Previous Versions</title>
 
     <para>
-        The <acronym>API</acronym> of <classname>Zend_Currency</classname> has changed in the past to enhance
-        usability. If you started using <classname>Zend_Currency</classname> with a
+        The <acronym>API</acronym> of <classname>Zend_Currency</classname> has changed in the past
+        to enhance usability. If you started using <classname>Zend_Currency</classname> with a
         version which is mentioned in this chapter follow the guidelines below
         to migrate your scripts to the new <acronym>API</acronym>.
     </para>
@@ -30,62 +30,61 @@ $currency = new Zend_Currency($currency, $locale);
             The <methodname>setFormat()</methodname> method takes now an array of options. These
             options are set permanently and override all previously set values. Also a new option
             'precision' has been added. The following options have been refactored:
-
-            <itemizedlist mark='opencircle'>
-                <listitem>
-                    <para>
-                        <emphasis>position</emphasis>:
-                        Replacement for the old 'rules' parameter.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>
-                        <emphasis>script</emphasis>:
-                        Replacement for the old 'script' parameter.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>
-                        <emphasis>format</emphasis>:
-                        Replacement for the old 'locale' parameter which does not
-                        set new currencies but only the number format.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>
-                        <emphasis>display</emphasis>:
-                        Replacement for the old 'rules' parameter.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>
-                        <emphasis>precision</emphasis>:
-                        New parameter.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>
-                        <emphasis>name</emphasis>:
-                        Replacement for the ole 'rules' parameter. Sets the full
-                        currencies name.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>
-                        <emphasis>currency</emphasis>:
-                        New parameter.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>
-                        <emphasis>symbol</emphasis>:
-                        New parameter.
-                    </para>
-                </listitem>
-            </itemizedlist>
-
         </para>
 
+        <itemizedlist mark='opencircle'>
+            <listitem>
+                <para>
+                    <emphasis>position</emphasis>:
+                    Replacement for the old 'rules' parameter.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>script</emphasis>:
+                    Replacement for the old 'script' parameter.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>format</emphasis>:
+                    Replacement for the old 'locale' parameter which does not
+                    set new currencies but only the number format.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>display</emphasis>:
+                    Replacement for the old 'rules' parameter.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>precision</emphasis>:
+                    New parameter.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>name</emphasis>:
+                    Replacement for the ole 'rules' parameter. Sets the full
+                    currencies name.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>currency</emphasis>:
+                    New parameter.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis>symbol</emphasis>:
+                    New parameter.
+                </para>
+            </listitem>
+        </itemizedlist>
+
         <programlisting language="php"><![CDATA[
 $currency->setFormat(array $options);
 ]]></programlisting>

documentation/manual/en/module_specs/Zend_Currency-Usage.xml

@@ -84,11 +84,11 @@ $currency = new Zend_Currency();
             </para>
             <note>
                 <para>
-                    Note that <classname>Zend_Currency</classname> only accepts locales which include a region. This means
-                    that all locales that only include a language will result in an exception. For
-                    example the locale <emphasis>en</emphasis> will cause an exception to be thrown
-                    whereas the locale <emphasis>en_US</emphasis> will return
-                    <emphasis>USD</emphasis> as currency.
+                    Note that <classname>Zend_Currency</classname> only accepts locales which
+                    include a region. This means that all locales that only include a language will
+                    result in an exception. For example the locale <emphasis>en</emphasis> will
+                    cause an exception to be thrown whereas the locale <emphasis>en_US</emphasis>
+                    will return <acronym>USD</acronym> as currency.
                 </para>
             </note>
         </listitem>
@@ -128,7 +128,7 @@ $currency = new Zend_Currency('en_US', 'EUR');
             currently be in use, with one or more ancient currencies. If the
             '<emphasis>currency</emphasis>' parameter is suppressed the contemporary currency will
             be used. The region '<emphasis>de</emphasis>' for example knows the currencies
-            '<emphasis>EUR</emphasis>' and '<emphasis>DEM</emphasis>'... '<emphasis>EUR</emphasis>'
+            '<acronym>EUR</acronym>' and '<acronym>DEM</acronym>'... '<acronym>EUR</acronym>'
             is the contemporary currency and will be used if the currency parameter is omitted.
         </para>
     </note>
@@ -139,7 +139,7 @@ $currency = new Zend_Currency('en_US', 'EUR');
 
         <para>
             To get a numeric value converted to an output string formatted for the currency at hand,
-            use the method <emphasis>toCurrency()</emphasis>. It takes the value which should be
+            use the method <methodname>toCurrency()</methodname>. It takes the value which should be
             converted. The value itself can be any normalized number.
         </para>
 
@@ -237,10 +237,9 @@ echo $currency->toCurrency(1000, array('script' => 'Arab'));
         </itemizedlist>
 
         <para>
-            So if you need to change the format, you should the
-            <methodname>setFormat()</methodname> method. It takes an array which should include every
-            option you want to change. The <varname>$options</varname> array supports the following
-            settings:
+            So if you need to change the format, you should the <methodname>setFormat()</methodname>
+            method. It takes an array which should include every option you want to change. The
+            <varname>$options</varname> array supports the following settings:
         </para>
 
         <itemizedlist mark='opencircle'>
@@ -415,7 +414,7 @@ echo $currency->toCurrency(1000);
         <itemizedlist mark='opencircle'>
             <listitem>
                 <para>
-                    <emphasis>getSymbol()</emphasis>:
+                    <emphasis><methodname>getSymbol()</methodname></emphasis>:
                 </para>
                 <para>
                     Returns the known symbol of the set currency or a given currency. For example
@@ -425,17 +424,17 @@ echo $currency->toCurrency(1000);
             </listitem>
             <listitem>
                 <para>
-                    <emphasis>getShortName()</emphasis>:
+                    <emphasis><methodname>getShortName()</methodname></emphasis>:
                 </para>
                 <para>
                     Returns the abbreviation of the set currency or a given currency. For example
-                    <emphasis>USD</emphasis> for the US Dollar within the locale
+                    <acronym>USD</acronym> for the US Dollar within the locale
                     '<emphasis>en_US</emphasis>.
                 </para>
             </listitem>
             <listitem>
                 <para>
-                    <emphasis>getName()</emphasis>:
+                    <emphasis><methodname>getName()</methodname></emphasis>:
                 </para>
                 <para>
                     Returns the full name of the set currency of a given currency. For example
@@ -445,7 +444,7 @@ echo $currency->toCurrency(1000);
             </listitem>
             <listitem>
                 <para>
-                    <emphasis>getRegionList()</emphasis>:
+                    <emphasis><methodname>getRegionList()</methodname></emphasis>:
                 </para>
                 <para>
                     Returns a list of regions where the set currency or a given one is known to be
@@ -455,7 +454,7 @@ echo $currency->toCurrency(1000);
             </listitem>
             <listitem>
                 <para>
-                    <emphasis>getCurrencyList()</emphasis>:
+                    <emphasis><methodname>getCurrencyList()</methodname></emphasis>:
                 </para>
                 <para>
                     Returns a list of currencies which are used in the given region.
@@ -468,9 +467,10 @@ echo $currency->toCurrency(1000);
             <methodname>getShortName()</methodname> and <methodname>getName()</methodname> accept
             two optional parameters. If no parameter is given the
             expected data will be returned from the set currency. The first parameter takes the
-            shortname of a currency. Short names are always three lettered, for example EUR for euro
-            or USD for US Dollar. The second parameter defines from which locale the data should be
-            read. If no locale is given, the set locale is used.
+            shortname of a currency. Short names are always three lettered, for example
+            <acronym>EUR</acronym> for euro or <acronym>USD</acronym> for US Dollar. The second
+            parameter defines from which locale the data should be read. If no locale is given, the
+            set locale is used.
         </para>
 
         <example id="zend.currency.usage.informational.example">
@@ -540,9 +540,10 @@ print $currency->toCurrency(1000);
             <classname>Zend_Cache</classname>. The static method
             <methodname>Zend_Currency::setCache($cache)</methodname> accepts one option: a
             <classname>Zend_Cache</classname> adapter. If the cache adapter is set, the localization
-            data that <classname>Zend_Currency</classname> uses are cached. There are some static methods for manipulating
-            the cache: <methodname>getCache()</methodname>, <methodname>hasCache()</methodname>,
-            <methodname>clearCache()</methodname> and <methodname>removeCache()</methodname>.
+            data that <classname>Zend_Currency</classname> uses are cached. There are some static
+            methods for manipulating the cache: <methodname>getCache()</methodname>,
+            <methodname>hasCache()</methodname>, <methodname>clearCache()</methodname> and
+            <methodname>removeCache()</methodname>.
         </para>
 
         <example id="zend.currency.usage.cache.example">

documentation/manual/en/module_specs/Zend_Date-Basic.xml

@@ -28,8 +28,9 @@
 
         <para>
             Without any arguments, constructing an instance returns an object in the default locale
-            with the current, local date using <acronym>PHP</acronym>'s <methodname>time()</methodname> function to
-            obtain the <ulink url="http://en.wikipedia.org/wiki/Unix_Time">UNIX timestamp</ulink>
+            with the current, local date using <acronym>PHP</acronym>'s
+            <methodname>time()</methodname> function to obtain the <ulink
+                url="http://en.wikipedia.org/wiki/Unix_Time">UNIX timestamp</ulink>
             for the object. Make sure your <acronym>PHP</acronym> environment has the correct
             <link linkend="zend.date.setdefaulttimezone">default timezone</link>
             .