Browse Source

[MANUAL] English:

- several manual fixes

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

+ 1 - 1
documentation/manual/en/module_specs/Zend_Filter_Input.xml

@@ -371,7 +371,7 @@ if ($input->hasUnknown()) {
                 mapping a rule name to an array of error identifiers. Error
                 identifiers are fixed strings, to identify the reason for a
                 validation failure, while messages can be customized.
-                See <xref linkend="zend.validate.introduction.using" /> for
+                See <link linkend="zend.validate.introduction.using">this chapter</link> for
                 more information.
             </para>
 

+ 4 - 4
documentation/manual/en/module_specs/Zend_Gdata_Gbase.xml

@@ -88,10 +88,10 @@
                 The <classname>Zend_Gdata</classname> library provides support for all three
                 authentication schemes. The rest of this chapter will assume that you are familiar
                 the authentication schemes available and how to create an appropriate authenticated
-                connection. For more information, please see section <xref
-                    linkend="zend.gdata.introduction.authentication" /> or the <ulink
-                    url="http://code.google.com/apis/gdata/auth.html">Authentication Overview in the
-                    Google Data <acronym>API</acronym> Developer's Guide</ulink>.
+                connection. For more information, please see the <link
+                    linkend="zend.gdata.introduction.authentication">authentication section</link>
+                or the <ulink url="http://code.google.com/apis/gdata/auth.html">Authentication
+                    Overview in the Google Data <acronym>API</acronym> Developer's Guide</ulink>.
             </para>
         </sect3>
 

+ 7 - 8
documentation/manual/en/module_specs/Zend_Http_Client-Adapters.xml

@@ -165,11 +165,10 @@
                 </para>
 
                 <para>
-                    Additionally, when using persistent connections it is
-                    recommended to enable Keep-Alive <acronym>HTTP</acronym> requests as described
-                    in <xref linkend="zend.http.client.configuration" /> -
-                    otherwise persistent connections might have little or no
-                    effect.
+                    Additionally, when using persistent connections it is recommended to enable
+                    Keep-Alive <acronym>HTTP</acronym> requests as described in <link
+                        linkend="zend.http.client.configuration">the configuration section</link> -
+                    otherwise persistent connections might have little or no effect.
                 </para>
             </note>
 
@@ -441,9 +440,9 @@ $client = new Zend_Http_Client('http://www.example.com', $config);
             <para>
                 Since the proxy adapter inherits from
                 <classname>Zend_Http_Client_Adapter_Socket</classname>, you can use the stream
-                context access method (see <xref
-                    linkend="zend.http.client.adapters.socket.streamcontext" />) to set stream
-                context options on Proxy connections as demonstrated above.
+                context access method (see <link
+                    linkend="zend.http.client.adapters.socket.streamcontext">this section</link>)
+                to set stream context options on Proxy connections as demonstrated above.
             </para>
         </note>
     </sect2>

+ 2 - 2
documentation/manual/en/module_specs/Zend_Http_Client-Advanced.xml

@@ -68,7 +68,7 @@ $client->setCookie($cookie);
             </example>
 
             For more information about <classname>Zend_Http_Cookie</classname> objects, see
-            <xref linkend="zend.http.cookies" />.
+            <link linkend="zend.http.cookies">this section</link>.
         </para>
 
         <para>
@@ -103,7 +103,7 @@ $client->request('GET');
             </example>
 
             For more information about the <classname>Zend_Http_CookieJar</classname> class, see
-            <xref linkend="zend.http.cookies.cookiejar" />.
+            <link linkend="zend.http.cookies.cookiejar">this section</link>.
         </para>
     </sect2>
 

+ 8 - 6
documentation/manual/en/module_specs/Zend_Http_Client.xml

@@ -10,7 +10,7 @@
         complex features such as <acronym>HTTP</acronym> authentication and file uploads. Successful
         requests (and most unsuccessful ones too) return a <classname>Zend_Http_Response</classname>
         object, which provides access to the response's headers and body (see
-        <xref linkend="zend.http.response" />).
+        <link linkend="zend.http.response">this section</link>).
     </para>
 
     <sect2 id="zend.http.client.usage">
@@ -50,8 +50,9 @@ $client->setConfig($config);
                     that some special characters like the pipe symbol ('|') or the
                     caret symbol ('^') will not be accepted in the URL by default.
                     This can be modified by setting the 'allow_unwise' option of
-                    <classname>Zend_Uri</classname> to '<constant>TRUE</constant>'. See <xref
-                        linkend="zend.uri.validation.allowunwise" /> for more information.
+                    <classname>Zend_Uri</classname> to '<constant>TRUE</constant>'. See <link
+                        linkend="zend.uri.validation.allowunwise">this section</link> for more
+                    information.
                 </para>
             </note>
         </para>
@@ -104,7 +105,8 @@ $client->setConfig($config);
 
                             <entry>
                                 Whether to strictly follow the <acronym>RFC</acronym> when
-                                redirecting (see <xref linkend="zend.http.client.redirections" />)
+                                redirecting (see <link
+                                    linkend="zend.http.client.redirections">this section</link>)
                             </entry>
 
                             <entry>boolean</entry>
@@ -136,8 +138,8 @@ $client->setConfig($config);
                             <entry>adapter</entry>
 
                             <entry>
-                                Connection adapter class to use (see <xref
-                                    linkend="zend.http.client.adapters" />)
+                                Connection adapter class to use (see <link
+                                    linkend="zend.http.client.adapters">this section</link>)
                             </entry>
 
                             <entry>mixed</entry>

+ 2 - 2
documentation/manual/en/module_specs/Zend_Http_Cookie-Handling.xml

@@ -583,8 +583,8 @@ $cookie->match('http://www.example.com/', true, time() + (3 * 3600));
                             </listitem>
                         </itemizedlist>
 
-                        You can read more about cookie matching here:
-                        <xref linkend="zend.http.cookies.cookie.matching" />.
+                        You can read more about cookie matching in
+                        <link linkend="zend.http.cookies.cookie.matching">this section</link>.
                     </para>
                 </listitem>
             </itemizedlist>

+ 3 - 2
documentation/manual/en/module_specs/Zend_Json-Server.xml

@@ -35,7 +35,8 @@
     </itemizedlist>
 
     <para>
-        <classname>Zend_Json_Server</classname> utilizes <xref linkend="zend.server.reflection" />
+        <classname>Zend_Json_Server</classname> utilizes <link
+            linkend="zend.server.reflection">Zend_Server_Reflection</link>
         to perform reflection on any attached classes or functions, and uses that
         information to build both the SMD and enforce method call signatures. As
         such, it is imperative that any attached functions and/or class methods
@@ -202,7 +203,7 @@ $server->handle();
 
         <para>
             While most functionality for <classname>Zend_Json_Server</classname> is
-            spelled out in <xref linkend="zend.json.server.usage" />, more
+            spelled out in <link linkend="zend.json.server.usage">this section</link>, more
             advanced functionality is available.
         </para>
 

+ 1 - 1
documentation/manual/en/module_specs/Zend_Layout-QuickStart.xml

@@ -123,7 +123,7 @@ Zend_Layout::startMvc();
         <para>
             <methodname>startMvc()</methodname> can take an optional array of options or
             <classname>Zend_Config</classname> object to customize the instance; these
-            options are detailed in <xref linkend="zend.layout.options" />.
+            options are detailed in <link linkend="zend.layout.options">this section</link>.
         </para>
 
         <para>

+ 2 - 2
documentation/manual/en/module_specs/Zend_Locale-Introduction.xml

@@ -508,8 +508,8 @@ echo $date->getDate();
             <acronym>CLDR</acronym>/ISO date format specifier tokens and <acronym>PHP</acronym>'s
             date() tokens. The 'fix_date' option enables or disables heuristics that attempt to
             correct invalid dates. The 'number_format' option specifies a default number format for
-            use with <methodname>toNumber()</methodname> (see <xref
-                linkend= "zend.locale.number.localize"/>).
+            use with <methodname>toNumber()</methodname> (see <link
+                linkend= "zend.locale.number.localize">this section</link>).
         </para>
 
         <para>

+ 1 - 1
documentation/manual/en/module_specs/Zend_Memory-Overview.xml

@@ -157,7 +157,7 @@ $memObject->value = substr($memObject->value, $start, $length);
             <para>
                 The memory manager doesn't swap objects with size less than
                 the specified minimum, due to performance considerations.
-                See <xref linkend="zend.memory.memory-manager.settings.min-size" />
+                See <link linkend="zend.memory.memory-manager.settings.min-size">this section</link>
                 for more details.
             </para>
         </sect3>

+ 17 - 3
documentation/manual/en/module_specs/Zend_ProgressBar.xml

@@ -76,11 +76,25 @@ $progressBar->finish();
 
             <itemizedlist mark="opencircle">
                 <listitem>
-                    <para><xref linkend="zend.progressbar.adapter.console" /></para>
+                    <para>
+                        <link
+                            linkend="zend.progressbar.adapter.console">Zend_ProgressBar_Adapter_Console</link>
+                    </para>
                 </listitem>
 
-                <listitem><para><xref linkend="zend.progressbar.adapter.jspush" /></para></listitem>
-                <listitem><para><xref linkend="zend.progressbar.adapter.jspull" /></para></listitem>
+                <listitem>
+                    <para>
+                        <link
+                            linkend="zend.progressbar.adapter.jspush">Zend_ProgressBar_Adapter_JsPush</link>
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <link
+                            linkend="zend.progressbar.adapter.jspull">Zend_ProgressBar_Adapter_JsPull</link>
+                    </para>
+                </listitem>
             </itemizedlist>
         </para>
 

+ 12 - 3
documentation/manual/en/module_specs/Zend_Serializer-Adapter.xml

@@ -140,21 +140,30 @@
                           <entry><emphasis>cycleCheck</emphasis></entry>
                           <entry><type>boolean</type></entry>
                           <entry>false</entry>
-                          <entry>See <xref linkend="zend.json.advanced.objects1"/></entry>
+
+                          <entry>
+                              See <link linkend="zend.json.advanced.objects1">this section</link>
+                          </entry>
                       </row>
 
                       <row>
                           <entry><emphasis>objectDecodeType</emphasis></entry>
                           <entry><type>Zend_Json::TYPE_*</type></entry>
                           <entry>Zend_Json::TYPE_ARRAY</entry>
-                          <entry>See <xref linkend= "zend.json.advanced.objects1"/></entry>
+
+                          <entry>
+                              See <link linkend= "zend.json.advanced.objects1">this section</link>
+                          </entry>
                       </row>
 
                       <row>
                           <entry><emphasis>enableJsonExprFinder</emphasis></entry>
                           <entry><type>boolean</type></entry>
                           <entry>false</entry>
-                          <entry>See <xref linkend= "zend.json.advanced.expr"/></entry>
+
+                          <entry>
+                              See <link linkend= "zend.json.advanced.expr">this section</link>
+                          </entry>
                       </row>
                   </tbody>
              </tgroup>

+ 5 - 4
documentation/manual/en/module_specs/Zend_Service_SlideShare.xml

@@ -304,8 +304,8 @@ foreach($ss_user as $slideshow) {
             By default, <classname>Zend_Service_SlideShare</classname> will cache any request
             against the web service automatically to the filesystem (default path <code>/tmp</code>)
             for 12 hours. If you desire to change this behavior, you must provide your own
-            <xref linkend="zend.cache" /> object using the <code>setCacheObject</code> method as
-            shown:
+            <link linkend="zend.cache">Zend_Cache</link> object using the
+            <code>setCacheObject</code> method as shown:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -337,8 +337,9 @@ $ss_user = $ss->getSlideShowsByUser('username', $starting_offset, $limit);
             If for whatever reason you would like to change the behavior of the
             <acronym>HTTP</acronym> client when making the web service request, you can do so by
             creating your own instance of the <classname>Zend_Http_Client</classname> object (see
-            <xref linkend="zend.http" />). This is useful for instance when it is desirable to set
-            the timeout for the connection to something other then default as shown:
+            <link linkend="zend.http">Zend_Http</link>). This is useful for instance when it is
+            desirable to set the timeout for the connection to something other then default as
+            shown:
         </para>
 
         <programlisting language="php"><![CDATA[

+ 9 - 3
documentation/manual/en/module_specs/Zend_Service_StrikeIron-Overview.xml

@@ -10,18 +10,24 @@
 
     <para>
         <itemizedlist>
-            <listitem><para><xref linkend="zend.service.strikeiron" /></para></listitem>
+            <listitem>
+                <para><link linkend="zend.service.strikeiron">Zend_Service_StrikeIron</link></para>
+            </listitem>
         </itemizedlist>
 
         <itemizedlist>
             <listitem>
-                <para><xref linkend="zend.service.strikeiron.bundled-services" /></para>
+                <para>
+                    <link linkend="zend.service.strikeiron.bundled-services">Bundled Services</link>
+                </para>
             </listitem>
         </itemizedlist>
 
         <itemizedlist>
             <listitem>
-                <para><xref linkend="zend.service.strikeiron.advanced-uses" /></para>
+                <para>
+                    <link linkend="zend.service.strikeiron.advanced-uses">Advanced Use</link>
+                </para>
             </listitem>
         </itemizedlist>
     </para>

+ 4 - 4
documentation/manual/en/module_specs/Zend_Session-AdvancedUsage.xml

@@ -129,8 +129,8 @@ php_value session.auto_start 0
                     any output (e.g., <ulink url="http://www.php.net/headers_sent">HTTP
                         headers</ulink>) has been sent by <acronym>PHP</acronym> to the client, if
                     you are using the default, cookie-based sessions (strongly recommended). See
-                    <xref linkend="zend.session.global_session_management.headers_sent" /> for more
-                    information.
+                    <link linkend="zend.session.global_session_management.headers_sent">this
+                        section</link> for more information.
                 </para>
             </listitem>
         </orderedlist>
@@ -317,8 +317,8 @@ try {
             session namespace is needed at a later time during the same request. For example, a
             developer may store the reference in a static variable, add the reference to a <ulink
                 url="http://www.martinfowler.com/eaaCatalog/registry.html">registry</ulink> (see
-            <xref linkend="zend.registry" />), or otherwise make it available to other methods that
-            may need access to the session namespace.
+            <link linkend="zend.registry">Zend_Registry</link>), or otherwise make it available to
+            other methods that may need access to the session namespace.
         </para>
     </sect2>
 

+ 3 - 3
documentation/manual/en/module_specs/Zend_Session-GlobalSessionManagement.xml

@@ -469,9 +469,9 @@ if (!isset($defaultNamespace->initialized)) {
         <para>
             If you see the error message, "Cannot modify header information - headers already sent",
             then either avoid using <constant>TRUE</constant> as the value for the first argument
-            (requesting removal of the session cookie), or see <xref
-                linkend="zend.session.global_session_management.headers_sent" />. Thus,
-            <methodname>Zend_Session::destroy(true)</methodname> must either be called before
+            (requesting removal of the session cookie), or see <link
+                linkend="zend.session.global_session_management.headers_sent">this section</link>.
+            Thus, <methodname>Zend_Session::destroy(true)</methodname> must either be called before
             <acronym>PHP</acronym> has sent <acronym>HTTP</acronym> headers, or output buffering
             must be enabled. Also, the total output sent must not exceed the set buffer size, in
             order to prevent triggering sending the output before the call to

+ 1 - 1
documentation/manual/en/module_specs/Zend_Soap_AutoDiscovery.xml

@@ -355,7 +355,7 @@ $autodiscover->handle();
                 <listitem>
                     <para>
                         <acronym>PHP</acronym> class &lt;-&gt; based on complex type strategy (See:
-                        <xref linkend="zend.soap.wsdl.types.add_complex" />)
+                        <link linkend="zend.soap.wsdl.types.add_complex">this section</link>)
 
                         <footnote>
                             <para>

+ 3 - 2
documentation/manual/en/module_specs/Zend_Soap_Wsdl.xml

@@ -44,7 +44,8 @@
                         <varname>$extractComplexTypes</varname> before version 1.7 and can still be
                         set as a boolean for backwards compatibility. By default the 1.6 detection
                         behaviour is set. To read more on complex type detection strategies go to
-                        the section: <xref linkend="zend.soap.wsdl.types.add_complex" />.
+                        the section: <link linkend="zend.soap.wsdl.types.add_complex">Add complex
+                            types</link>.
                     </simpara>
                 </listitem>
             </orderedlist>
@@ -385,7 +386,7 @@
                 <listitem>
                     <para>
                         <acronym>PHP</acronym> class &lt;-&gt; based on complex type strategy (See:
-                        <xref linkend="zend.soap.wsdl.types.add_complex" />)
+                        <link linkend="zend.soap.wsdl.types.add_complex">this section</link>)
 
                         <footnote>
                             <para>

+ 1 - 1
documentation/manual/en/module_specs/Zend_Validate.xml

@@ -225,7 +225,7 @@ if (Zend_Validate::is($value, 'Between', array('min' => 1, 'max' => 12))) {
             Also, the <classname>Zend_Filter_Input</classname> class allows you to
             instantiate and run multiple filter and validator classes on demand
             to process sets of input data. See
-            <xref linkend="zend.filter.input" />.
+            <link linkend="zend.filter.input">Zend_Filter_Input</link>.
         </para>
 
         <sect3 id="zend.validate.introduction.static.namespaces">

+ 2 - 9
documentation/manual/en/ref/documentation-standard.xml

@@ -629,19 +629,12 @@ $render = "xxx";
             </para>
 
             <para>
-                Linking to other sections of the manual may be done using either the
-                <emphasis>&lt;xref&gt;</emphasis> tag (which will substitute the section title for
-                the link text) or the <emphasis>&lt;link&gt;</emphasis> tag (to which you must
-                provide link text).
+                Linking to other sections of the manual may be done using the
+                <emphasis>&lt;link&gt;</emphasis> tag (to which you must provide link text).
             </para>
 
             <programlisting language="xml"><![CDATA[
 <para>
-    "Xref" links to a section: <xref
-        linkend="doc-standard.recommendations.links" />.
-</para>
-
-<para>
     "Link" links to a section, using descriptive text: <link
         linkend="doc-standard.recommendations.links">documentation on
         links</link>.