Browse Source

[MANUAL] English:

- several manual fixes

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

+ 3 - 2
documentation/manual/en/module_specs/Zend_Application-AvailableResources-Db.xml

@@ -41,8 +41,9 @@
 
 
         <listitem>
         <listitem>
             <para>
             <para>
-                <emphasis><property>defaultMetadataCache</property></emphasis>: the name of the cache 
-                template or an instance of Zend_Cache_Core to use as metadata cache for Zend_Db_Table.
+                <emphasis><property>defaultMetadataCache</property></emphasis>: the name of the
+                cache template or an instance of <classname>Zend_Cache_Core</classname> to use as
+                metadata cache for <classname>Zend_Db_Table</classname>.
             </para>
             </para>
         </listitem>
         </listitem>
     </itemizedlist>
     </itemizedlist>

+ 2 - 1
documentation/manual/en/module_specs/Zend_Application-AvailableResources-Frontcontroller.xml

@@ -129,7 +129,8 @@ resources.frontController.plugins.baz.stackIndex = 123
 resources.frontController.returnresponse = 1
 resources.frontController.returnresponse = 1
 resources.frontController.env = APPLICATION_ENV
 resources.frontController.env = APPLICATION_ENV
 
 
-; The following proxies to: Zend_Controller_Action_HelperBroker::addPath('Helper_Path', $helperPrefix);
+; The following proxies to:
+; Zend_Controller_Action_HelperBroker::addPath('Helper_Path', $helperPrefix);
 resources.frontController.actionHelperPaths.HELPER_Prefix = "My/Helper/Path"
 resources.frontController.actionHelperPaths.HELPER_Prefix = "My/Helper/Path"
 ]]></programlisting>
 ]]></programlisting>
     </example>
     </example>

+ 2 - 1
documentation/manual/en/module_specs/Zend_Application-AvailableResources-Locale.xml

@@ -7,7 +7,8 @@
         <classname>Zend_Application_Resource_Locale</classname> can be used to
         <classname>Zend_Application_Resource_Locale</classname> can be used to
         set an application-wide locale which is then used in all classes and components
         set an application-wide locale which is then used in all classes and components
         which work with localization or internationalization. By default the locale is
         which work with localization or internationalization. By default the locale is
-        saved in a Zend_Registry entry with key 'Zend_Locale'.
+        saved in a <classname>Zend_Registry</classname> entry with key
+        '<property>Zend_Locale</property>'.
     </para>
     </para>
 
 
     <para>
     <para>

+ 4 - 4
documentation/manual/en/module_specs/Zend_Application-Examples.xml

@@ -37,14 +37,14 @@ resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
         <para>
         <para>
             Because these examples use custom code, we need to register the namespace prefixes for
             Because these examples use custom code, we need to register the namespace prefixes for
             that code with our configuration; this is done with the
             that code with our configuration; this is done with the
-            <code>autoloaderNamespaces</code> configuration key, which is an array.
+            <property>autoloaderNamespaces</property> configuration key, which is an array.
         </para>
         </para>
 
 
         <para>
         <para>
             Additionally, to ensure that custom plugin resources are discovered, we need to register
             Additionally, to ensure that custom plugin resources are discovered, we need to register
-            a plugin prefix path with the bootstrap. This is done with the <code>pluginpaths</code>
-            configuration key, which is an associative array, with keys denoting the prefix to use,
-            and values denoting the path related to that prefix.
+            a plugin prefix path with the bootstrap. This is done with the
+            <property>pluginpaths</property> configuration key, which is an associative array, with
+            keys denoting the prefix to use, and values denoting the path related to that prefix.
         </para>
         </para>
     </note>
     </note>
 
 

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

@@ -495,7 +495,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                 Unsubscribing from a Topic follows the exact same pattern as the previous example,
                 Unsubscribing from a Topic follows the exact same pattern as the previous example,
                 with the exception that we should call <methodname>unsubscribeAll()</methodname>
                 with the exception that we should call <methodname>unsubscribeAll()</methodname>
                 instead. The parameters included are identical to a subscription request with the
                 instead. The parameters included are identical to a subscription request with the
-                exception that "hub.mode" is set to "unsubscribe".
+                exception that "<property>hub.mode</property>" is set to "unsubscribe".
             </para>
             </para>
 
 
             <para>
             <para>

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

@@ -44,7 +44,7 @@
             by an internal cache (non-persistant) so repeat <acronym>API</acronym> calls for the
             by an internal cache (non-persistant) so repeat <acronym>API</acronym> calls for the
             same feed will avoid additional <acronym>DOM</acronym> or XPath use. Thirdly, importing
             same feed will avoid additional <acronym>DOM</acronym> or XPath use. Thirdly, importing
             feeds from a <acronym>URI</acronym> can take advantage of
             feeds from a <acronym>URI</acronym> can take advantage of
-            <acronym>HTTP</acronym> Conditional <acronym>GET</acronym> requests
+            <acronym>HTTP</acronym> Conditional <constant>GET</constant> requests
             which allow servers to issue an empty 304 response when the
             which allow servers to issue an empty 304 response when the
             requested feed has not changed since the last time you requested it.
             requested feed has not changed since the last time you requested it.
             In the final case, an instance of <classname>Zend_Cache</classname>
             In the final case, an instance of <classname>Zend_Cache</classname>
@@ -73,7 +73,7 @@
             that much different to <classname>Zend_Feed</classname>. Feeds can
             that much different to <classname>Zend_Feed</classname>. Feeds can
             be imported from a string, file, <acronym>URI</acronym> or an instance of type
             be imported from a string, file, <acronym>URI</acronym> or an instance of type
             <classname>Zend_Feed_Abstract</classname>. Importing from a <acronym>URI</acronym> can
             <classname>Zend_Feed_Abstract</classname>. Importing from a <acronym>URI</acronym> can
-            additionally utilise a <acronym>HTTP</acronym> Conditional <acronym>GET</acronym>
+            additionally utilise a <acronym>HTTP</acronym> Conditional <constant>GET</constant>
             request. If importing fails, an exception will be raised. The end result will be an
             request. If importing fails, an exception will be raised. The end result will be an
             object of type <classname>Zend_Feed_Reader_FeedInterface</classname>, the
             object of type <classname>Zend_Feed_Reader_FeedInterface</classname>, the
             core implementations of which are
             core implementations of which are
@@ -290,7 +290,8 @@ Zend_Feed_Reader::setCache($cache);
             <para>
             <para>
                 The big question often asked when importing a feed frequently, is
                 The big question often asked when importing a feed frequently, is
                 if it has even changed. With a cache enabled, you can add <acronym>HTTP</acronym>
                 if it has even changed. With a cache enabled, you can add <acronym>HTTP</acronym>
-                Conditional <acronym>GET</acronym> support to your arsenal to answer that question.
+                Conditional <constant>GET</constant> support to your arsenal to answer that
+                question.
             </para>
             </para>
 
 
             <para>
             <para>
@@ -333,7 +334,7 @@ $feed = Zend_Feed_Reader::import('http://www.planet-php.net/rdf/');
 
 
             <para>
             <para>
                 In the example above, with <acronym>HTTP</acronym> Conditional
                 In the example above, with <acronym>HTTP</acronym> Conditional
-                <acronym>GET</acronym> requests enabled, the response header values for ETag and
+                <constant>GET</constant> requests enabled, the response header values for ETag and
                 Last-Modified will be cached along with the feed. For the next 24hrs (the cache
                 Last-Modified will be cached along with the feed. For the next 24hrs (the cache
                 lifetime), feeds will only be updated on the cache if a non-304 response is received
                 lifetime), feeds will only be updated on the cache if a non-304 response is received
                 containing a valid <acronym>RSS</acronym> or Atom <acronym>XML</acronym> document.
                 containing a valid <acronym>RSS</acronym> or Atom <acronym>XML</acronym> document.

+ 1 - 1
documentation/manual/en/module_specs/Zend_Form-Forms.xml

@@ -1217,7 +1217,7 @@ $name = $form->getName();
 
 
         <para>
         <para>
             To set the action (url to which the form submits) and method (method
             To set the action (url to which the form submits) and method (method
-            by which it should submit, e.g., 'POST' or 'GET'), use the action
+            by which it should submit, e.g., 'POST' or '<constant>GET</constant>'), use the action
             and method accessors:
             and method accessors:
         </para>
         </para>
 
 

+ 4 - 6
documentation/manual/en/module_specs/Zend_Gdata_AuthSub.xml

@@ -56,12 +56,10 @@
 
 
         <para>
         <para>
             After Google's authentication server redirects the user's browser
             After Google's authentication server redirects the user's browser
-            back to the current application, a GET request parameter is set,
-            called <emphasis>token</emphasis>.
-            The value of this parameter is a single-use token that can be
-            used for authenticated access.
-            This token can be converted into a multi-use token and stored
-            in your session.
+            back to the current application, a <constant>GET</constant> request parameter is set,
+            called <emphasis>token</emphasis>. The value of this parameter is a single-use token
+            that can be used for authenticated access. This token can be converted into a multi-use
+            token and stored in your session.
         </para>
         </para>
 
 
         <para>
         <para>

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

@@ -16,10 +16,10 @@
             According to the <acronym>HTTP</acronym>/1.1 RFC, <acronym>HTTP</acronym> 301 and 302
             According to the <acronym>HTTP</acronym>/1.1 RFC, <acronym>HTTP</acronym> 301 and 302
             responses should be treated by the client by resending the same request to the
             responses should be treated by the client by resending the same request to the
             specified location - using the same request method. However, most
             specified location - using the same request method. However, most
-            clients to not implement this and always use a GET request when
+            clients to not implement this and always use a <constant>GET</constant> request when
             redirecting. By default, <classname>Zend_Http_Client</classname> does the same - when
             redirecting. By default, <classname>Zend_Http_Client</classname> does the same - when
-            redirecting on a 301 or 302 response, all GET and POST parameters
-            are reset, and a GET request is sent to the new location. This
+            redirecting on a 301 or 302 response, all <constant>GET</constant> and POST parameters
+            are reset, and a <constant>GET</constant> request is sent to the new location. This
             behavior can be changed by setting the 'strictredirects' configuration
             behavior can be changed by setting the 'strictredirects' configuration
             parameter to boolean <constant>TRUE</constant>:
             parameter to boolean <constant>TRUE</constant>:
             <example id="zend.http.client.redirections.example-1">
             <example id="zend.http.client.redirections.example-1">
@@ -313,7 +313,7 @@ $client->setUri('http://christer:secret@example.com');
         <para>
         <para>
             When you perform several requests with the same client, but want
             When you perform several requests with the same client, but want
             to make sure all the request-specific parameters are cleared, you
             to make sure all the request-specific parameters are cleared, you
-            should use the resetParameters() method. This ensures that GET and
+            should use the resetParameters() method. This ensures that <constant>GET</constant> and
             POST parameters, request body and request-specific headers are
             POST parameters, request body and request-specific headers are
             reset and are not reused in the next request.
             reset and are not reused in the next request.
         </para>
         </para>

+ 17 - 14
documentation/manual/en/module_specs/Zend_Http_Client.xml

@@ -206,8 +206,10 @@ $response = $client->request();
             </example>
             </example>
 
 
             The request() method takes one optional parameter - the request method.
             The request() method takes one optional parameter - the request method.
-            This can be either GET, POST, PUT, HEAD, DELETE, TRACE, OPTIONS or
-            CONNECT as defined by the <acronym>HTTP</acronym> protocol
+            This can be either <property>GET</property>, <property>POST</property>,
+            <property>PUT</property>, <property>HEAD</property>, <property>DELETE</property>,
+            <property>TRACE</property>, <property>OPTIONS</property> or <property>CONNECT</property>
+            as defined by the <acronym>HTTP</acronym> protocol
 
 
             <footnote>
             <footnote>
               <para>
               <para>
@@ -220,9 +222,10 @@ $response = $client->request();
         </para>
         </para>
 
 
         <para>
         <para>
-            If no method is specified, the method set by the last setMethod()
-            call is used. If setMethod() was never called, the default request
-            method is GET (see the above example).
+            If no method is specified, the method set by the last
+            <methodname>setMethod()</methodname> call is used. If
+            <methodname>setMethod()</methodname> was never called, the default request
+            method is <constant>GET</constant> (see the above example).
 
 
             <example id="zend.http.client.basic-requests.example-2">
             <example id="zend.http.client.basic-requests.example-2">
                 <title>Using Request Methods Other Than GET</title>
                 <title>Using Request Methods Other Than GET</title>
@@ -243,14 +246,14 @@ $response = $client->request();
         <title>Adding GET and POST parameters </title>
         <title>Adding GET and POST parameters </title>
 
 
         <para>
         <para>
-            Adding GET parameters to an <acronym>HTTP</acronym> request is quite simple, and can
-            be done either by specifying them as part of the URL, or by using
+            Adding <constant>GET</constant> parameters to an <acronym>HTTP</acronym> request is
+            quite simple, and can be done either by specifying them as part of the URL, or by using
             the setParameterGet() method.
             the setParameterGet() method.
-            This method takes the GET parameter's name as its first parameter,
-            and the GET parameter's value as its second parameter.
+            This method takes the <constant>GET</constant> parameter's name as its first parameter,
+            and the <constant>GET</constant> parameter's value as its second parameter.
             For convenience, the setParameterGet() method can also accept a
             For convenience, the setParameterGet() method can also accept a
-            single associative array of name => value GET variables - which may
-            be more comfortable when several GET parameters need to be set.
+            single associative array of name => value <constant>GET</constant> variables - which may
+            be more comfortable when several <constant>GET</constant> parameters need to be set.
 
 
             <example id="zend.http.client.parameters.example-1">
             <example id="zend.http.client.parameters.example-1">
                 <title>Setting GET Parameters</title>
                 <title>Setting GET Parameters</title>
@@ -273,9 +276,9 @@ $client->setParameterGet(array(
         </para>
         </para>
 
 
         <para>
         <para>
-            While GET parameters can be sent with every request method, POST
+            While <constant>GET</constant> parameters can be sent with every request method, POST
             parameters are only sent in the body of POST requests. Adding POST
             parameters are only sent in the body of POST requests. Adding POST
-            parameters to a request is very similar to adding GET parameters,
+            parameters to a request is very similar to adding <constant>GET</constant> parameters,
             and can be done with the setParameterPost() method, which is
             and can be done with the setParameterPost() method, which is
             similar to the setParameterGet() method in structure.
             similar to the setParameterGet() method in structure.
 
 
@@ -295,7 +298,7 @@ $client->setParameterPost(array(
 ]]></programlisting>
 ]]></programlisting>
             </example>
             </example>
 
 
-            Note that when sending POST requests, you can set both GET and
+            Note that when sending POST requests, you can set both <constant>GET</constant> and
             POST parameters. On the other hand, while setting POST parameters
             POST parameters. On the other hand, while setting POST parameters
             for a non-POST request will not trigger and error, it is useless.
             for a non-POST request will not trigger and error, it is useless.
             Unless the request is a POST request, POST parameters are simply
             Unless the request is a POST request, POST parameters are simply

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

@@ -646,8 +646,8 @@ $server->handle();
 
 
             <para>
             <para>
                 At its most basic, a Service Mapping Description indicates the
                 At its most basic, a Service Mapping Description indicates the
-                method of transport (POST, GET, <acronym>TCP</acronym>/IP, etc), the request
-                envelope type (usually based on the protocol of the server), the
+                method of transport (POST, <constant>GET</constant>, <acronym>TCP</acronym>/IP,
+                etc), the request envelope type (usually based on the protocol of the server), the
                 target <acronym>URL</acronym> of the service provider, and a map of services
                 target <acronym>URL</acronym> of the service provider, and a map of services
                 available. In the case of JSON-RPC, the service map is a list of
                 available. In the case of JSON-RPC, the service map is a list of
                 available methods, which each method documenting the available
                 available methods, which each method documenting the available

+ 2 - 2
documentation/manual/en/module_specs/Zend_Oauth-GettingStarted.xml

@@ -59,8 +59,8 @@ $consumer = new Zend_Oauth_Consumer($config);
         In addition, you should note several other configuration values not
         In addition, you should note several other configuration values not
         explicitly used: requestMethod and requestScheme. By default,
         explicitly used: requestMethod and requestScheme. By default,
         <classname>Zend_Oauth_Consumer</classname> sends requests as POST (except for a
         <classname>Zend_Oauth_Consumer</classname> sends requests as POST (except for a
-        redirect which uses GET). The customised client (see later) also includes its
-        authorization by way of a header. Some services may, at their discretion,
+        redirect which uses <constant>GET</constant>). The customised client (see later) also
+        includes its authorization by way of a header. Some services may, at their discretion,
         require alternatives. You can reset the requestMethod (which defaults
         require alternatives. You can reset the requestMethod (which defaults
         to Zend_Oauth::POST) to Zend_Oauth::GET, for example, and reset the
         to Zend_Oauth::POST) to Zend_Oauth::GET, for example, and reset the
         requestScheme from its default of Zend_Oauth::REQUEST_SCHEME_HEADER to one
         requestScheme from its default of Zend_Oauth::REQUEST_SCHEME_HEADER to one

+ 1 - 1
documentation/manual/en/module_specs/Zend_OpenId-Provider.xml

@@ -252,7 +252,7 @@ is your identity URL.
             It is possible to combine all provider functionality in one script. In
             It is possible to combine all provider functionality in one script. In
             this case login and trust <acronym>URL</acronym>s are omitted, and
             this case login and trust <acronym>URL</acronym>s are omitted, and
             <classname>Zend_OpenId_Provider</classname> assumes that they point to the same page
             <classname>Zend_OpenId_Provider</classname> assumes that they point to the same page
-            with the additional "openid.action" GET argument.
+            with the additional "openid.action" <constant>GET</constant> argument.
         </para>
         </para>
 
 
         <note>
         <note>

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

@@ -7,7 +7,7 @@
         REST Web Services use service-specific <acronym>XML</acronym> formats. These ad-hoc
         REST Web Services use service-specific <acronym>XML</acronym> formats. These ad-hoc
         standards mean that the manner for accessing a REST web service is
         standards mean that the manner for accessing a REST web service is
         different for each service. REST web services typically use <acronym>URL</acronym>
         different for each service. REST web services typically use <acronym>URL</acronym>
-        parameters (GET data) or path information for requesting data and POST
+        parameters (<constant>GET</constant> data) or path information for requesting data and POST
         data for sending data.
         data for sending data.
     </para>
     </para>
 
 

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

@@ -52,7 +52,7 @@ $server->handle();
 
 
         <para>
         <para>
             To call a <classname>Zend_Rest_Server</classname> service, you must supply a
             To call a <classname>Zend_Rest_Server</classname> service, you must supply a
-            GET/POST <code>method</code> argument with a value that is the
+            <constant>GET</constant>/POST <code>method</code> argument with a value that is the
             method you wish to call. You can then follow that up with any number
             method you wish to call. You can then follow that up with any number
             of arguments using either the name of the argument (i.e. "who") or
             of arguments using either the name of the argument (i.e. "who") or
             using <code>arg</code> following by the numeric position of the
             using <code>arg</code> following by the numeric position of the

+ 1 - 1
documentation/manual/en/module_specs/Zend_Test-PHPUnit-Testing.xml

@@ -29,7 +29,7 @@ class IndexControllerTest extends Zend_Test_PHPUnit_ControllerTestCase
 
 
     <para>
     <para>
         There will be times, however, that you need to provide extra
         There will be times, however, that you need to provide extra
-        information -- GET and POST variables, COOKIE information, etc. You can
+        information -- <constant>GET</constant> and POST variables, COOKIE information, etc. You can
         populate the request with that information:
         populate the request with that information:
     </para>
     </para>
 
 

+ 11 - 10
documentation/manual/en/tutorials/view-placeholders-standard.xml

@@ -19,7 +19,7 @@
         but specific content based on the controller and/or action; you may want to specify
         but specific content based on the controller and/or action; you may want to specify
         <acronym>CSS</acronym> files to load based on what section of the application you're in; you
         <acronym>CSS</acronym> files to load based on what section of the application you're in; you
         may need specific JavaScript scripts loaded at different times; or you may want to set the
         may need specific JavaScript scripts loaded at different times; or you may want to set the
-        <acronym>DocType</acronym> declaration.
+        <emphasis>DocType</emphasis> declaration.
     </para>
     </para>
 
 
     <para>
     <para>
@@ -31,12 +31,12 @@
         <title>Setting the DocType</title>
         <title>Setting the DocType</title>
 
 
         <para>
         <para>
-            <acronym>DocType</acronym> declarations are troublesome to memorize, and often essential
-            to include in your document to ensure the browser properly renders your content. The
-            <methodname>doctype()</methodname> view helper allows you to use simple string mnemonics
-            to specify the desired <acronym>DocType</acronym>; additionally, other helpers will
-            query the <methodname>doctype()</methodname> helper to ensure the output generated
-            conforms with the requested <acronym>DocType</acronym>.
+            <emphasis>DocType</emphasis> declarations are troublesome to memorize, and often
+            essential to include in your document to ensure the browser properly renders your
+            content. The <methodname>doctype()</methodname> view helper allows you to use simple
+            string mnemonics to specify the desired <emphasis>DocType</emphasis>; additionally,
+            other helpers will query the <methodname>doctype()</methodname> helper to ensure the
+            output generated conforms with the requested <emphasis>DocType</emphasis>.
         </para>
         </para>
 
 
         <para>
         <para>
@@ -130,7 +130,7 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 ]]></programlisting>
 ]]></programlisting>
 
 
         <para>
         <para>
-            Then, in your layout script, simply <function>echo</function> the helper at the
+            Then, in your layout script, simply <methodname>echo()</methodname> the helper at the
             top of the file:
             top of the file:
         </para>
         </para>
 
 
@@ -153,8 +153,9 @@ class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
         <para>
         <para>
             Often, a site will include the site or business name as part of the page title, and
             Often, a site will include the site or business name as part of the page title, and
             then add additional information based on the location within the site. As an example,
             then add additional information based on the location within the site. As an example,
-            the zend.com website includes the string "Zend.com" on all pages, and the prepends
-            information based on the page: "Zend Server - Zend.com". Within Zend Framework, the
+            the <filename>zend.com</filename> website includes the string
+            "<filename>Zend.com</filename>" on all pages, and the prepends information based on the
+            page: "Zend Server - <filename>Zend.com</filename>". Within Zend Framework, the
             <methodname>headTitle()</methodname> view helper can help simplify this task.
             <methodname>headTitle()</methodname> view helper can help simplify this task.
         </para>
         </para>