Просмотр исходного кода

[MANUAL] English:

- structural fixes (no translations needed)

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@20819 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 лет назад
Родитель
Сommit
3db4a3d08e

+ 1 - 1
documentation/manual/en/module_specs/Zend_Mail-AddingRecipients.xml

@@ -57,4 +57,4 @@
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

+ 12 - 5
documentation/manual/en/module_specs/Zend_Mail-AdditionalHeaders.xml

@@ -5,12 +5,15 @@
 
     <para>
         <classname>Zend_Mail</classname> provides several methods to set additional Mail Headers:
+
         <itemizedlist>
             <listitem>
                 <para>
-                    <methodname>setReplyTo($email, $name=null)</methodname>: sets the Reply-To: header.
+                    <methodname>setReplyTo($email, $name=null)</methodname>: sets the Reply-To:
+                    header.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <methodname>setDate($date = null)</methodname>: sets the Date: header.
@@ -18,6 +21,7 @@
                     date string or <classname>Zend_Date</classname> instance to this method.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <methodname>setMessageId($id = true)</methodname>: sets the Message-Id: header.
@@ -28,8 +32,10 @@
             </listitem>
         </itemizedlist>
     </para>
+
     <note>
         <title>Return-Path</title>
+
         <para>
             If you set Return-Path on your mail, see <link linkend="zend.mail.introduction.sendmail"
                 >Configuring sendmail transport</link>.
@@ -39,13 +45,15 @@
     </note>
 
     <para>
-        Furthermore, arbitrary mail headers can be set by using the <methodname>addHeader()</methodname>
-        method. It requires two parameters containing the name and the value of the header field.
-        A third optional parameter determines if the header should have only one or multiple values:
+        Furthermore, arbitrary mail headers can be set by using the
+        <methodname>addHeader()</methodname> method. It requires two parameters containing the name
+        and the value of the header field. A third optional parameter determines if the header
+        should have only one or multiple values:
     </para>
 
     <example id="zend.mail.additional-headers.example-1">
         <title>Adding E-Mail Message Headers</title>
+
         <programlisting language="php"><![CDATA[
 $mail = new Zend_Mail();
 $mail->addHeader('X-MailGenerator', 'MyCoolApplication');
@@ -53,7 +61,6 @@ $mail->addHeader('X-greetingsTo', 'Mom', true); // multiple values
 $mail->addHeader('X-greetingsTo', 'Dad', true);
 ]]></programlisting>
     </example>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

+ 1 - 0
documentation/manual/en/module_specs/Zend_Mail-Boundary.xml

@@ -12,6 +12,7 @@
 
     <example id="zend.mail.boundary.example-1">
         <title>Changing the MIME Boundary</title>
+
         <programlisting language="php"><![CDATA[
 $mail = new Zend_Mail();
 $mail->setMimeBoundary('=_' . md5(microtime(1) . $someId++));

+ 13 - 11
documentation/manual/en/module_specs/Zend_Mail-CharacterSets.xml

@@ -2,15 +2,18 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.character-sets">
     <title>Character Sets</title>
+
     <para>
-        <classname>Zend_Mail</classname> does not check for the correct character set of the mail parts. When
-        instantiating <classname>Zend_Mail</classname>, a charset for the e-mail itself may be given. It defaults to
-        <code>iso-8859-1</code>. The application has to make sure that all parts added to that mail object
-        have their content encoded in the correct character set. When creating a new mail part, a different
-        charset can be given for each part.
+        <classname>Zend_Mail</classname> does not check for the correct character set of the mail
+        parts. When instantiating <classname>Zend_Mail</classname>, a charset for the e-mail itself
+        may be given. It defaults to <code>iso-8859-1</code>. The application has to make sure that
+        all parts added to that mail object have their content encoded in the correct character set.
+        When creating a new mail part, a different charset can be given for each part.
     </para>
+
     <note>
         <title>Only in text format</title>
+
         <para>
             Character sets are only applicable for message parts in text format.
         </para>
@@ -20,9 +23,10 @@
         <title>Usage in CJK languages</title>
 
         <para>
-            The following example is how to use <classname>Zend_Mail</classname> in Japanese. This is one of
-            <acronym>CJK</acronym> (aka <acronym>CJKV</acronym> ) languages. If you use Chinese, you may use
-            <acronym>HZ-GB-2312</acronym> instead of <acronym>ISO-2022-JP</acronym>.
+            The following example is how to use <classname>Zend_Mail</classname> in Japanese. This
+            is one of <acronym>CJK</acronym> (aka <acronym>CJKV</acronym> ) languages. If you use
+            Chinese, you may use <acronym>HZ-GB-2312</acronym> instead of
+            <acronym>ISO-2022-JP</acronym>.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -40,10 +44,8 @@ $mail->addTo('somebody_else@example.com', myConvert('Some Recipient'));
 $mail->setSubject(myConvert('TestSubject'));
 $mail->send();
 ]]></programlisting>
-
     </example>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

+ 11 - 5
documentation/manual/en/module_specs/Zend_Mail-DifferentTransports.xml

@@ -2,14 +2,17 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.different-transports">
     <title>Using Different Transports</title>
+
     <para>
-        In case you want to send different e-mails through different connections, you can also pass the
-        transport object directly to <methodname>send()</methodname> without a prior call to
-        <methodname>setDefaultTransport()</methodname>. The passed object will override the default transport for the
-        actual <methodname>send()</methodname> request.
+        In case you want to send different e-mails through different connections, you can also pass
+        the transport object directly to <methodname>send()</methodname> without a prior call to
+        <methodname>setDefaultTransport()</methodname>. The passed object will override the default
+        transport for the actual <methodname>send()</methodname> request.
     </para>
+
     <example id="zend.mail.different-transports.example-1">
         <title>Using Different Transports</title>
+
         <programlisting language="php"><![CDATA[
 $mail = new Zend_Mail();
 // build message...
@@ -20,10 +23,13 @@ $mail->send($tr2);
 $mail->send();  // use default again
 ]]></programlisting>
     </example>
+
     <note>
         <title>Additional transports</title>
+
         <para>
-            Additional transports can be written by implementing <classname>Zend_Mail_Transport_Interface</classname>.
+            Additional transports can be written by implementing
+            <classname>Zend_Mail_Transport_Interface</classname>.
         </para>
     </note>
 </sect1>

+ 18 - 15
documentation/manual/en/module_specs/Zend_Mail-Encoding.xml

@@ -2,22 +2,25 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.encoding">
     <title>Encoding</title>
+
     <para>
-        Text and HTML message bodies are encoded with the quotedprintable mechanism by default. Message headers
-        are also encoded with the quotedprintable mechanism if you do not specify base64 in <methodname>setHeaderEncoding()</methodname>.
-        If you use language that is not Roman letters-based, the base64 would be more suitable.
-        All other attachments are encoded via base64 if no other encoding is given in the <methodname>addAttachment()</methodname>
-        call or assigned to the <acronym>MIME</acronym> part object later. 7Bit and 8Bit encoding currently only pass on the
-        binary content data.
+        Text and HTML message bodies are encoded with the quotedprintable mechanism by default.
+        Message headers are also encoded with the quotedprintable mechanism if you do not specify
+        base64 in <methodname>setHeaderEncoding()</methodname>. If you use language that is not
+        Roman letters-based, the base64 would be more suitable. All other attachments are encoded
+        via base64 if no other encoding is given in the <methodname>addAttachment()</methodname>
+        call or assigned to the <acronym>MIME</acronym> part object later. 7Bit and 8Bit encoding
+        currently only pass on the binary content data.
     </para>
 
     <para>
-        Header Encoding, especially the encoding of the subject, is a tricky topic. <classname>Zend_Mime</classname> currently implements
-        its own algorithm to encode quoted printable headers according to RFC-2045.
-        This due to the problems of <code>iconv_mime_encode</code> and <code>mb_encode_mimeheader</code>
-        with regards to certain charsets. This algorithm only breaks the header at spaces, which might lead to headers
-        that far exceed the suggested length of 76 chars. For this cases it is suggested to switch to BASE64
-        header encoding same as the following example describes:
+        Header Encoding, especially the encoding of the subject, is a tricky topic.
+        <classname>Zend_Mime</classname> currently implements its own algorithm to encode quoted
+        printable headers according to RFC-2045. This due to the problems of
+        <code>iconv_mime_encode</code> and <code>mb_encode_mimeheader</code> with regards to certain
+        charsets. This algorithm only breaks the header at spaces, which might lead to headers that
+        far exceed the suggested length of 76 chars. For this cases it is suggested to switch to
+        BASE64 header encoding same as the following example describes:
     </para>
 
     <programlisting language="php"><![CDATA[
@@ -30,10 +33,10 @@ $mail->setHeaderEncoding(Zend_Mime::ENCODING_BASE64);
 ]]></programlisting>
 
     <para>
-        <classname>Zend_Mail_Transport_Smtp</classname> encodes lines starting with one dot or two dots so that the mail
-        does not violate the SMTP protocol.
+        <classname>Zend_Mail_Transport_Smtp</classname> encodes lines starting with one dot or two
+        dots so that the mail does not violate the SMTP protocol.
     </para>
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

+ 8 - 4
documentation/manual/en/module_specs/Zend_Mail-HtmlMails.xml

@@ -2,14 +2,18 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.html-mails">
     <title>HTML E-Mail</title>
+
     <para>
-        To send an e-mail in HTML format, set the body using the method <methodname>setBodyHTML()</methodname> instead of
-        <methodname>setBodyText()</methodname>. The <acronym>MIME</acronym> content type will automatically be set to <code>text/html</code>
-        then. If you use both HTML and Text bodies, a multipart/alternative <acronym>MIME</acronym> message will automatically be
-        generated:
+        To send an e-mail in HTML format, set the body using the method
+        <methodname>setBodyHTML()</methodname> instead of <methodname>setBodyText()</methodname>.
+        The <acronym>MIME</acronym> content type will automatically be set to <code>text/html</code>
+        then. If you use both HTML and Text bodies, a multipart/alternative <acronym>MIME</acronym>
+        message will automatically be generated:
     </para>
+
     <example id="zend.mail.html-mails.example-1">
         <title>Sending HTML E-Mail</title>
+
         <programlisting language="php"><![CDATA[
 $mail = new Zend_Mail();
 $mail->setBodyText('My Nice Test Text');

+ 44 - 38
documentation/manual/en/module_specs/Zend_Mail-Introduction.xml

@@ -1,26 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.introduction">
-
     <title>Introduction</title>
 
     <sect2 id="zend.mail.introduction.getting-started">
-
         <title>Getting started</title>
 
         <para>
-            <classname>Zend_Mail</classname> provides generalized functionality to compose and send both text and <acronym>MIME</acronym>-compliant
-            multipart e-mail messages. Mail can be sent with <classname>Zend_Mail</classname> via the default <classname>Zend_Mail_Transport_Sendmail</classname>
-            transport or via <classname>Zend_Mail_Transport_Smtp</classname>.
+            <classname>Zend_Mail</classname> provides generalized functionality to compose and send
+            both text and <acronym>MIME</acronym>-compliant multipart e-mail messages. Mail can be
+            sent with <classname>Zend_Mail</classname> via the default
+            <classname>Zend_Mail_Transport_Sendmail</classname> transport or via
+            <classname>Zend_Mail_Transport_Smtp</classname>.
         </para>
 
         <example id="zend.mail.introduction.example-1">
-
             <title>Simple E-Mail with Zend_Mail</title>
 
             <para>
-                A simple e-mail consists of some recipients, a subject, a body and a sender. To send such a mail using
-                <classname>Zend_Mail_Transport_Sendmail</classname>, do the following:
+                A simple e-mail consists of some recipients, a subject, a body and a sender. To send
+                such a mail using <classname>Zend_Mail_Transport_Sendmail</classname>, do the
+                following:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -31,32 +31,36 @@ $mail->addTo('somebody_else@example.com', 'Some Recipient');
 $mail->setSubject('TestSubject');
 $mail->send();
 ]]></programlisting>
-
         </example>
 
         <note>
             <title>Minimum definitions</title>
+
             <para>
-                In order to send an e-mail with <classname>Zend_Mail</classname> you have to specify at least one recipient, a
-                sender (e.g., with <methodname>setFrom()</methodname>), and a message body (text and/or HTML).
+                In order to send an e-mail with <classname>Zend_Mail</classname> you have to specify
+                at least one recipient, a sender (e.g., with <methodname>setFrom()</methodname>),
+                and a message body (text and/or HTML).
             </para>
         </note>
 
         <para>
-            For most mail attributes there are "get" methods to read the information stored in the mail object. For
-            further details, please refer to the <acronym>API</acronym> documentation. A special one is <methodname>getRecipients()</methodname>.
-            It returns an array with all recipient e-mail addresses that were added prior to the method call.
+            For most mail attributes there are "get" methods to read the information stored in the
+            mail object. for further details, please refer to the <acronym>API</acronym>
+            documentation. A special one is <methodname>getRecipients()</methodname>. It returns an
+            array with all recipient e-mail addresses that were added prior to the method call.
         </para>
 
         <para>
-            For security reasons, <classname>Zend_Mail</classname> filters all header fields to prevent header injection with
-            newline (<code>\n</code>) characters.
-            Double quotation is changed to single quotation and angle brackets to square brackets in the name of
-            sender and recipients. If the marks are in email address, the marks will be removed.
+            For security reasons, <classname>Zend_Mail</classname> filters all header fields to
+            prevent header injection with newline (<code>\n</code>) characters.
+            Double quotation is changed to single quotation and angle brackets to square brackets in
+            the name of sender and recipients. If the marks are in email address, the marks will be
+            removed.
         </para>
 
         <para>
-            You also can use most methods of the <classname>Zend_Mail</classname> object with a convenient fluent interface.
+            You also can use most methods of the <classname>Zend_Mail</classname> object with a
+            convenient fluent interface.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -67,29 +71,32 @@ $mail->setBodyText('This is the text of the mail.')
     ->setSubject('TestSubject')
     ->send();
 ]]></programlisting>
-
     </sect2>
 
     <sect2 id="zend.mail.introduction.sendmail">
-
         <title>Configuring the default sendmail transport</title>
 
         <para>
-            The default transport for a <classname>Zend_Mail</classname> instance is <classname>Zend_Mail_Transport_Sendmail</classname>.
-            It is essentially a wrapper to the <acronym>PHP</acronym> <ulink url="http://php.net/mail"><methodname>mail()</methodname></ulink> function.
-            If you wish to pass additional parameters to the <ulink url="http://php.net/mail"><methodname>mail()</methodname></ulink> function,
-            simply create a new transport instance and pass your parameters to the constructor. The new transport instance
-            can then act as the default <classname>Zend_Mail</classname> transport, or it can be passed to the <methodname>send()</methodname>
-            method of <classname>Zend_Mail</classname>.
+            The default transport for a <classname>Zend_Mail</classname> instance is
+            <classname>Zend_Mail_Transport_Sendmail</classname>. It is essentially a wrapper to the
+            <acronym>PHP</acronym> <ulink
+                url="http://php.net/mail"><methodname>mail()</methodname></ulink> function. If you
+            wish to pass additional parameters to the <ulink
+                url="http://php.net/mail"><methodname>mail()</methodname></ulink> function, simply
+            create a new transport instance and pass your parameters to the constructor. The new
+            transport instance can then act as the default <classname>Zend_Mail</classname>
+            transport, or it can be passed to the <methodname>send()</methodname> method of
+            <classname>Zend_Mail</classname>.
         </para>
 
         <example id="zend.mail.introduction.sendmail.example-1">
-
-            <title>Passing additional parameters to the Zend_Mail_Transport_Sendmail transport</title>
+            <title>
+                Passing additional parameters to the Zend_Mail_Transport_Sendmail transport
+            </title>
 
             <para>
-                This example shows how to change the Return-Path of the <ulink url="http://php.net/mail"><methodname>mail()</methodname></ulink>
-                function.
+                This example shows how to change the Return-Path of the <ulink
+                    url="http://php.net/mail"><methodname>mail()</methodname></ulink> function.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -103,14 +110,15 @@ $mail->addTo('somebody_else@example.com', 'Some Recipient');
 $mail->setSubject('TestSubject');
 $mail->send();
 ]]></programlisting>
-
         </example>
 
         <note>
             <title>Safe mode restrictions</title>
+
             <para>
-                The optional additional parameters will be cause the <ulink url="http://php.net/mail"><methodname>mail()</methodname></ulink> function to fail
-                if <acronym>PHP</acronym> is running in safe mode.
+                The optional additional parameters will be cause the <ulink
+                    url="http://php.net/mail"><methodname>mail()</methodname></ulink> function to
+                fail if <acronym>PHP</acronym> is running in safe mode.
             </para>
         </note>
 
@@ -119,8 +127,8 @@ $mail->send();
 
             <para>
                 As the PHP manual states the <methodname>mail()</methodname> function has different
-                behaviour on Windows and on *nix based systems. Using the Sendmail
-                Transport on Windows will not work in combination with <methodname>addBcc()</methodname>.
+                behaviour on Windows and on *nix based systems. Using the Sendmail Transport
+                on Windows will not work in combination with <methodname>addBcc()</methodname>.
                 The <methodname>mail()</methodname> function will sent to the BCC recipient such
                 that all the other recipients can see him as recipient!
             </para>
@@ -130,9 +138,7 @@ $mail->send();
                 transport for sending!
             </para>
         </warning>
-
     </sect2>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

+ 1 - 6
documentation/manual/en/module_specs/Zend_Mail-MultipleEmails.xml

@@ -22,7 +22,6 @@
     </para>
 
     <example id="zend.mail.multiple-emails.example-1">
-
         <title>Sending Multiple Mails per SMTP Connection</title>
 
         <programlisting language="php"><![CDATA[
@@ -50,7 +49,6 @@ for ($i = 0; $i < 5; $i++) {
 Zend_Mail::clearDefaultFrom();
 Zend_Mail::clearDefaultReplyTo();
 ]]></programlisting>
-
     </example>
 
     <para>
@@ -62,7 +60,6 @@ Zend_Mail::clearDefaultReplyTo();
     </para>
 
     <example id="zend.mail.multiple-emails.example-2">
-
         <title>Manually controlling the transport connection</title>
 
         <programlisting language="php"><![CDATA[
@@ -93,10 +90,8 @@ for ($i = 0; $i < 5; $i++) {
 $protocol->quit();
 $protocol->disconnect();
 ]]></programlisting>
-
     </example>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:
--->
+-->

+ 14 - 7
documentation/manual/en/module_specs/Zend_Mail-Sending.xml

@@ -2,24 +2,31 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.sending">
     <title>Sending via SMTP</title>
+
     <para>
-        To send mail via SMTP, <classname>Zend_Mail_Transport_Smtp</classname> needs to be created and registered with
-        <classname>Zend_Mail</classname> before the <methodname>send()</methodname> method is called. For all remaining
-        <methodname>Zend_Mail::send()</methodname> calls in the current script, the SMTP transport will then be used:
+        To send mail via SMTP, <classname>Zend_Mail_Transport_Smtp</classname> needs to be created
+        and registered with <classname>Zend_Mail</classname> before the
+        <methodname>send()</methodname> method is called. For all remaining
+        <methodname>Zend_Mail::send()</methodname> calls in the current script, the SMTP transport
+        will then be used:
     </para>
+
     <example id="zend.mail.sending.example-1">
         <title>Sending E-Mail via SMTP</title>
+
         <programlisting language="php"><![CDATA[
 $tr = new Zend_Mail_Transport_Smtp('mail.example.com');
 Zend_Mail::setDefaultTransport($tr);
 ]]></programlisting>
     </example>
+
     <para>
         The <methodname>setDefaultTransport()</methodname> method and the constructor of
-        <classname>Zend_Mail_Transport_Smtp</classname> are not expensive. These two lines can be processed at script
-        setup time (e.g., config.inc or similar) to configure the behavior of the <classname>Zend_Mail</classname> class
-        for the rest of the script. This keeps configuration information out of the application logic - whether
-        mail is sent via SMTP or <ulink url="http://php.net/mail"><methodname>mail()</methodname></ulink>, what mail server
+        <classname>Zend_Mail_Transport_Smtp</classname> are not expensive. These two lines can be
+        processed at script setup time (e.g., config.inc or similar) to configure the behavior of
+        the <classname>Zend_Mail</classname> class for the rest of the script. This keeps
+        configuration information out of the application logic - whether mail is sent via SMTP or
+        <ulink url="http://php.net/mail"><methodname>mail()</methodname></ulink>, what mail server
         is used, etc.
     </para>
 </sect1>

+ 20 - 17
documentation/manual/en/module_specs/Zend_Mail-SmtpAuthentication.xml

@@ -1,18 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.smtp-authentication">
-  <title>SMTP Authentication</title>
+    <title>SMTP Authentication</title>
 
-  <para><classname>Zend_Mail</classname> supports the use of SMTP authentication, which
-  can be enabled be passing the 'auth' parameter to the configuration array in
-  the <classname>Zend_Mail_Transport_Smtp</classname> constructor. The available
-  built-in authentication methods are PLAIN, LOGIN and CRAM-MD5 which all
-  expect a 'username' and 'password' value in the configuration array.</para>
+    <para>
+        <classname>Zend_Mail</classname> supports the use of SMTP authentication, which
+        can be enabled be passing the 'auth' parameter to the configuration array in
+        the <classname>Zend_Mail_Transport_Smtp</classname> constructor. The available
+        built-in authentication methods are PLAIN, LOGIN and CRAM-MD5 which all
+        expect a 'username' and 'password' value in the configuration array.
+    </para>
 
-  <example id="zend.mail.smtp-authentication.example-1">
-    <title>Enabling authentication within Zend_Mail_Transport_Smtp</title>
+    <example id="zend.mail.smtp-authentication.example-1">
+        <title>Enabling authentication within Zend_Mail_Transport_Smtp</title>
 
-    <programlisting language="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $config = array('auth' => 'login',
                 'username' => 'myusername',
                 'password' => 'password');
@@ -26,16 +28,17 @@ $mail->addTo('recipient@test.com', 'Some Recipient');
 $mail->setSubject('TestSubject');
 $mail->send($transport);
 ]]></programlisting>
-  </example>
+    </example>
 
-  <note>
-    <title>Authentication types</title>
+    <note>
+        <title>Authentication types</title>
 
-    <para>
-        The authentication type is case-insensitive but has no punctuation.
-        E.g. to use CRAM-MD5 you would pass 'auth' => 'crammd5' in the
-        <classname>Zend_Mail_Transport_Smtp</classname> constructor.</para>
-  </note>
+        <para>
+            The authentication type is case-insensitive but has no punctuation.
+            E.g. to use CRAM-MD5 you would pass 'auth' => 'crammd5' in the
+            <classname>Zend_Mail_Transport_Smtp</classname> constructor.
+        </para>
+    </note>
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

+ 13 - 10
documentation/manual/en/module_specs/Zend_Mail-SmtpSecure.xml

@@ -1,18 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.smtp-secure">
-  <title>Securing SMTP Transport</title>
+    <title>Securing SMTP Transport</title>
 
-  <para><classname>Zend_Mail</classname> also supports the use of either TLS or <acronym>SSL</acronym> to
-  secure a SMTP connection. This can be enabled be passing the 'ssl' parameter
-  to the configuration array in the <classname>Zend_Mail_Transport_Smtp</classname>
-  constructor with a value of either 'ssl' or 'tls'. A port can optionally be
-  supplied, otherwise it defaults to 25 for TLS or 465 for <acronym>SSL</acronym>.</para>
+    <para>
+        <classname>Zend_Mail</classname> also supports the use of either TLS or
+        <acronym>SSL</acronym> to secure a SMTP connection. This can be enabled be passing the
+        'ssl' parameter to the configuration array in the
+        <classname>Zend_Mail_Transport_Smtp</classname> constructor with a value of either 'ssl' or
+        'tls'. A port can optionally be supplied, otherwise it defaults to 25 for TLS or 465 for
+        <acronym>SSL</acronym>.
+    </para>
 
-  <example id="zend.mail.smtp-secure.example-1">
-    <title>Enabling a secure connection within Zend_Mail_Transport_Smtp</title>
+    <example id="zend.mail.smtp-secure.example-1">
+        <title>Enabling a secure connection within Zend_Mail_Transport_Smtp</title>
 
-    <programlisting language="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $config = array('ssl' => 'tls',
                 'port' => 25); // Optional port number supplied
 
@@ -25,7 +28,7 @@ $mail->addTo('recipient@test.com', 'Some Recipient');
 $mail->setSubject('TestSubject');
 $mail->send($transport);
 ]]></programlisting>
-  </example>
+    </example>
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

+ 33 - 32
documentation/manual/en/module_specs/Zend_Registry.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.registry.using">
-
     <title>Using the Registry</title>
 
     <para>
@@ -13,20 +12,21 @@
 
     <para>
         The typical method to use registries with Zend Framework is through static methods in the
-        <classname>Zend_Registry</classname> class. Alternatively, the registry can be used as an array object,
-        so you can access elements stored within it with a convenient array-like interface.
+        <classname>Zend_Registry</classname> class. Alternatively, the registry can be used as an
+        array object, so you can access elements stored within it with a convenient array-like
+        interface.
     </para>
 
     <sect2 id="zend.registry.using.storing">
-
         <title>Setting Values in the Registry</title>
 
         <para>
-            Use the static method <methodname>set()</methodname> to store an entry in the registry, .
+            Use the static method <methodname>set()</methodname> to store an entry in the registry.
         </para>
 
         <example id="zend.registry.using.storing.example">
             <title>Example of set() Method Usage</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Registry::set('index', $value);
 ]]></programlisting>
@@ -43,11 +43,9 @@ Zend_Registry::set('index', $value);
             The index can be a scalar (<constant>NULL</constant>, string, or number), like an
             ordinary array.
         </para>
-
     </sect2>
 
     <sect2 id="zend.registry.using.retrieving">
-
         <title>Getting Values from the Registry</title>
 
         <para>
@@ -57,6 +55,7 @@ Zend_Registry::set('index', $value);
 
         <example id="zend.registry.using.retrieving.example">
             <title>Example of get() Method Usage</title>
+
             <programlisting language="php"><![CDATA[
 $value = Zend_Registry::get('index');
 ]]></programlisting>
@@ -64,11 +63,13 @@ $value = Zend_Registry::get('index');
 
         <para>
             The <methodname>getInstance()</methodname> method returns the singleton registry object.
-            This registry object is iterable, making all values stored in the registry easily accessible.
+            This registry object is iterable, making all values stored in the registry easily
+            accessible.
         </para>
 
         <example id="zend.registry.using.retrieving.example-iterating">
             <title>Example of Iterating over the Registry</title>
+
             <programlisting language="php"><![CDATA[
 $registry = Zend_Registry::getInstance();
 
@@ -78,11 +79,9 @@ foreach ($registry as $index => $value) {
 }
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.registry.using.constructing">
-
         <title>Constructing a Registry Object</title>
 
         <para>
@@ -107,6 +106,7 @@ foreach ($registry as $index => $value) {
 
         <example id="zend.registry.using.constructing.example">
             <title>Example of Constructing a Registry</title>
+
             <programlisting language="php"><![CDATA[
 $registry = new Zend_Registry(array('index' => $value));
 ]]></programlisting>
@@ -115,12 +115,13 @@ $registry = new Zend_Registry(array('index' => $value));
         <para>
             Once such a <classname>Zend_Registry</classname> object is instantiated,
             you can use it by calling any array object method or by setting it
-            as the singleton instance for <classname>Zend_Registry</classname> with the static method
-            <methodname>setInstance()</methodname>.
+            as the singleton instance for <classname>Zend_Registry</classname> with the static
+            method <methodname>setInstance()</methodname>.
         </para>
 
         <example id="zend.registry.using.constructing.example-setinstance">
             <title>Example of Initializing the Singleton Registry</title>
+
             <programlisting language="php"><![CDATA[
 $registry = new Zend_Registry(array('index' => $value));
 
@@ -129,14 +130,13 @@ Zend_Registry::setInstance($registry);
         </example>
 
         <para>
-            The <methodname>setInstance()</methodname> method throws a <classname>Zend_Exception</classname>
-            if the static registry has already been initialized.
+            The <methodname>setInstance()</methodname> method throws a
+            <classname>Zend_Exception</classname> if the static registry has already been
+            initialized.
         </para>
-
     </sect2>
 
     <sect2 id="zend.registry.using.array-access">
-
         <title>Accessing the Registry as an Array</title>
 
         <para>
@@ -146,6 +146,7 @@ Zend_Registry::setInstance($registry);
 
         <example id="zend.registry.using.array-access.example">
             <title>Example of Array Access</title>
+
             <programlisting language="php"><![CDATA[
 $registry = Zend_Registry::getInstance();
 
@@ -154,11 +155,9 @@ $registry['index'] = $value;
 var_dump( $registry['index'] );
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.registry.using.array-object">
-
         <title>Accessing the Registry as an Object</title>
 
         <para>
@@ -168,22 +167,26 @@ var_dump( $registry['index'] );
             You must specifically construct the registry
             object using the <constant>ArrayObject::ARRAY_AS_PROPS</constant> option
             and initialize the static instance to enable this functionality.
+
             <note>
                 <para>You must set the <constant>ArrayObject::ARRAY_AS_PROPS</constant> option
                 <emphasis>before</emphasis> the static registry has been accessed for
                 the first time.</para>
             </note>
         </para>
-            <warning>
-                <title>Known Issues with the ArrayObject::ARRAY_AS_PROPS Option</title>
 
-                <para>
-                    Some versions of <acronym>PHP</acronym> have proven very buggy when using the registry with the <constant>ArrayObject::ARRAY_AS_PROPS</constant> option.
-                </para>
-            </warning>
+        <warning>
+            <title>Known Issues with the ArrayObject::ARRAY_AS_PROPS Option</title>
+
+            <para>
+                Some versions of <acronym>PHP</acronym> have proven very buggy when using the
+                registry with the <constant>ArrayObject::ARRAY_AS_PROPS</constant> option.
+            </para>
+        </warning>
 
         <example id="zend.registry.using.array-object.example">
             <title>Example of Object Access</title>
+
             <programlisting language="php"><![CDATA[
 // in your application bootstrap:
 $registry = new Zend_Registry(array(), ArrayObject::ARRAY_AS_PROPS)
@@ -204,11 +207,9 @@ $registry->index = $value;
 var_dump($registry->index);
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.registry.using.isset">
-
         <title>Querying if an Index Exists</title>
 
         <para>
@@ -218,6 +219,7 @@ var_dump($registry->index);
 
         <example id="zend.registry.using.isset.example-isregistered">
             <title>Example of isRegistered() Method Usage</title>
+
             <programlisting language="php"><![CDATA[
 if (Zend_Registry::isRegistered($index)) {
     $value = Zend_Registry::get($index);
@@ -233,6 +235,7 @@ if (Zend_Registry::isRegistered($index)) {
 
         <example id="zend.registry.using.isset.example-isset">
             <title>Example of isset() Method Usage</title>
+
             <programlisting language="php"><![CDATA[
 $registry = Zend_Registry::getInstance();
 
@@ -247,11 +250,9 @@ if (isset($registry->index)) {
 }
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.registry.using.subclassing">
-
         <title>Extending the Registry</title>
 
         <para>
@@ -261,6 +262,7 @@ if (isset($registry->index)) {
             specify this class to instantiate for the singleton in the static registry.
             Use the static method <methodname>setClassName()</methodname> to specify
             the class.
+
             <note>
                 <para>The class must be a subclass of <classname>Zend_Registry</classname>.</para>
             </note>
@@ -268,6 +270,7 @@ if (isset($registry->index)) {
 
         <example id="zend.registry.using.subclassing.example">
             <title>Example of Specifying the Singleton Registry's Class Name</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Registry::setClassName('My_Registry');
 
@@ -281,11 +284,9 @@ Zend_Registry::set('index', $value);
             It is therefore recommended that you specify the class name for your
             static registry in your application bootstrap.
         </para>
-
     </sect2>
 
     <sect2 id="zend.registry.using.unsetting">
-
         <title>Unsetting the Static Registry</title>
 
         <para>
@@ -296,6 +297,7 @@ Zend_Registry::set('index', $value);
 
         <warning>
             <title>Data Loss Risk</title>
+
             <para>
                 When you use <methodname>_unsetInstance()</methodname>,
                 all data in the static registry are
@@ -315,6 +317,7 @@ Zend_Registry::set('index', $value);
 
         <example id="zend.registry.using.unsetting.example">
             <title>Example of _unsetInstance() Method Usage</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Registry::set('index', $value);
 
@@ -326,9 +329,7 @@ Zend_Registry::setClassName('My_Registry');
 Zend_Registry::set('index', $value);
 ]]></programlisting>
         </example>
-
     </sect2>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et: