[DOCUMENTATION] English:

-  manual fixes

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

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

@@ -19,19 +19,19 @@
             that you can not be sure if the string is a real date. Therefor
             <classname>Zend_Date</classname> has spent an own static function to check date strings.
             <classname>Zend_Locale</classname> has an own function
-            <code>getDate($date, $locale);</code> which parses a date and returns the proper and
-            normalized date parts. A monthname for example will be recognised and returned just a
-            month number. But as <classname>Zend_Locale</classname> does not know anything about
-            dates because it is a normalizing and localizing class we have integrated an own
-            function <code>isDate($date);</code> which checks this.
+            <methodname>getDate($date, $locale)</methodname> which parses a date and returns the
+            proper and normalized date parts. A monthname for example will be recognised and
+            returned just a month number. But as <classname>Zend_Locale</classname> does not know
+            anything about dates because it is a normalizing and localizing class we have
+            integrated an own function <methodname>isDate($date)</methodname> which checks this.
         </para>
 
         <para>
-            <code>isDate($date, $format, $locale);</code> can take up to 3 parameters and needs
-            minimum one parameter. So what we need to verify a date is, of course, the date itself
-            as string. The second parameter can be the format which the date is expected to have. If
-            no format is given the standard date format from your locale is used. For details about
-            how formats should look like see the chapter about <link
+            <methodname>isDate($date, $format, $locale)</methodname> can take up to 3 parameters
+            and needs minimum one parameter. So what we need to verify a date is, of course, the
+            date itself as string. The second parameter can be the format which the date is
+            expected to have. If no format is given the standard date format from your locale is
+            used. For details about how formats should look like see the chapter about <link
                 linkend="zend.date.constants.selfdefinedformats">self defined formats</link>.
         </para>
 
@@ -43,13 +43,13 @@
         </para>
 
         <para>
-            <code>isDate();</code> of course checks if a date does exist.
+            <methodname>isDate()</methodname> of course checks if a date does exist.
             <classname>Zend_Date</classname> itself does not check a date. So it is possible to
             create a date like '31.February.2000' with <classname>Zend_Date</classname> because
             <classname>Zend_Date</classname> will automatically correct the date and return the
-            proper date. In our case '03.March.2000'. <code>isDate()</code> on the other side does
-            this check and will return false on '31.February.2000' because it knows that this date
-            is impossible.
+            proper date. In our case '03.March.2000'. <methodname>isDate()</methodname> on the
+            other side does this check and will return false on '31.February.2000' because it knows
+            that this date is impossible.
         </para>
 
         <example id="zend.date.additional.checking.example-1">
@@ -118,9 +118,9 @@ print_r (Zend_Date_Cities::getCityList());
 
         <para>
             The location itself can be received with the
-            <classname>Zend_Date_Cities::City()</classname> function. It accepts the name of the
-            city as returned by the <classname>Zend_Date_Cities::getCityList()</classname> function
-            and optional as second parameter the horizon to set.
+            <methodname>Zend_Date_Cities::City()</methodname> function. It accepts the name of the
+            city as returned by the <methodname>Zend_Date_Cities::getCityList()</methodname>
+            function and optional as second parameter the horizon to set.
         </para>
 
         <para>
@@ -192,10 +192,10 @@ $mylocation = array('latitude' => 41.5, 'longitude' => 13.2446);
             As now all needed data can be set the next is to create a
             <classname>Zend_Date</classname> object with the day where sunset or sunrise should be
             calculated. For the calculation there are 3 functions available. It is possible to
-            calculate sunset with '<code>getSunset()</code>', sunrise with
-            '<code>getSunrise()</code>' and all available informations related to the sun with
-            '<code>getSunInfo()</code>'. After the calculation the <classname>Zend_Date</classname>
-            object will be returned with the calculated time.
+            calculate sunset with '<methodname>getSunset()</methodname>', sunrise with
+            '<methodname>getSunrise()</methodname>' and all available informations related to the
+            sun with '<methodname>getSunInfo()</methodname>'. After the calculation the
+            <classname>Zend_Date</classname> object will be returned with the calculated time.
         </para>
 
         <example id="zend.date.additional.sunrise-sunset.example-3">
@@ -230,7 +230,7 @@ foreach ($info as $sun) {
             on where in the world a user lives. So working with dates also means to set the proper
             timezone. This may sound complicated but it's easier as expected. As already mentioned
             in the first chapter of <classname>Zend_Date</classname> the default timezone has to be
-            set. Either by <code>php.ini</code> or by definition within the bootstrap file.
+            set. Either by <filename>php.ini</filename> or by definition within the bootstrap file.
         </para>
 
         <para>
@@ -242,15 +242,16 @@ foreach ($info as $sun) {
         </para>
 
         <para>
-            <code>getTimezone()</code> returns the actual set timezone of within the
+            <methodname>getTimezone()</methodname> returns the actual set timezone of within the
             <classname>Zend_Date</classname> object. Remember that <classname>Zend_Date</classname>
             is not coupled with PHP internals. So the returned timezone is not the timezone of the
-            PHP script but the timezone of the object. <code>setTimezone($zone)</code> is the second
-            function and makes it possible to set new timezone for <classname>Zend_Date</classname>.
-            A given timezone is always checked. If it does not exist an exception will be thrown.
-            Additionally the actual scripts or systems timezone can be set to the date object by
-            calling  <code>setTimezone()</code> without the zone parameter. This is also done
-            automatically when the date object is created.
+            PHP script but the timezone of the object. <methodname>setTimezone($zone)</methodname>
+            is the second function and makes it possible to set new timezone for
+            <classname>Zend_Date</classname>. A given timezone is always checked. If it does not
+            exist an exception will be thrown. Additionally the actual scripts or systems timezone
+            can be set to the date object by calling  <methodname>setTimezone()</methodname>
+            without the zone parameter. This is also done automatically when the date object is
+            created.
         </para>
 
         <example id="zend.date.additional.timezones.example-1">

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

@@ -28,8 +28,8 @@
 
         <para>
             Without any arguments, constructing an instance returns an object in the default locale
-            with the current, local date using PHP's <code>time()</code> function to obtain the
-            <ulink url="http://en.wikipedia.org/wiki/Unix_Time">UNIX timestamp</ulink>
+            with the current, local date using PHP'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 PHP environment has the correct
             <link linkend="zend.date.setdefaulttimezone">default timezone</link>
             .
@@ -63,8 +63,8 @@ print $date;
 
             <para>
                 The date in a <classname>Zend_Date</classname> object may be obtained as a localized
-                integer or string using the <code>get()</code> method. There are many available
-                options, which will be explained in later sections.
+                integer or string using the <methodname>get()</methodname> method. There are many
+                available options, which will be explained in later sections.
             </para>
 
             <example id="zend.date.simple.functions.get.example-1">
@@ -84,9 +84,9 @@ print $date->get();
             <title>Setting a Date</title>
 
             <para>
-                The <code>set()</code> method alters the date stored in the object, and returns the
-                final date value as a timestamp (not an object). Again, there are many options which
-                will be explored in later sections.
+                The <methodname>set()</methodname> method alters the date stored in the object, and
+                returns the final date value as a timestamp (not an object). Again, there are many
+                options which will be explored in later sections.
             </para>
 
             <example id="zend.date.simple.functions.set.example-1">
@@ -107,10 +107,11 @@ print $date->get(Zend_Date::W3C);
             <title>Adding and Subtracting Dates</title>
 
             <para>
-                Adding two dates with <code>add()</code> usually involves adding a real date in time
-                with an artificial timestramp representing a date part, such as 12 hours, as shown
-                in the example below. Both <code>add()</code> and <code>sub()</code> use the same
-                set of options as <code>set()</code>, which will be explained later.
+                Adding two dates with <methodname>add()</methodname> usually involves adding a real
+                date in time with an artificial timestramp representing a date part, such as 12
+                hours, as shown in the example below. Both <methodname>add()</methodname> and
+                <methodname>sub()</methodname> use the same set of options as
+                <methodname>set()</methodname>, which will be explained later.
             </para>
 
             <example id="zend.date.simple.functions.add.example-1">
@@ -139,7 +140,7 @@ echo "Date via toString() = ", $date, "\n";
                 contained in the objects, or can operate on date parts, such as comparing the
                 minutes value in a date to an absolute value. For example, the current minutes in
                 the current time may be compared with a specific number of minutes using
-                <code>compare()</code>, as in the example below.
+                <methodname>compare()</methodname>, as in the example below.
             </para>
 
             <example id="zend.date.simple.functions.compare.example-1">
@@ -157,7 +158,8 @@ if ($date->compare(10, Zend_Date::MINUTE) == -1) {
             </example>
 
             <para>
-                For simple equality comparisons, use <code>equals()</code>, which returns a boolean.
+                For simple equality comparisons, use <methodname>equals()</methodname>, which
+                returns a boolean.
             </para>
 
             <example id="zend.date.simple.functions.compare.example-2">

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

@@ -1133,14 +1133,14 @@ print $date->toString("'Era:GGGG='GGGG, ' Date:yy.MMMM.dd'yy.MMMM.dd");
             <classname>Zend_Date::setOptions(array('format_type' => 'php'))</classname> method to
             switch Zend_Date methods from supporting ISO format specifiers to PHP date() type
             specifiers. Afterwards, all format parameters must be given with
-            <ulink url="http://php.net/date">PHP's <code>date()</code> format specifiers</ulink>.
-            The PHP date format lacks some of the formats supported by the ISO Format, and
-            vice-versa. If you are not already comfortable with it, then use the standard ISO format
-            instead. Also, if you have legacy code using PHP's date format, then either manually
-            convert it to the ISO format using <link
+            <ulink url="http://php.net/date">PHP's <methodname>date()</methodname> format
+                specifiers</ulink>. The PHP date format lacks some of the formats supported by the
+            ISO Format, and vice-versa. If you are not already comfortable with it, then use the
+            standard ISO format instead. Also, if you have legacy code using PHP's date format,
+            then either manually convert it to the ISO format using <link
                 linkend="zend.locale.date.normalize">Zend_Locale_Format::convertPhpToIsoFormat()</link>,
-            or use <code>setOptions()</code>. The following examples illustrate the usage of
-            constants from the table below to create self-defined formats.
+            or use <methodname>setOptions()</methodname>. The following examples illustrate the
+            usage of constants from the table below to create self-defined formats.
         </para>
 
         <example id="zend.date.constants.phpformats.example-1">

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

@@ -44,10 +44,10 @@ $date = new Zend_Date();
 
             <para>
                 Sometimes it is easier to use a static method for date creation. Therefor you can
-                use the <emphasis><code>now()</code></emphasis> method. It returns a new instance of
-                <classname>Zend_Date</classname> the same way as if you would use
-                <code>new Zend_Date()</code>. But it will always return the actual date and can not
-                be changed by giving optional parameters.
+                use the <emphasis><methodname>now()</methodname></emphasis> method. It returns a
+                new instance of <classname>Zend_Date</classname> the same way as if you would use
+                <command>new Zend_Date()</command>. But it will always return the actual date and
+                can not be changed by giving optional parameters.
             </para>
 
             <programlisting language="php"><![CDATA[

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

@@ -19,8 +19,8 @@
 
             <para>
                 Several methods use date format strings, in a way similar to PHP's
-                <code>date()</code>. If you are more comfortable with PHP's date format specifier
-                than with ISO format specifiers, then you can use
+                <methodname>date()</methodname>. If you are more comfortable with PHP's date format
+                specifier than with ISO format specifiers, then you can use
                 <classname>Zend_Date::setOptions(array('format_type' => 'php'))</classname>.
                 Afterward, use PHP's date format specifiers for all functions which accept a
                 <varname>$format</varname> parameter. Use
@@ -52,8 +52,9 @@
                 timestamps, and not calendar dates with a time component, the timestamp loses an
                 hour, resulting in the date having a calendar day value one less than expected. To
                 prevent such problems use the option <code>fix_dst</code>, which defaults to true,
-                causing DST to have no effect on date "math" (<code>addMOnth(), subMonth()</code>).
-                Use <classname>Zend_Date::setOptions(array('fix_dst' => false))</classname> to
+                causing DST to have no effect on date "math" (<methodname>addMonth()</methodname>,
+                <methodname>subMonth()</methodname>). Use
+                <methodname>Zend_Date::setOptions(array('fix_dst' => false))</methodname> to
                 enable the subtraction or addition of the DST adjustment when performing date
                 "math".
             </para>
@@ -136,8 +137,8 @@
             standard <ulink url="http://en.wikipedia.org/wiki/Unix_Time">UNIX timestamps</ulink>.
             In order for a date to be rendered in a localized manner, a timezone must be known
             first. The default timezone is always GMT/UTC. To examine an object's timezone use
-            <code>getTimeZone())</code>. To change an object's timezone, use
-            <code>setTimeZone())</code>. All manipulations of these objects are assumed to be
+            <methodname>getTimeZone()</methodname>. To change an object's timezone, use
+            <methodname>setTimeZone()</methodname>. All manipulations of these objects are assumed to be
             relative to this timezone.
         </para>
 
@@ -195,7 +196,7 @@ echo $date3, "\n"; // outputs "Mar 3, 2007 12:00:00 AM"
             parameter specifies the locale to use for localizing output (e.g. the date format for a
             string representation). Note that the <varname>$date</varname> input parameter might
             actually have a type name instead (e.g. <varname>$hour</varname> for
-            <code>addHour()</code>), although that does not prevent the use of
+            <methodname>addHour()</methodname>), although that does not prevent the use of
             <classname>Zend_Date</classname> objects as arguments for that parameter. If no
              <varname>$locale</varname> was specified, then the locale of the current object is used
              to interpret <varname>$date</varname>, or select the localized format for output.
@@ -225,17 +226,19 @@ $date = new Zend_Date('31.Feb.2007');
         <title>Basic Zend_Date Operations Common to Many Date Parts</title>
 
         <para>
-            The methods <code>add(), sub(), compare(), get(), and set()</code> operate generically
-            on dates. In each case, the operation is performed on the date held in the instance
-            object. The <varname>$date</varname> operand is required for all of these methods,
-            except <code>get()</code>, and may be a <classname>Zend_Date</classname> instance
+            The methods <methodname>add()</methodname>, <methodname>sub()</methodname>,
+            <methodname>compare()</methodname>, <methodname>get()</methodname>, and
+            <methodname>set()</methodname> operate generically on dates. In each case, the
+            operation is performed on the date held in the instance object. The
+            <varname>$date</varname> operand is required for all of these methods, except
+            <methodname>get()</methodname>, and may be a <classname>Zend_Date</classname> instance
             object, a numeric string, or an integer. These methods assume <varname>$date</varname>
             is a timestamp, if it is not an object. However, the <varname>$part</varname> operand
             controls which logical part of the two dates are operated on, allowing operations on
             parts of the object's date, such as year or minute, even when <varname>$date</varname>
             contains a long form date string, such as, "December 31, 2007 23:59:59". The result of
-            the operation changes the date in the object, except for <code>compare()</code>, and
-            <code>get()</code>.
+            the operation changes the date in the object, except for
+            <methodname>compare()</methodname>, and <methodname>get()</methodname>.
         </para>
 
         <example id="zend.date.basic.example-1">
@@ -255,9 +258,10 @@ print $date;
             programmers avoid having to type out the <link linkend="zend.date.constants.list">date
                 part constants</link> when using the general methods above. Conveniently, they are
             named by combining a prefix (name of a basic operation) with a suffix (type of date
-            part), such as <code>addYear()</code>. In the list below, all combinations of "Date
-            Parts" and "Basic Operations" exist. For example, the operation "add" exists for each of
-            these date parts, including <code>addDay()</code>, <code>addYear()</code>, etc.
+            part), such as <methodname>addYear()</methodname>. In the list below, all combinations
+            of "Date Parts" and "Basic Operations" exist. For example, the operation "add" exists
+            for each of these date parts, including <methodname>addDay()</methodname>,
+            <methodname>addYear()</methodname>, etc.
         </para>
 
         <para>
@@ -344,13 +348,14 @@ print $date;
                             </entry>
                             <entry>
                                 Milliseconds denote thousandths of a second (0-999).
-                                <classname>Zend_Date</classname> supports two additional methods for
-                                working with time units smaller than seconds. By default,
+                                <classname>Zend_Date</classname> supports two additional methods
+                                for working with time units smaller than seconds. By default,
                                 <classname>Zend_Date</classname> instances use a precision
                                 defaulting to milliseconds, as seen using
-                                <code>getFractionalPrecision()</code>. To change the precision use
-                                <code>setFractionalPrecision($precision)</code>. However, precision
-                                is limited practically to microseconds, since
+                                <methodname>getFractionalPrecision()</methodname>. To change the
+                                precision use
+                                <methodname>setFractionalPrecision($precision)</methodname>.
+                                However, precision is limited practically to microseconds, since
                                 <classname>Zend_Date</classname> uses <code><ulink
                                     url="http://php.net/microtime">microtime()</ulink></code>.
                             </entry>
@@ -360,7 +365,7 @@ print $date;
                                 <ulink url="http://en.wikipedia.org/wiki/Day">Day</ulink>
                             </entry>
                             <entry>
-                                <classname>Zend_Date::DAY_SHORT</classname> is extracted from
+                                <constant>Zend_Date::DAY_SHORT</constant> is extracted from
                                 <varname>$date</varname> if the <varname>$date</varname> operand is
                                 an instance of <classname>Zend_Date</classname> or a numeric string.
                                 Otherwise, an attempt is made to extract the day according to the
@@ -478,12 +483,13 @@ print $date;
                                     <emphasis>get($part = null, $locale = null)</emphasis>
                                 </para>
                                 <para>
-                                    Use <code>get($part)</code> to retrieve the date
+                                    Use <methodname>get($part)</methodname> to retrieve the date
                                     <varname>$part</varname> of this object's date localized to
                                     <varname>$locale</varname> as a formatted string or integer.
                                     When using the BCMath extension, numeric strings might be
                                     returned instead of integers for large values.
-                                    <emphasis>NOTE:</emphasis> Unlike <code>get()</code>, the other
+                                    <emphasis>NOTE:</emphasis> Unlike
+                                    <methodname>get()</methodname>, the other
                                     get*() convenience methods only return instances of
                                     <classname>Zend_Date</classname> containing a date representing
                                     the selected or computed date/time.
@@ -669,10 +675,12 @@ print $date;
                                 <emphasis>isLeapYear()</emphasis>
                             </para>
                             <para>
-                                Use <code>isLeapYear()</code> to determine if the current object is
-                                a leap year, or use Zend_Date::checkLeapYear($year) to check $year,
-                                which can be a string, integer, or instance of
-                                <classname>Zend_Date</classname>. Is the year a leap year?
+                                Use <methodname>isLeapYear()</methodname> to determine if the
+                                current object is a leap year, or use
+                                <methodname>Zend_Date::checkLeapYear($year)</methodname> to check
+                                <varname>$year</varname>, which can be a string, integer, or
+                                instance of <classname>Zend_Date</classname>. Is the year a leap
+                                year?
                             </para>
                         </entry>
                     </row>
@@ -722,12 +730,13 @@ print $date;
                                 <emphasis>toString($format = null, $locale = null)</emphasis>
                             </para>
                             <para>
-                                Invoke directly or via the magic method <code>__toString()</code>.
-                                The <code>toString()</code> method automatically formats the date
-                                object's value according to the conventions of the object's locale,
-                                or an optionally specified <varname>$locale</varname>. For a list of
-                                supported format codes, see
-                                <xref linkend="zend.date.constants.selfdefinedformats" />.
+                                Invoke directly or via the magic method
+                                <methodname>__toString()</methodname>. The
+                                <methodname>toString()</methodname> method automatically formats
+                                the date object's value according to the conventions of the
+                                object's locale, or an optionally specified
+                                <varname>$locale</varname>. For a list of supported format codes,
+                                see <xref linkend="zend.date.constants.selfdefinedformats" />.
                             </para>
                         </entry>
                     </row>
@@ -836,11 +845,11 @@ print $date;
                                 <varname>$part</varname> selects a non-numeric value, such as
                                 <classname>Zend_Date::MONTH_NAME_SHORT</classname>.
                                 <emphasis>NOTE:</emphasis> This method calls <link
-                                    linkend="id.date.basic.operations"><code>get()</code></link>
-                                and casts the result to a PHP integer, which will give unpredictable
-                                results, if <code>get()</code> returns a numeric string containing a
-                                number too large for a PHP integer on your system. Use
-                                <code>get()</code> instead.
+                                    linkend="id.date.basic.operations"><methodname>get()</methodname></link>
+                                and casts the result to a PHP integer, which will give
+                                unpredictable results, if <methodname>get()</methodname> returns a
+                                numeric string containing a number too large for a PHP integer on
+                                your system. Use <methodname>get()</methodname> instead.
                             </para>
                         </entry>
                     </row>
@@ -867,8 +876,8 @@ print $date;
                                 <emphasis>now($locale = null)</emphasis>
                             </para>
                             <para>
-                                This convenience function is equivalent to <code>new
-                                Zend_Date()</code>. It returns the current date as a
+                                This convenience function is equivalent to <command>new
+                                Zend_Date()</command>. It returns the current date as a
                                 <classname>Zend_Date</classname> object, having
                                 <varname>$locale</varname>
                             </para>