[DOCUMENTATION] English: documentation standard

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

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

@@ -152,8 +152,8 @@ resources.locale.force = true
         <title>Configure cache template</title>
 
         <para>
-            When you have set no cache, <classname>Zend_Locale</classname> will set itself a cache 
-            with the file backend by default. But if you want to choose the backend or others 
+            When you have set no cache, <classname>Zend_Locale</classname> will set itself a cache
+            with the file backend by default. But if you want to choose the backend or others
             options, you can use the name of a cache template or an instance of
             <classname>Zend_Cache_Core</classname>.
             For more informations look into <xref linkend="zend.locale.cache" />.

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

@@ -23,11 +23,11 @@
             quick summary of typical options you might provide.
         </para>
 
-        <programlisting language="ini">
+        <programlisting language="ini"><![CDATA[
 resources.useragent.wurflapi.wurfl_api_version = "1.1"
 resources.useragent.wurflapi.wurfl_lib_dir = APPLICATION_PATH "/../library/Wurfl/1.1"
 resources.useragent.wurflapi.wurfl_config_file = APPLICATION_PATH "/../library/Wurfl/1.1/resources/wurfl-config.php"
-</programlisting>
+]]></programlisting>
     </sect3>
 
     <sect3 id="zend.application.available-resources.useragent.options">

documentation/manual/en/module_specs/Zend_Captcha-Adapters.xml

@@ -300,20 +300,20 @@
                     the ReCaptcha service object.
                 </para>
             </listitem>
-            
+
             <listitem>
                 <para>
                     <methodname>isValid($value, $context = null)</methodname> validates the user's
                     input against the ReCaptcha service.  <varname>$value</varname> is an array with the following
-                    keys:  
+                    keys:
                     <itemizedlist>
                         <listitem>
                             <para>
-                                <varname>recaptcha_challenge_field</varname> - Value of the ReCaptcha widget's 
+                                <varname>recaptcha_challenge_field</varname> - Value of the ReCaptcha widget's
                                 challenge field (hidden)
                             </para>
                         </listitem>
-                        <listitem>                        
+                        <listitem>
                             <para>
                                 <varname>recaptcha_response_field</varname> - Value of the ReCaptcha widget's
                                 user input field

documentation/manual/en/module_specs/Zend_Config_Writer.xml

@@ -49,7 +49,6 @@
         </listitem>
     </itemizedlist>
 
-
     <para>
         When modifying or creating a <classname>Zend_Config</classname> object, there are
         some things to know. To create or modify a value, you simply say set

documentation/manual/en/module_specs/Zend_Config_Yaml.xml

@@ -71,7 +71,6 @@ development:
     frontController:
       params:
         displayExceptions: true
-
 ]]></programlisting>
 
         <para>

documentation/manual/en/module_specs/Zend_Form-StandardElements.xml

@@ -253,7 +253,7 @@ $location = $form->foo->getFileName();
                 the file.
             </para>
         </note>
-        
+
         <note>
             <title>Return value of getFileName()</title>
 

documentation/manual/en/module_specs/Zend_Http_UserAgent-Features_DeviceAtlas.xml

@@ -36,10 +36,10 @@
             your application configuration.
         </para>
 
-        <programlisting language="ini">
+        <programlisting language="ini"><![CDATA[
 resources.useragent.deviceatlas.deviceatlas_lib_dir = APPLICATION_PATH "/../library/DeviceAtlas"
 resources.useragent.deviceatlas.deviceatlas_data = APPLICATION_PATH "/../data/DeviceAtlas/json/DeviceAtlas.json
-</programlisting>
+]]></programlisting>
     </sect2>
 
     <sect2 id="zend.http.user-agent-features-device-atlas.options">

documentation/manual/en/module_specs/Zend_Http_UserAgent-Features_TeraWurfl.xml

@@ -31,18 +31,18 @@
             resource.
         </para>
 
-        <programlisting language="ini">
+        <programlisting language="ini"><![CDATA[
 resources.useragent.terawurfl.terawurfl_lib_dir = APPLICATION_PATH "/../library/"
-</programlisting>
+]]></programlisting>
 
         <para>
             If the file is autoloadable, you can also specify an empty configuration in order to
             utilize the adapter.
         </para>
 
-        <programlisting language="ini">
+        <programlisting language="ini"><![CDATA[
 resources.useragent.terawurfl[] =
-</programlisting>
+]]></programlisting>
     </sect2>
 
     <sect2 id="zend.http.user-agent-features-tera-wurfl.options">

documentation/manual/en/module_specs/Zend_Http_UserAgent-Storage_Session.xml

@@ -29,11 +29,11 @@
             <varname>member</varname> options in your configuration.
         </para>
 
-        <programlisting language="ini">
+        <programlisting language="ini"><![CDATA[
 resources.useragent.storage.adapter = "Session"
 resources.useragent.storage.options.browser_type = "all"
 resources.useragent.storage.options.member = "data"
-</programlisting>
+]]></programlisting>
 
         <para>
             Typically, you will not pass the <varname>browser_type</varname> option, and instead let

documentation/manual/en/module_specs/Zend_Http_UserAgent.xml

@@ -133,7 +133,7 @@
             archive will create a <filename>wurfl-php-1.1</filename> directory.
         </para>
 
-        <programlisting language="text">
+        <programlisting language="text"><![CDATA[
 library
 |-- wurfl-php-1.1
 |   |-- COPYING
@@ -142,7 +142,7 @@ library
 |   |-- README
 |   |-- tests
 |   `-- WURFL
-</programlisting>
+]]></programlisting>
 
         <para>
             Next, create a data and cache directory for the <acronym>WURFL</acronym> database and
@@ -173,7 +173,6 @@ cp library/wurfl-php-1.1/tests/resources/web_browsers_patch.xml data/wurfl/
         </para>
 
         <programlisting language="php"><![CDATA[
-<?php
 $resourcesDir            = dirname(__FILE__) . '/../../data/wurfl/';
 
 $wurfl['main-file']      = $resourcesDir  . 'wurfl-latest.zip';
@@ -194,11 +193,11 @@ $configuration['cache']       = $cache;
             <varname>[production]</varname> section:
         </para>
 
-        <programlisting language="ini">
+        <programlisting language="ini"><![CDATA[
 resources.useragent.wurflapi.wurfl_api_version = "1.1"
 resources.useragent.wurflapi.wurfl_lib_dir = APPLICATION_PATH "/../library/wurfl-php-1.1/WURFL/"
 resources.useragent.wurflapi.wurfl_config_file = APPLICATION_PATH "/configs/wurfl-config.php"
-</programlisting>
+]]></programlisting>
 
         <note>
             <para>
@@ -461,10 +460,10 @@ $config = array(
                         library.
                     </para>
 
-                    <programlisting language="ini">
+                    <programlisting language="ini"><![CDATA[
 resources.useragent.bot.device.path = APPLICATION_PATH '/../library/Mobile/Device"
 resources.useragent.bot.device.prefix = "Mobile_Device"
-</programlisting>
+]]></programlisting>
                 </listitem>
             </varlistentry>
 

documentation/manual/en/module_specs/Zend_Log-Factory.xml

@@ -100,7 +100,7 @@ $logger = Zend_Log::factory(array(
             <listitem>
                 <para>
                     The "short" name of a formatter to use with the given log writer; the name of the
-                    formatter minus the leading class prefix/namespace. See the "formatterNamespace" 
+                    formatter minus the leading class prefix/namespace. See the "formatterNamespace"
                     entry below for more details. Examples: "Simple", "Xml".
                 </para>
             </listitem>

documentation/manual/en/module_specs/Zend_Log-Overview.xml

@@ -257,13 +257,15 @@ $logger->setEventItem('pid', getmypid());
             error along as well.
         </para>
 
+        <para>
+            Zend_Log events from PHP errors have the additional fields matching
+            <methodname>handler  ( int $errno  , string $errstr  [, string $errfile  [, int
+                $errline  [, array $errcontext  ]]] )</methodname> from <ulink
+                url="http://us3.php.net/manual/en/function.set-error-handler.php">set_error_handler</ulink>
+        </para>
+
         <table id="zend.log.overview.as-errorHandler.properties.table-1">
-            <title>
-                Zend_Log events from PHP errors have the additional fields matching
-                <methodname>handler  ( int $errno  , string $errstr  [, string $errfile  [, int
-                    $errline  [, array $errcontext  ]]] )</methodname> from <ulink
-                    url="http://us3.php.net/manual/en/function.set-error-handler.php">set_error_handler</ulink>
-            </title>
+            <title>Additional fields for Zend_Log events from PHP errors</title>
 
             <tgroup cols="3">
                 <thead>

documentation/manual/en/module_specs/Zend_Markup-Parsers.xml

@@ -18,7 +18,7 @@
             piece of BBCode for example:
         </para>
 
-        <programlisting><![CDATA[
+        <programlisting language="text"><![CDATA[
 [b]foo[i]bar[/i][/b]baz
 ]]></programlisting>
 
@@ -79,7 +79,7 @@
             Some examples of valid BBCode tags are:
         </para>
 
-        <programlisting><![CDATA[
+        <programlisting language="text"><![CDATA[
 [b]
 [list=1]
 [code file=Zend/Markup.php]
@@ -202,7 +202,7 @@
                 character and bullit-lists using the "*" character. An example of both lists:
             </para>
 
-            <programlisting><![CDATA[
+            <programlisting language="text"><![CDATA[
 # Item 1
 # Item 2
 

documentation/manual/en/module_specs/Zend_Pdf-Drawing.xml

@@ -262,7 +262,6 @@ $pdfPage->setFillColor(Zend_Pdf_Color_Html::color('#990000'))
 ]]></programlisting>
         </example>
 
-
         <para>
             By default, text strings are interpreted using the character encoding method of the
             current locale. if you have a string that uses a different encoding method (such as a

documentation/manual/en/module_specs/Zend_Service_DeveloperGarden.xml

@@ -7,7 +7,7 @@
         <title>Introduction to DeveloperGarden</title>
 
         <para>
-            Developer Garden is the name of Deutsche Telekom’s developer community.
+            Developer Garden is the name of Deutsche Telekom's developer community.
             Developer Garden offers you  access to core services of Deutsche Telekom,
             such as voice connections (Voice Call) or sending text messages (Send SMS)
             via open interfaces (Open <acronym>API</acronym>s). You can access the Developer Garden

documentation/manual/en/module_specs/Zend_Service_LiveDocx.xml

@@ -451,7 +451,6 @@ file_put_contents('document.pdf', $document);
             </para>
         </sect3>
 
-
         <sect3 id="zend.service.livedocx.mailmerge.imagemerge">
 
             <title>Merging image data</title>

documentation/manual/en/module_specs/Zend_Service_WindowsAzure.xml

@@ -7,7 +7,7 @@
         <title>Introduction</title>
 
         <para>
-          Windows Azure is the name for Microsoft’s Software + Services platform, an operating
+          Windows Azure is the name for Microsoft's Software + Services platform, an operating
           system in the cloud providing services for hosting, management, scalable storage with
           support for simple blobs, tables, and queues, as well as a management infrastructure for
           provisioning and geo-distribution of cloud-based services, and a development platform for

documentation/manual/en/module_specs/Zend_Tool-Extending.xml

@@ -887,9 +887,6 @@ class My_Component_HelloProvider
         <!--
         <sect3 id="zend.tool.extending.zend-tool-project.resources-and-contexts">
             <title>Creating Resources &amp; Contexts</title>
-
-
-
         </sect3>
         -->
     </sect2>

documentation/manual/en/module_specs/Zend_Tool_Project-Providers.xml

@@ -76,7 +76,7 @@
                         <command>zf enable test</command>
                     </entry>
                 </row>
-                
+
                 <row>
                     <entry>DbTable</entry>
                     <entry>Create</entry>
@@ -92,7 +92,7 @@
                         <command>zf create db-table.from-database --force-overwrite=true </command>
                     </entry>
                 </row>
-                
+
             </tbody>
         </tgroup>
     </table>

documentation/manual/en/module_specs/Zend_View-Helpers-Doctype.xml

@@ -141,14 +141,14 @@ $doctypeHelper->doctype('XHTML1_RDFA');
 
         <programlisting language="php"><![CDATA[
 <?php echo $this->doctype() ?>
-<html xmlns="http://www.w3.org/1999/xhtml" 
+<html xmlns="http://www.w3.org/1999/xhtml"
       <?php if ($view->doctype()->isRdfa()): ?>
       xmlns:og="http://opengraphprotocol.org/schema/"
       xmlns:fb="http://www.facebook.com/2008/fbml"
       <?php endif; ?>
 >
 ]]></programlisting>
-        
+
     </example>
 </sect3>
 <!--

documentation/manual/en/module_specs/Zend_View-Helpers-HeadStyle.xml

@@ -114,7 +114,7 @@ $this->headStyle()->appendStyle($styles, array('conditional' => 'lt IE 7'));
             By default, Zend Framework uses <acronym>UTF-8</acronym> as its default encoding, and,
             specific to this case, <classname>Zend_View</classname> does as well. Character encoding
             can be set differently on the view object itself using the
-            <methodname>setEncoding()</methodname> method (or the the <varname>encoding</varname>
+            <methodname>setEncoding()</methodname> method (or the <varname>encoding</varname>
             instantiation parameter). However, since <classname>Zend_View_Interface</classname> does
             not define accessors for encoding, it's possible that if you are using a custom view
             implementation with this view helper, you will not have a

documentation/manual/en/module_specs/Zend_View-Helpers-Navigation.xml

@@ -2239,7 +2239,7 @@ echo $this->navigation()
                 By default, Zend Framework uses <acronym>UTF-8</acronym> as its default encoding,
                 and, specific to this case, <classname>Zend_View</classname> does as well. Character
                 encoding can be set differently on the view object itself using the
-                <methodname>setEncoding()</methodname> method (or the the
+                <methodname>setEncoding()</methodname> method (or the
                 <varname>encoding</varname> instantiation parameter). However, since
                 <classname>Zend_View_Interface</classname> does not define accessors for encoding,
                 it's possible that if you are using a custom view implementation with the Dojo view

documentation/manual/en/tutorials/multiuser-authentication.xml

@@ -143,7 +143,7 @@ class AuthController extends Zend_Controller_Action
             $adapter->setIdentity($loginForm->getValue('username'));
             $adapter->setCredential($loginForm->getValue('password'));
 
-            $auth   = Zend_Auth::getInstance(); 
+            $auth   = Zend_Auth::getInstance();
             $result = $auth->authenticate($adapter);
 
             if ($result->isValid()) {