Browse Source

[MANUAL] English:

- several manual fixes

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

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

@@ -94,9 +94,9 @@ $logger->log('Informational message', Zend_Log::INFO);
 
 
         <para>
         <para>
             The first parameter of the <methodname>log()</methodname> method is a string
             The first parameter of the <methodname>log()</methodname> method is a string
-            <code>message</code> and the second parameter is an integer <code>priority</code>. The
-            priority must be one of the priorities recognized by the Log instance. This is explained
-            in the next section.
+            <property>message</property> and the second parameter is an integer
+            <property>priority</property>. The priority must be one of the priorities recognized by
+            the Log instance. This is explained in the next section.
         </para>
         </para>
 
 
         <para>
         <para>
@@ -157,7 +157,7 @@ DEBUG   = 7;  // Debug: debug messages
         </para>
         </para>
 
 
         <para>
         <para>
-            The priorities are not arbitrary. They come from the BSD <code>syslog</code> protocol,
+            The priorities are not arbitrary. They come from the BSD syslog protocol,
             which is described in <ulink url="http://tools.ietf.org/html/rfc3164">RFC-3164</ulink>.
             which is described in <ulink url="http://tools.ietf.org/html/rfc3164">RFC-3164</ulink>.
             The names and corresponding priority numbers are also
             The names and corresponding priority numbers are also
             compatible with another <acronym>PHP</acronym> logging system,
             compatible with another <acronym>PHP</acronym> logging system,
@@ -189,7 +189,7 @@ $logger->addPriority('FOO', 8);
 
 
         <para>
         <para>
             The snippet above creates a new priority, <constant>FOO</constant>, whose
             The snippet above creates a new priority, <constant>FOO</constant>, whose
-            value is <code>8</code>. The new priority is then available for logging:
+            value is '8'. The new priority is then available for logging:
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -209,14 +209,14 @@ $logger->foo('Foo Message');
             When you call the <methodname>log()</methodname> method or one of its shortcuts, a
             When you call the <methodname>log()</methodname> method or one of its shortcuts, a
             log event is created. This is simply an associative array with data
             log event is created. This is simply an associative array with data
             describing the event that is passed to the writers. The following keys
             describing the event that is passed to the writers. The following keys
-            are always created in this array: <code>timestamp</code>,
-            <code>message</code>, <code>priority</code>, and
-            <code>priorityName</code>.
+            are always created in this array: <property>timestamp</property>,
+            <property>message</property>, <property>priority</property>, and
+            <property>priorityName</property>.
         </para>
         </para>
 
 
         <para>
         <para>
-            The creation of the <code>event</code> array is completely transparent.
-            However, knowledge of the <code>event</code> array is required for adding an
+            The creation of the <property>event</property> array is completely transparent.
+            However, knowledge of the <property>event</property> array is required for adding an
             item that does not exist in the default set above.
             item that does not exist in the default set above.
         </para>
         </para>
 
 
@@ -230,7 +230,7 @@ $logger->setEventItem('pid', getmypid());
 ]]></programlisting>
 ]]></programlisting>
 
 
         <para>
         <para>
-            The example above sets a new item named <code>pid</code> and populates
+            The example above sets a new item named <property>pid</property> and populates
             it with the PID of the current process. Once a new item has been
             it with the PID of the current process. Once a new item has been
             set, it is available automatically to all writers along with all of the
             set, it is available automatically to all writers along with all of the
             other data event data during logging. An item can be overwritten at any
             other data event data during logging. An item can be overwritten at any

+ 7 - 7
documentation/manual/en/module_specs/Zend_Log-Writers.xml

@@ -18,8 +18,8 @@
 
 
         <para>
         <para>
             To write log data to the <acronym>PHP</acronym> output buffer, use the URL
             To write log data to the <acronym>PHP</acronym> output buffer, use the URL
-            <code>php://output</code>. Alternatively, you can send log data directly to a stream
-            like <constant>STDERR</constant> (<code>php://stderr</code>).
+            <filename>php://output</filename>. Alternatively, you can send log data directly to a
+            stream like <constant>STDERR</constant> (<filename>php://stderr</filename>).
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -43,7 +43,7 @@ $logger->info('Informational message');
 ]]></programlisting>
 ]]></programlisting>
 
 
         <para>
         <para>
-            By default, the stream opens in the append mode (<code>"a"</code>).
+            By default, the stream opens in the append mode ("a").
             To open it with a different mode, the <classname>Zend_Log_Writer_Stream</classname>
             To open it with a different mode, the <classname>Zend_Log_Writer_Stream</classname>
             constructor accepts an optional second parameter for the mode.
             constructor accepts an optional second parameter for the mode.
         </para>
         </para>
@@ -99,9 +99,8 @@ $logger->info('Informational message');
 
 
         <para>
         <para>
             The example above writes a single row of log data to the database table named
             The example above writes a single row of log data to the database table named
-            <code>log_table_name</code> table. The database column named <code>lvl</code>
-            receives the priority number and the column named <code>msg</code> receives the
-            log message.
+            'log_table_name' table. The database column named 'lvl'
+            receives the priority number and the column named 'msg' receives the log message.
         </para>
         </para>
     </sect2>
     </sect2>
 
 
@@ -153,7 +152,8 @@ var_dump($mock->events[0]);
 ]]></programlisting>
 ]]></programlisting>
 
 
         <para>
         <para>
-            To clear the events logged by the mock, simply set <code>$mock->events = array()</code>.
+            To clear the events logged by the mock, simply set
+            <command>$mock->events = array()</command>.
         </para>
         </para>
     </sect2>
     </sect2>
 
 

+ 12 - 11
documentation/manual/en/module_specs/Zend_Mail_Read.xml

@@ -341,7 +341,7 @@ echo '</pre>';
             class of <classname>Zend_Mail_Message</classname>, so you have the same methods:
             class of <classname>Zend_Mail_Message</classname>, so you have the same methods:
             <methodname>getHeader()</methodname>, <methodname>getHeaders()</methodname>,
             <methodname>getHeader()</methodname>, <methodname>getHeaders()</methodname>,
             <methodname>getContent()</methodname>, <methodname>getPart()</methodname>,
             <methodname>getContent()</methodname>, <methodname>getPart()</methodname>,
-            <code>isMultipart</code> and the properties for headers.
+            <methodname>isMultipart()</methodname> and the properties for headers.
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -356,9 +356,10 @@ echo $part->getContent();
 ]]></programlisting>
 ]]></programlisting>
 
 
         <para>
         <para>
-            <classname>Zend_Mail_Part</classname> also implements <code>RecursiveIterator</code>,
-            which makes it easy to scan through all parts. And for easy output, it also implements
-            the magic method <methodname>__toString()</methodname>, which returns the content.
+            <classname>Zend_Mail_Part</classname> also implements
+            <classname>RecursiveIterator</classname>, which makes it easy to scan through all
+            parts. And for easy output, it also implements the magic method
+            <methodname>__toString()</methodname>, which returns the content.
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -457,18 +458,18 @@ if (!$message->hasFlag('$SpamTested')) {
             All storages, except Pop3, support folders, also called mailboxes. The interface
             All storages, except Pop3, support folders, also called mailboxes. The interface
             implemented by all storages supporting folders is called
             implemented by all storages supporting folders is called
             <classname>Zend_Mail_Storage_Folder_Interface</classname>. Also all of these classes
             <classname>Zend_Mail_Storage_Folder_Interface</classname>. Also all of these classes
-            have an additional optional parameter called <code>folder</code>, which is the folder
-            selected after login, in the constructor.
+            have an additional optional parameter called <property>folder</property>, which is the
+            folder selected after login, in the constructor.
         </para>
         </para>
 
 
         <para>
         <para>
             For the local storages you need to use separate classes called
             For the local storages you need to use separate classes called
             <classname>Zend_Mail_Storage_Folder_Mbox</classname> or
             <classname>Zend_Mail_Storage_Folder_Mbox</classname> or
             <classname>Zend_Mail_Storage_Folder_Maildir</classname>. Both need one parameter called
             <classname>Zend_Mail_Storage_Folder_Maildir</classname>. Both need one parameter called
-            <code>dirname</code> with the name of the base dir. The format for maildir is as defined
-            in maildir++ (with a dot as default delimiter), Mbox is a directory hierarchy with Mbox
-            files. If you don't have a Mbox file called INBOX in your Mbox base dir you need to set
-            another folder in the constructor.
+            <property>dirname</property> with the name of the base dir. The format for maildir is as
+            defined in maildir++ (with a dot as default delimiter), Mbox is a directory hierarchy
+            with Mbox files. If you don't have a Mbox file called INBOX in your Mbox base dir you
+            need to set another folder in the constructor.
         </para>
         </para>
 
 
         <para>
         <para>
@@ -507,7 +508,7 @@ $mail = new Zend_Mail_Storage_Imap(array('host'     => 'example.com',
             With the method getFolders($root = null) you can get the folder hierarchy starting with
             With the method getFolders($root = null) you can get the folder hierarchy starting with
             the root folder or the given folder. It's returned as an instance of
             the root folder or the given folder. It's returned as an instance of
             <classname>Zend_Mail_Storage_Folder</classname>, which implements
             <classname>Zend_Mail_Storage_Folder</classname>, which implements
-            <code>RecursiveIterator</code> and all children are also instances of
+            <classname>RecursiveIterator</classname> and all children are also instances of
             <classname>Zend_Mail_Storage_Folder</classname>. Each of these instances has a local and
             <classname>Zend_Mail_Storage_Folder</classname>. Each of these instances has a local and
             a global name returned by the methods <methodname>getLocalName()</methodname> and
             a global name returned by the methods <methodname>getLocalName()</methodname> and
             <methodname>getGlobalName()</methodname>. The global name is the absolute name from the
             <methodname>getGlobalName()</methodname>. The global name is the absolute name from the

+ 9 - 11
documentation/manual/en/module_specs/Zend_Measure-Edit.xml

@@ -13,42 +13,40 @@
     <itemizedlist>
     <itemizedlist>
         <listitem>
         <listitem>
             <para>
             <para>
-                <link linkend="zend.measure.edit.convert"><code>Convert</code></link>
+                <link linkend="zend.measure.edit.convert">Convert</link>
             </para>
             </para>
         </listitem>
         </listitem>
 
 
         <listitem>
         <listitem>
             <para>
             <para>
-                <link linkend="zend.measure.edit.add"><code>Add and subtract</code></link>
+                <link linkend="zend.measure.edit.add">Add and subtract</link>
             </para>
             </para>
         </listitem>
         </listitem>
 
 
         <listitem>
         <listitem>
             <para>
             <para>
-                <link linkend="zend.measure.edit.equal"><code>Compare to boolean</code></link>
+                <link linkend="zend.measure.edit.equal">Compare to boolean</link>
             </para>
             </para>
         </listitem>
         </listitem>
 
 
         <listitem>
         <listitem>
             <para>
             <para>
                 <link
                 <link
-                    linkend="zend.measure.edit.compare"><code>Compare to
-                    greater/smaller</code></link>
+                    linkend="zend.measure.edit.compare">Compare to greater/smaller</link>
             </para>
             </para>
         </listitem>
         </listitem>
 
 
         <listitem>
         <listitem>
             <para>
             <para>
                 <link
                 <link
-                    linkend="zend.measure.edit.changevalue"><code>Manually change
-                    values</code></link>
+                    linkend="zend.measure.edit.changevalue">Manually change values</link>
             </para>
             </para>
         </listitem>
         </listitem>
 
 
         <listitem>
         <listitem>
             <para>
             <para>
                 <link
                 <link
-                    linkend="zend.measure.edit.changetype"><code>Manually change types</code></link>
+                    linkend="zend.measure.edit.changetype">Manually change types</link>
             </para>
             </para>
         </listitem>
         </listitem>
     </itemizedlist>
     </itemizedlist>
@@ -66,9 +64,9 @@
         </para>
         </para>
 
 
         <para>
         <para>
-            The <code>convertTo</code> method accepts an optional parameter. With this parameter you
-            can define an precision for the returned output. The standard precision is
-            '<code>2</code>'.
+            The <methodname>convertTo()</methodname> method accepts an optional parameter. With
+            this parameter you can define an precision for the returned output. The standard
+            precision is '2'.
         </para>
         </para>
 
 
         <example id="zend.measure.edit.convert.example-1">
         <example id="zend.measure.edit.convert.example-1">

+ 8 - 8
documentation/manual/en/module_specs/Zend_Measure-Output.xml

@@ -9,19 +9,19 @@
     </para>
     </para>
 
 
     <para>
     <para>
-        <link linkend="zend.measure.output.auto"><code>Automatic output</code></link>
+        <link linkend="zend.measure.output.auto">Automatic output</link>
     </para>
     </para>
 
 
     <para>
     <para>
-        <link linkend="zend.measure.output.value"><code>Outputting values</code></link>
+        <link linkend="zend.measure.output.value">Outputting values</link>
     </para>
     </para>
 
 
     <para>
     <para>
-        <link linkend="zend.measure.output.unit"><code>Output with unit of measurement</code></link>
+        <link linkend="zend.measure.output.unit">Output with unit of measurement</link>
     </para>
     </para>
 
 
     <para>
     <para>
-        <link linkend="zend.measure.output.unit"><code>Output as localized string</code></link>
+        <link linkend="zend.measure.output.unit">Output as localized string</link>
     </para>
     </para>
 
 
     <sect2 id="zend.measure.output.auto">
     <sect2 id="zend.measure.output.auto">
@@ -50,8 +50,8 @@ echo $unit;
 
 
             <para>
             <para>
                 Output can be achieved simply by using
                 Output can be achieved simply by using
-                <ulink url="http://php.net/echo"><code>echo</code></ulink> or
-                <ulink url="http://php.net/print"><code>print</code></ulink>.
+                <ulink url="http://php.net/echo">echo</ulink> or
+                <ulink url="http://php.net/print">print</ulink>.
             </para>
             </para>
         </note>
         </note>
     </sect2>
     </sect2>
@@ -79,8 +79,8 @@ echo $unit->getValue();
 
 
         <para>
         <para>
             The <methodname>getValue()</methodname> method accepts an optional parameter
             The <methodname>getValue()</methodname> method accepts an optional parameter
-            '<code>round</code>' which allows to define a precision for the generated output. The
-            standard precision is '<code>2</code>'.
+            <property>round</property> which allows to define a precision for the generated
+            output. The standard precision is '2'.
         </para>
         </para>
     </sect2>
     </sect2>