Browse Source

[MANUAL] English:

- several manual fixes

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

+ 21 - 22
documentation/manual/en/module_specs/Zend_Gdata-Introduction.xml

@@ -147,7 +147,7 @@
                         <methodname>setStartIndex()</methodname>, and
                         <methodname>setStartIndex()</methodname>, and
                         <methodname>getPublishedMin()</methodname>. The query classes also
                         <methodname>getPublishedMin()</methodname>. The query classes also
                         have a method to generate a <acronym>URL</acronym> representing the
                         have a method to generate a <acronym>URL</acronym> representing the
-                        constructed query -- <code>getQueryUrl</code>.
+                        constructed query -- <methodname>getQueryUrl()</methodname>.
                         Alternatively, the query string component of the <acronym>URL</acronym>
                         Alternatively, the query string component of the <acronym>URL</acronym>
                         can be retrieved used the <methodname>getQueryString()</methodname>
                         can be retrieved used the <methodname>getQueryString()</methodname>
                         method.
                         method.
@@ -179,9 +179,9 @@
                         properties of an entry (such as the spreadsheet cell
                         properties of an entry (such as the spreadsheet cell
                         value), you can use an entry object to send update
                         value), you can use an entry object to send update
                         or delete requests to a service. For example,
                         or delete requests to a service. For example,
-                        you can call <code>$entry->save()</code> to save
+                        you can call <command>$entry->save()</command> to save
                         changes made to an entry back to service from which
                         changes made to an entry back to service from which
-                        the entry initiated, or <code>$entry->delete()</code>
+                        the entry initiated, or <command>$entry->delete()</command>
                         to delete an entry from the server.
                         to delete an entry from the server.
                     </para>
                     </para>
                 </listitem>
                 </listitem>
@@ -232,7 +232,7 @@
 
 
         <para>
         <para>
             Note: A full example of working with <classname>Zend_Gdata</classname> is available in
             Note: A full example of working with <classname>Zend_Gdata</classname> is available in
-            the <code>demos/Zend/Gdata</code> directory. This example is runnable
+            the <filename>demos/Zend/Gdata</filename> directory. This example is runnable
             from the command-line, but the methods contained within are easily
             from the command-line, but the methods contained within are easily
             portable to a web application.
             portable to a web application.
         </para>
         </para>
@@ -245,7 +245,7 @@
             The Zend Framework naming standards require that all classes be
             The Zend Framework naming standards require that all classes be
             named based upon the directory structure in which they are located.
             named based upon the directory structure in which they are located.
             For instance, extensions related to Spreadsheets are stored in:
             For instance, extensions related to Spreadsheets are stored in:
-            <code>Zend/Gdata/Spreadsheets/Extension/...</code> and, as a result
+            <filename>Zend/Gdata/Spreadsheets/Extension/...</filename> and, as a result
             of this, are named
             of this, are named
             <classname>Zend_Gdata_Spreadsheets_Extension_...</classname>.
             <classname>Zend_Gdata_Spreadsheets_Extension_...</classname>.
             This causes a lot of typing if you're trying to construct a new
             This causes a lot of typing if you're trying to construct a new
@@ -257,8 +257,8 @@
             (such as <classname>Zend_Gdata_App</classname>, <classname>Zend_Gdata</classname>,
             (such as <classname>Zend_Gdata_App</classname>, <classname>Zend_Gdata</classname>,
             <classname>Zend_Gdata_Spreadsheets</classname>) that should make constructing new
             <classname>Zend_Gdata_Spreadsheets</classname>) that should make constructing new
             instances of data model, query and other classes much easier. This magic factory is
             instances of data model, query and other classes much easier. This magic factory is
-            implemented by using the magic <code>__call</code> method to intercept all attempts
-            to call <code>$service->newXXX(arg1, arg2, ...)</code>. Based off
+            implemented by using the magic <methodname>__call()</methodname> method to intercept all
+            attempts to call <command>$service->newXXX(arg1, arg2, ...)</command>. Based off
             the value of XXX, a search is performed in all registered 'packages'
             the value of XXX, a search is performed in all registered 'packages'
             for the desired class. Here's some examples:
             for the desired class. Here's some examples:
         </para>
         </para>
@@ -396,7 +396,7 @@ $gdata->setMinorProtocolVersion(null);
         <itemizedlist>
         <itemizedlist>
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    The <code>q</code> parameter specifies a full-text
+                    The <property>q</property> parameter specifies a full-text
                     query. The value of the parameter is a string.
                     query. The value of the parameter is a string.
                 </para>
                 </para>
 
 
@@ -408,14 +408,12 @@ $gdata->setMinorProtocolVersion(null);
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    The <code>alt</code> parameter specifies the feed type.
-                    The value of the parameter can be
-                    <code>atom</code>,
-                    <code>rss</code>,
-                    <code>json</code>,
-                    or <code>json-in-script</code>.
+                    The <property>alt</property> parameter specifies the feed type.
+                    The value of the parameter can be <property>atom</property>,
+                    <property>rss</property>, <property>json</property>,
+                    or <property>json-in-script</property>.
                     If you don't specify this parameter, the default feed type
                     If you don't specify this parameter, the default feed type
-                    is <code>atom</code>. NOTE: Only the output of the
+                    is <property>atom</property>. NOTE: Only the output of the
                     atom feed format can be processed using
                     atom feed format can be processed using
                     <classname>Zend_Gdata</classname>.
                     <classname>Zend_Gdata</classname>.
                     The <classname>Zend_Http_Client</classname> could be used to retrieve
                     The <classname>Zend_Http_Client</classname> could be used to retrieve
@@ -431,7 +429,7 @@ $gdata->setMinorProtocolVersion(null);
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    The <code>maxResults</code> parameter limits the number
+                    The <property>maxResults</property> parameter limits the number
                     of entries in the feed. The value of the parameter is
                     of entries in the feed. The value of the parameter is
                     an integer. The number of entries returned in the feed
                     an integer. The number of entries returned in the feed
                     will not exceed this value.
                     will not exceed this value.
@@ -444,7 +442,7 @@ $gdata->setMinorProtocolVersion(null);
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    The <code>startIndex</code> parameter specifies the
+                    The <property>startIndex</property> parameter specifies the
                     ordinal number of the first entry returned in the feed.
                     ordinal number of the first entry returned in the feed.
                     Entries before this number are skipped.
                     Entries before this number are skipped.
                 </para>
                 </para>
@@ -457,13 +455,13 @@ $gdata->setMinorProtocolVersion(null);
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    The <code>updatedMin</code> and <code>updatedMax</code>
+                    The <property>updatedMin</property> and <property>updatedMax</property>
                     parameters specify bounds on the entry date.
                     parameters specify bounds on the entry date.
-                    If you specify a value for <code>updatedMin</code>,
+                    If you specify a value for <property>updatedMin</property>,
                     no entries that were updated earlier than the date
                     no entries that were updated earlier than the date
                     you specify are included in the feed. Likewise
                     you specify are included in the feed. Likewise
                     no entries updated after the date specified by
                     no entries updated after the date specified by
-                    <code>updatedMax</code> are included.
+                    <property>updatedMax</property> are included.
                 </para>
                 </para>
 
 
                 <para>
                 <para>
@@ -480,7 +478,8 @@ $gdata->setMinorProtocolVersion(null);
         </itemizedlist>
         </itemizedlist>
 
 
         <para>
         <para>
-            There is a <code>get</code> function for each <code>set</code> function.
+            There is a <methodname>get*()</methodname> function for each
+            <methodname>set*()</methodname> function.
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -702,7 +701,7 @@ echo 'The <id> of the resulting entry is: ' . $entryResult->id->text;
         </para>
         </para>
 
 
         <para>
         <para>
-            Option 2: Alternatively, you can call <code>$entry->delete()</code>
+            Option 2: Alternatively, you can call <command>$entry->delete()</command>
             on an entry retrieved from a Google service.
             on an entry retrieved from a Google service.
         </para>
         </para>
 
 

+ 25 - 22
documentation/manual/en/module_specs/Zend_Http_Cookie-Handling.xml

@@ -41,9 +41,9 @@
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         Through the constructor, using the following syntax:
                         Through the constructor, using the following syntax:
-                        <code>new <classname>Zend_Http_Cookie</classname>(string $name, string
+                        <command>new <classname>Zend_Http_Cookie</classname>(string $name, string
                             $value, string $domain, [int $expires, [string $path, [boolean
                             $value, string $domain, [int $expires, [string $path, [boolean
-                            $secure]]]);</code>
+                            $secure]]]);</command>
                     </para>
                     </para>
 
 
                     <itemizedlist>
                     <itemizedlist>
@@ -105,7 +105,8 @@
                     </para>
                     </para>
 
 
                     <para>
                     <para>
-                        The <code>fromString</code> method accepts the following parameters:
+                        The <methodname>fromString()</methodname> method accepts the following
+                        parameters:
                     </para>
                     </para>
 
 
                     <itemizedlist>
                     <itemizedlist>
@@ -210,32 +211,34 @@ echo $cookie;
             <itemizedlist>
             <itemizedlist>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>string getName()</code>: Get the name of the cookie
+                        <methodname>getName()</methodname>: Get the name of the cookie
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>string getValue()</code>: Get the real, decoded value of the cookie
+                        <methodname>getValue()</methodname>: Get the real, decoded value of the
+                        cookie
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>string getDomain()</code>: Get the cookie's domain
+                        <methodname>getDomain()</methodname>: Get the cookie's domain
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>string getPath()</code>: Get the cookie's path, which defaults to '/'
+                        <methodname>getPath()</methodname>: Get the cookie's path, which defaults
+                        to '/'
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>int getExpiryTime()</code>: Get the cookie's expiration time, as UNIX
-                        time stamp. If the cookie has no expiration time set, will return
+                        <methodname>getExpiryTime()</methodname>: Get the cookie's expiration time,
+                        as UNIX time stamp. If the cookie has no expiration time set, will return
                         <constant>NULL</constant>.
                         <constant>NULL</constant>.
                     </para>
                     </para>
                 </listitem>
                 </listitem>
@@ -248,8 +251,8 @@ echo $cookie;
             <itemizedlist>
             <itemizedlist>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>boolean isSecure()</code>: Check whether the cookie is set to be sent
-                        over secure connections only. Generally speaking, if
+                        <methodname>isSecure()</methodname>: Check whether the cookie is set to be
+                        sent over secure connections only. Generally speaking, if
                         <constant>TRUE</constant> the cookie should only be sent over
                         <constant>TRUE</constant> the cookie should only be sent over
                         <acronym>HTTPS</acronym>.
                         <acronym>HTTPS</acronym>.
                     </para>
                     </para>
@@ -257,7 +260,7 @@ echo $cookie;
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>boolean isExpired(int $time = null)</code>: Check whether the cookie
+                        <methodname>isExpired(int $time = null)</methodname>: Check whether the cookie
                         is expired or not. If the cookie has no expiration time, will always return
                         is expired or not. If the cookie has no expiration time, will always return
                         <constant>TRUE</constant>. If $time is provided, it will override the
                         <constant>TRUE</constant>. If $time is provided, it will override the
                         current time stamp as the time to check the cookie against.
                         current time stamp as the time to check the cookie against.
@@ -266,7 +269,7 @@ echo $cookie;
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>boolean isSessionCookie()</code>: Check whether the cookie is a
+                        <methodname>isSessionCookie()</methodname>: Check whether the cookie is a
                         "session cookie" - that is a cookie with no expiration time, which is meant
                         "session cookie" - that is a cookie with no expiration time, which is meant
                         to expire when the session ends.
                         to expire when the session ends.
                     </para>
                     </para>
@@ -316,23 +319,23 @@ echo ($cookie->isSessionCookie() ? 'Yes' : 'No');
             the match() method. This method is used to test a cookie against a given
             the match() method. This method is used to test a cookie against a given
             <acronym>HTTP</acronym> request scenario, in order to tell whether the cookie should be
             <acronym>HTTP</acronym> request scenario, in order to tell whether the cookie should be
             sent in this request or not. The method has the following syntax and parameters:
             sent in this request or not. The method has the following syntax and parameters:
-            <code>boolean Zend_Http_Cookie->match(mixed $uri, [boolean $matchSessionCookies, [int
-                $now]]);</code>
+            <command>Zend_Http_Cookie->match(mixed $uri, [boolean $matchSessionCookies, [int
+                $now]]);</command>
 
 
             <itemizedlist>
             <itemizedlist>
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>mixed $uri</code>: A <classname>Zend_Uri_Http</classname> object with
-                        a domain name and path to be checked. Optionally, a string representing a
-                        valid <acronym>HTTP</acronym> <acronym>URL</acronym> can be passed instead.
-                        The cookie will match if the <acronym>URL</acronym>'s scheme (HTTP or
-                        <acronym>HTTPS</acronym>), domain and path all match.
+                        <varname>$uri</varname>: A <classname>Zend_Uri_Http</classname> object
+                        with a domain name and path to be checked. Optionally, a string representing
+                        a valid <acronym>HTTP</acronym> <acronym>URL</acronym> can be passed
+                        instead. The cookie will match if the <acronym>URL</acronym>'s scheme (HTTP
+                        or <acronym>HTTPS</acronym>), domain and path all match.
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>boolean $matchSessionCookies</code>: Whether session cookies should be
+                        <varname>$matchSessionCookies</varname>: Whether session cookies should be
                         matched or not. Defaults to <constant>TRUE</constant>. If set to
                         matched or not. Defaults to <constant>TRUE</constant>. If set to
                         <constant>FALSE</constant>, cookies with no expiration time will never
                         <constant>FALSE</constant>, cookies with no expiration time will never
                         match.
                         match.
@@ -341,7 +344,7 @@ echo ($cookie->isSessionCookie() ? 'Yes' : 'No');
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <code>int $now</code>: Time (represented as UNIX time stamp) to check a
+                        <varname>$now</varname>: Time (represented as UNIX time stamp) to check a
                         cookie against for expiration. If not specified, will default to the current
                         cookie against for expiration. If not specified, will default to the current
                         time.
                         time.
                     </para>
                     </para>