[MANUAL] English:

- manual fixes

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

documentation/manual/en/module_specs/Zend_Validate-Set.xml

@@ -38,8 +38,8 @@
         <title>Barcode</title>
         <para>
             This validator is instantiated with a barcode type against which you wish to validate a
-            barcode value. It currently supports "<code>UPC-A</code>" (Universal Product Code) and
-            "<code>EAN-13</code>" (European Article Number) barcode types, and the
+            barcode value. It currently supports "UPC-A" (Universal Product Code) and
+            "EAN-13" (European Article Number) barcode types, and the
             <methodname>isValid()</methodname> method returns true if and only if the input successfully
             validates against the barcode validation algorithm. You should remove all characters
             other than the digits zero through nine (0-9) from the input value before passing it on
@@ -79,11 +79,11 @@
     <sect2 id="zend.validate.set.date">
         <title>Date</title>
         <para>
-            Returns <constant>TRUE</constant> if <varname>$value</varname> is a valid date of the format
-            <code>YYYY-MM-DD</code>. If the optional <code>locale</code> option is set then the date
-            will be validated according to the set locale. And if the optional <code>format</code>
-            option is set this format is used for the validation. for details about the optional
-            parameters see <link
+            Returns <constant>TRUE</constant> if <varname>$value</varname> is a valid date of the
+            format 'YYYY-MM-DD'. If the optional <property>locale</property> option is set then the
+            date will be validated according to the set locale. And if the optional
+            <property>format</property> option is set this format is used for the validation. for
+            details about the optional parameters see <link
                 linkend="zend.date.others.comparison.table">Zend_Date::isDate()</link>.
         </para>
     </sect2>
@@ -220,14 +220,14 @@ if ($validator->isValid($iban)) {
     <sect2 id="zend.validate.set.string_length">
         <title>StringLength</title>
         <para>
-            Returns <constant>TRUE</constant> if and only if the string length of <varname>$value</varname> is at
-            least a minimum and no greater than a maximum (when the max option is not
-            <constant>NULL</constant>). The <methodname>setMin()</methodname> method throws an exception if the minimum
-            length is set to a value greater than the set maximum length, and the
-            <methodname>setMax()</methodname> method throws an exception if the maximum length is set to a
-            value less than the set minimum length. This class supports UTF-8 and other
-            character encodings, based on the current value of <ulink
-                url="http://www.php.net/manual/en/ref.iconv.php#iconv.configuration"><code>iconv.internal_encoding</code></ulink>.
+            Returns <constant>TRUE</constant> if and only if the string length of
+            <varname>$value</varname> is at least a minimum and no greater than a maximum (when the
+            max option is not <constant>NULL</constant>). The <methodname>setMin()</methodname>
+            method throws an exception if the minimum length is set to a value greater than the set
+            maximum length, and the <methodname>setMax()</methodname> method throws an exception if
+            the maximum length is set to a value less than the set minimum length. This class
+            supports UTF-8 and other character encodings, based on the current value of <ulink
+                url="http://www.php.net/manual/en/ref.iconv.php#iconv.configuration">iconv.internal_encoding</ulink>.
             If you need a different encoding you can set it with the accessor methods getEncoding
             and setEncoding.
         </para>

documentation/manual/en/module_specs/Zend_Validate-WritingValidators.xml

@@ -83,12 +83,12 @@ class MyValid_Float extends Zend_Validate_Abstract
 
         <para>
             The class defines a template for its single validation failure message, which includes
-            the built-in magic parameter, <code>%value%</code>. The call to <methodname>_setValue()</methodname>
-            prepares the object to insert the tested value into the failure message automatically,
-            should the value fail validation. The call to <methodname>_error()</methodname> tracks a reason for
-            validation failure. Since this class only defines one failure message, it is not
-            necessary to provide <methodname>_error()</methodname> with the name of the failure message
-            template.
+            the built-in magic parameter, <emphasis>%value%</emphasis>. The call to
+            <methodname>_setValue()</methodname> prepares the object to insert the tested value into
+            the failure message automatically, should the value fail validation. The call to
+            <methodname>_error()</methodname> tracks a reason for validation failure. Since this
+            class only defines one failure message, it is not necessary to provide
+            <methodname>_error()</methodname> with the name of the failure message template.
         </para>
 
     </example>
@@ -169,8 +169,9 @@ class MyValid_NumericBetween extends Zend_Validate_Abstract
             The public properties <varname>$minimum</varname> and <varname>$maximum</varname> have been
             established to provide the minimum and maximum boundaries, respectively, for a value to
             successfully validate. The class also defines two message variables that correspond to
-            the public properties and allow <code>min</code> and <code>max</code> to be used in
-            message templates as magic parameters, just as with <code>value</code>.
+            the public properties and allow <property>min</property> and <property>max</property> to
+            be used in message templates as magic parameters, just as with
+            <property>value</property>.
         </para>
 
         <para>
@@ -264,7 +265,7 @@ class MyValid_PasswordStrength extends Zend_Validate_Abstract
             Note that the four criteria tests in <methodname>isValid()</methodname> do not immediately return
             <constant>FALSE</constant>. This allows the validation class to provide <emphasis>all</emphasis>
             of the reasons that the input password failed to meet the validation requirements. if,
-            for example, a user were to input the string "<code>#$%</code>" as a password,
+            for example, a user were to input the string "#$%" as a password,
             <methodname>isValid()</methodname> would cause all four validation failure messages to be returned
             by a subsequent call to <methodname>getMessages()</methodname>.
         </para>

documentation/manual/en/module_specs/Zend_Validate.xml

@@ -53,7 +53,7 @@
             array values are the corresponding human-readable string messages.
             The keys and values are class-dependent; each validation class
             defines its own set of validation failure messages and the unique
-            keys that identify them. Each class also has a <code>const</code>
+            keys that identify them. Each class also has a const
             definition that matches each identifier for a validation failure
             cause.
         </para>
@@ -101,10 +101,10 @@ if ($validator->isValid($email)) {
             first argument of this method is a string containing the error
             message. You can include tokens in this string which will be
             substituted with data relevant to the validator. The token
-            <code>%value%</code> is supported by all validators; this is
+            <emphasis>%value%</emphasis> is supported by all validators; this is
             substituted with the value you passed to <methodname>isValid()</methodname>.
             Other tokens may be supported on a case-by-case basis in each
-            validation class. For example, <code>%max%</code> is a token
+            validation class. For example, <emphasis>%max%</emphasis> is a token
             supported by <classname>Zend_Validate_LessThan</classname>.
             The <methodname>getMessageVariables()</methodname> method returns an array
             of variable tokens supported by the validator.
@@ -160,7 +160,7 @@ $validator->setMessages( array(
             If your application requires even greater flexibility with which it
             reports validation failures, you can access properties by the same
             name as the message tokens supported by a given validation class.
-            The <code>value</code> property is always available in a validator;
+            The <property>value</property> property is always available in a validator;
             it is the value you specified as the argument of
             <methodname>isValid()</methodname>. Other properties may be supported on a
             case-by-case basis in each validation class.

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

@@ -43,13 +43,13 @@
 
     <para>
         To use a helper in your view script, call it using
-        <code>$this->helperName()</code>. Behind the scenes,
+        <command>$this->helperName()</command>. Behind the scenes,
         <classname>Zend_View</classname> will load the
         <classname>Zend_View_Helper_HelperName</classname> class, create an object
         instance of it, and call its <methodname>helperName()</methodname> method. The
         object instance is persistent within the <classname>Zend_View</classname>
         instance, and is reused for all future calls to
-        <code>$this->helperName()</code>.
+        <command>$this->helperName()</command>.
     </para>
 
     <sect2 id="zend.view.helpers.initial">
@@ -66,7 +66,7 @@
         <itemizedlist>
 
             <listitem><para>
-                <code>declareVars():</code> Primarily for use when using
+                <methodname>declareVars()</methodname>: Primarily for use when using
                 <methodname>strictVars()</methodname>, this helper can be used to declare
                 template variables that may or may not already be set in the
                 view object, as well as to set default values. Arrays passed as
@@ -76,7 +76,7 @@
             </para></listitem>
 
             <listitem><para>
-                <code>fieldset($name, $content, $attribs):</code> Creates an
+                <methodname>fieldset($name, $content, $attribs)</methodname>: Creates an
                 <acronym>XHTML</acronym> fieldset. If <varname>$attribs</varname> contains a
                 'legend' key, that value will be used for the fieldset legend. The
                 fieldset will surround the <varname>$content</varname> as provided to
@@ -84,24 +84,24 @@
             </para></listitem>
 
             <listitem><para>
-                <code>form($name, $attribs, $content):</code> Generates an <acronym>XHTML</acronym>
-                form. All <varname>$attribs</varname> are escaped and rendered as
-                <acronym>XHTML</acronym> attributes of the form tag. If <varname>$content</varname>
-                is present and not a boolean false, then that content is rendered
-                within the start and close form tags; if <varname>$content</varname>
+                <methodname>form($name, $attribs, $content)</methodname>: Generates an
+                <acronym>XHTML</acronym> form. All <varname>$attribs</varname> are escaped and
+                rendered as <acronym>XHTML</acronym> attributes of the form tag. If
+                <varname>$content</varname> is present and not a boolean false, then that content is
+                rendered within the start and close form tags; if <varname>$content</varname>
                 is a boolean false (the default), only the opening form tag is
                 generated.
             </para></listitem>
 
             <listitem><para>
-                <code>formButton($name, $value, $attribs):</code> Creates an
+                <methodname>formButton($name, $value, $attribs)</methodname>: Creates an
                 &lt;button /&gt; element.
             </para></listitem>
 
             <listitem>
                 <para>
-                    <code>formCheckbox($name, $value, $attribs,
-                        $options):</code> Creates an &lt;input type="checkbox"
+                    <methodname>formCheckbox($name, $value, $attribs,
+                        $options)</methodname>: Creates an &lt;input type="checkbox"
                     /&gt; element.
                 </para>
 
@@ -178,7 +178,7 @@ echo $this->formCheckbox('foo',
 
             <listitem>
                 <para>
-                    <code>formErrors($errors, $options):</code> Generates an
+                    <methodname>formErrors($errors, $options)</methodname>: Generates an
                     <acronym>XHTML</acronym> unordered list to show errors.
                     <varname>$errors</varname> should be a string or an array of strings;
                     <varname>$options</varname> should be any attributes you want
@@ -212,26 +212,26 @@ echo $this->formCheckbox('foo',
             </listitem>
 
             <listitem><para>
-                <code>formFile($name, $attribs):</code> Creates an
+                <methodname>formFile($name, $attribs)</methodname>: Creates an
                 &lt;input type="file" /&gt; element.
             </para></listitem>
 
             <listitem><para>
-                <code>formHidden($name, $value, $attribs):</code> Creates an
+                <methodname>formHidden($name, $value, $attribs)</methodname>: Creates an
                 &lt;input type="hidden" /&gt; element.
             </para></listitem>
 
             <listitem><para>
-                <code>formLabel($name, $value, $attribs):</code> Creates a
-                &lt;label&gt; element, setting the <code>for</code> attribute to
+                <methodname>formLabel($name, $value, $attribs)</methodname>: Creates a
+                &lt;label&gt; element, setting the <property>for</property> attribute to
                 <varname>$name</varname>, and the actual label text to
-                <varname>$value</varname>. If <code>disable</code> is passed in
-                <code>attribs</code>, nothing will be returned.
+                <varname>$value</varname>. If <emphasis>disable</emphasis> is passed in
+                <property>attribs</property>, nothing will be returned.
             </para></listitem>
 
             <listitem><para>
-                <code>formMultiCheckbox($name, $value, $attribs, $options,
-                    $listsep):</code> Creates a list of checkboxes.
+                <methodname>formMultiCheckbox($name, $value, $attribs, $options,
+                    $listsep)</methodname>: Creates a list of checkboxes.
                 <varname>$options</varname> should be an associative array, and may be
                 arbitrarily deep. <varname>$value</varname> may be a single value or
                 an array of selected values that match the keys in the
@@ -242,12 +242,12 @@ echo $this->formCheckbox('foo',
             </para></listitem>
 
             <listitem><para>
-                <code>formPassword($name, $value, $attribs):</code> Creates an
+                <methodname>formPassword($name, $value, $attribs)</methodname>: Creates an
                 &lt;input type="password" /&gt; element.
             </para></listitem>
 
             <listitem><para>
-                <code>formRadio($name, $value, $attribs, $options):</code>
+                <methodname>formRadio($name, $value, $attribs, $options)</methodname>:
                 Creates a series of &lt;input type="radio" /&gt; elements, one
                 for each of the $options elements. In the $options array, the
                 element key is the radio value, and the element value is the
@@ -255,12 +255,12 @@ echo $this->formCheckbox('foo',
             </para></listitem>
 
             <listitem><para>
-                <code>formReset($name, $value, $attribs):</code> Creates an
+                <methodname>formReset($name, $value, $attribs)</methodname>: Creates an
                 &lt;input type="reset" /&gt; element.
             </para></listitem>
 
             <listitem><para>
-                <code>formSelect($name, $value, $attribs, $options):</code>
+                <methodname>formSelect($name, $value, $attribs, $options)</methodname>:
                 Creates a &lt;select&gt;...&lt;/select&gt; block, with one
                 &lt;option&gt;one for each of the $options elements. In the
                 $options array, the element key is the option value, and the
@@ -269,29 +269,29 @@ echo $this->formCheckbox('foo',
             </para></listitem>
 
             <listitem><para>
-                <code>formSubmit($name, $value, $attribs):</code> Creates an
+                <methodname>formSubmit($name, $value, $attribs)</methodname>: Creates an
                 &lt;input type="submit" /&gt; element.
             </para></listitem>
 
             <listitem><para>
-                <code>formText($name, $value, $attribs):</code> Creates an
+                <methodname>formText($name, $value, $attribs)</methodname>: Creates an
                 &lt;input type="text" /&gt; element.
             </para></listitem>
 
             <listitem><para>
-                <code>formTextarea($name, $value, $attribs):</code> Creates a
+                <methodname>formTextarea($name, $value, $attribs)</methodname>: Creates a
                 &lt;textarea&gt;...&lt;/textarea&gt; block.
             </para></listitem>
 
             <listitem><para>
-                <code>url($urlOptions, $name, $reset):</code> Creates a <acronym>URL</acronym>
-                string based on a named route. <varname>$urlOptions</varname> should
-                be an associative array of key/value pairs used by the
-                particular route.
+                <methodname>url($urlOptions, $name, $reset)</methodname>: Creates a
+                <acronym>URL</acronym> string based on a named route.
+                <varname>$urlOptions</varname> should be an associative array of key/value pairs
+                used by the particular route.
             </para></listitem>
 
             <listitem><para>
-                <code>htmlList($items, $ordered, $attribs, $escape):</code> generates
+                <methodname>htmlList($items, $ordered, $attribs, $escape)</methodname>: generates
                 unordered and ordered lists based on the <varname>$items</varname>
                 passed to it. If <varname>$items</varname> is a multidimensional
                 array, a nested list will be built. If the <varname>$escape</varname>
@@ -479,7 +479,7 @@ $view->addHelperPath('/other/path/to/helpers', 'Your_View_Helper');
         </para>
 
         <para>
-            Here is an example of our <code>SpecialPurpose</code> helper code:
+            Here is an example of our <classname>SpecialPurpose</classname> helper code:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -496,7 +496,7 @@ class My_View_Helper_SpecialPurpose extends Zend_View_Helper_Abstract
 ]]></programlisting>
 
         <para>
-            Then in a view script, you can call the <code>SpecialPurpose</code>
+            Then in a view script, you can call the <classname>SpecialPurpose</classname>
             helper as many times as you like; it will be instantiated once, and
             then it persists for the life of that <classname>Zend_View</classname>
             instance.

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

@@ -125,7 +125,7 @@ echo $view->render('booklist.php');
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>basePath</code>: indicate a base path from which to set
+                    <property>basePath</property>: indicate a base path from which to set
                     the script, helper, and filter path. It assumes a directory
                     structure of:
                 </para>
@@ -139,40 +139,40 @@ base/path/
 
                 <para>
                     This may be set via <methodname>setBasePath()</methodname>,
-                    <methodname>addBasePath()</methodname>, or the <code>basePath</code>
+                    <methodname>addBasePath()</methodname>, or the <property>basePath</property>
                     option to the constructor.
                 </para>
             </listitem>
 
             <listitem><para>
-                <code>encoding</code>: indicate the character encoding to use
+                <property>encoding</property>: indicate the character encoding to use
                 with <methodname>htmlentities()</methodname>,
                 <methodname>htmlspecialchars()</methodname>, and other operations. Defaults
                 to ISO-8859-1 (latin1). May be set via
-                <methodname>setEncoding()</methodname> or the <code>encoding</code> option
+                <methodname>setEncoding()</methodname> or the <property>encoding</property> option
                 to the constructor.
             </para></listitem>
 
             <listitem><para>
-                <code>escape</code>: indicate a callback to be used by
+                <property>escape</property>: indicate a callback to be used by
                 <methodname>escape()</methodname>. May be set via
-                <methodname>setEscape()</methodname> or the <code>escape</code> option to the
-                constructor.
+                <methodname>setEscape()</methodname> or the <property>escape</property> option to
+                the constructor.
             </para></listitem>
 
             <listitem><para>
-                <code>filter</code>: indicate a filter to use after rendering
+                <property>filter</property>: indicate a filter to use after rendering
                 a view script. May be set via <methodname>setFilter()</methodname>,
-                <methodname>addFilter()</methodname>, or the <code>filter</code> option to
+                <methodname>addFilter()</methodname>, or the <property>filter</property> option to
                 the constructor.
             </para></listitem>
 
             <listitem><para>
-                <code>strictVars:</code> force <classname>Zend_View</classname> to emit
+                <property>strictVars</property>: force <classname>Zend_View</classname> to emit
                 notices and warnings when uninitialized view variables are
                 accessed. This may be set by calling
                 <methodname>strictVars(true)</methodname> or passing the
-                <code>strictVars</code> option to the constructor.
+                <property>strictVars</property> option to the constructor.
             </para></listitem>
         </itemizedlist>
     </sect2>
@@ -181,8 +181,8 @@ base/path/
         <title>Short Tags with View Scripts</title>
 
         <para>
-            In our examples, we make use of <acronym>PHP</acronym> long tags: <code>&lt;?php</code>.
-            We also favor the use of <ulink
+            In our examples, we make use of <acronym>PHP</acronym> long tags:
+            <emphasis>&lt;?php</emphasis>. We also favor the use of <ulink
                 url="http://us.php.net/manual/en/control-structures.alternative-syntax.php">alternate
                 syntax for control structures</ulink>. These are convenient shorthands to use when
             writing view scripts, as they make the constructs more terse, keep statements on single
@@ -190,14 +190,15 @@ base/path/
         </para>
 
         <para>
-            In previous versions, we often recommended using short tags (<code>&lt;?</code> and
-            <code>&lt;?=</code>), as they make the view scripts slightly less verbose. However, the
-            default for the <filename>php.ini</filename> <constant>short_open_tag</constant> setting
-            is typically off in production or on shared hosts -- making their use not terribly
-            portable. If you use template <acronym>XML</acronym> in view scripts, short
-            open tags will cause the templates to fail validation. Finally, if you use short tags
-            when <constant>short_open_tag</constant> is off, the view scripts will either cause
-            errors or simply echo PHP code back to the viewer.
+            In previous versions, we often recommended using short tags (<emphasis>&lt;?</emphasis>
+            and <emphasis>&lt;?=</emphasis>), as they make the view scripts slightly less verbose.
+            However, the default for the <filename>php.ini</filename>
+            <constant>short_open_tag</constant> setting is typically off in production or on shared
+            hosts -- making their use not terribly portable. If you use template
+            <acronym>XML</acronym> in view scripts, short open tags will cause the templates to fail
+            validation. Finally, if you use short tags when <constant>short_open_tag</constant> is
+            off, the view scripts will either cause errors or simply echo PHP code back to the
+            viewer.
         </para>
 
         <para>
@@ -208,7 +209,7 @@ base/path/
         <itemizedlist>
             <listitem>
                 <para>
-                    Turn on short tags in your <code>.htaccess</code> file:
+                    Turn on short tags in your <filename>.htaccess</filename> file:
                 </para>
 
                 <programlisting language="apache"><![CDATA[
@@ -217,8 +218,8 @@ php_value "short_open_tag" "on"
 
                 <para>
                     This will only be possible if you are allowed to create and
-                    utilize <code>.htaccess</code> files. This directive can
-                    also be added to your <code>httpd.conf</code> file.
+                    utilize <filename>.htaccess</filename> files. This directive can
+                    also be added to your <filename>httpd.conf</filename> file.
                 </para>
             </listitem>