Przeglądaj źródła

[MANUAL] English:

- several manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22768 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 15 lat temu
rodzic
commit
3e400a4dd8

+ 8 - 8
documentation/manual/en/module_specs/Zend_Service_SlideShare.xml

@@ -252,8 +252,8 @@ print "Number of views: {$slideshow->getNumViews()}<br/>\n";
 
 
                 <para>
                 <para>
                     You can retrieve slide shows which contain one or more specific tags by using
                     You can retrieve slide shows which contain one or more specific tags by using
-                    the <code>getSlideShowsByTag</code> method and providing one or more tags which
-                    the slide show must have assigned to it in order to be retrieved
+                    the <methodname>getSlideShowsByTag()</methodname> method and providing one or
+                    more tags which the slide show must have assigned to it in order to be retrieved
                 </para>
                 </para>
             </listitem>
             </listitem>
 
 
@@ -264,8 +264,8 @@ print "Number of views: {$slideshow->getNumViews()}<br/>\n";
 
 
                 <para>
                 <para>
                     You can retrieve slide shows which are a member of a specific group using the
                     You can retrieve slide shows which are a member of a specific group using the
-                    <code>getSlideShowsByGroup</code> method and providing the name of the group
-                    which the slide show must belong to in order to be retrieved
+                    <methodname>getSlideShowsByGroup()</methodname> method and providing the name of
+                    the group which the slide show must belong to in order to be retrieved
                 </para>
                 </para>
             </listitem>
             </listitem>
         </itemizedlist>
         </itemizedlist>
@@ -302,10 +302,10 @@ foreach($ss_user as $slideshow) {
 
 
         <para>
         <para>
             By default, <classname>Zend_Service_SlideShare</classname> will cache any request
             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
-            <link linkend="zend.cache">Zend_Cache</link> object using the
-            <code>setCacheObject</code> method as shown:
+            against the web service automatically to the filesystem (default path
+            <filename>/tmp</filename>) for 12 hours. If you desire to change this behavior, you
+            must provide your own <link linkend="zend.cache">Zend_Cache</link> object using the
+            <methodname>setCacheObject()</methodname> method as shown:
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[

+ 10 - 9
documentation/manual/en/module_specs/Zend_Service_StrikeIron-AdvancedUses.xml

@@ -21,8 +21,8 @@
 
 
         <para>
         <para>
             To try a StrikeIron service that does not have a wrapper class available,
             To try a StrikeIron service that does not have a wrapper class available,
-            give the <code>wsdl</code> option to <methodname>getService()</methodname>
-            instead of the <code>class</code> option:
+            give the <property>wsdl</property> option to <methodname>getService()</methodname>
+            instead of the <property>class</property> option:
         </para>
         </para>
 
 
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -70,23 +70,24 @@ echo $result->listingName;
             Every StrikeIron client (subclass of
             Every StrikeIron client (subclass of
             <classname>Zend_Service_StrikeIron_Base</classname>) contains a
             <classname>Zend_Service_StrikeIron_Base</classname>) contains a
             <methodname>getSoapClient()</methodname> method to return the underlying instance of
             <methodname>getSoapClient()</methodname> method to return the underlying instance of
-            <code>SOAPClient</code> used to communicate with StrikeIron.
+            <classname>SOAPClient</classname> used to communicate with StrikeIron.
         </para>
         </para>
 
 
         <para>
         <para>
             <acronym>PHP</acronym>' <ulink
             <acronym>PHP</acronym>' <ulink
                 url="http://www.php.net/manual/en/function.soap-soapclient-construct.php">SOAPClient</ulink>
                 url="http://www.php.net/manual/en/function.soap-soapclient-construct.php">SOAPClient</ulink>
-            has a <code>trace</code> option that causes it to remember the <acronym>XML</acronym>
-            exchanged during the last transaction. <classname>Zend_Service_StrikeIron</classname>
-            does not enable the <code>trace</code> option by default but this can easily by changed
-            by specifying the options that will be passed to the <code>SOAPClient</code>
+            has a <property>trace</property> option that causes it to remember the
+            <acronym>XML</acronym> exchanged during the last transaction.
+            <classname>Zend_Service_StrikeIron</classname> does not enable the
+            <property>trace</property> option by default but this can easily by changed
+            by specifying the options that will be passed to the <classname>SOAPClient</classname>
             constructor.
             constructor.
         </para>
         </para>
 
 
         <para>
         <para>
             To view a SOAP transaction, call the <methodname>getSoapClient()</methodname> method
             To view a SOAP transaction, call the <methodname>getSoapClient()</methodname> method
-            to get the <code>SOAPClient</code> instance and then call the appropriate methods like
-            <ulink
+            to get the <classname>SOAPClient</classname> instance and then call the appropriate
+            methods like <ulink
                 url="http://www.php.net/manual/en/function.soap-soapclient-getlastrequest.php"><methodname>__getLastRequest()</methodname></ulink>
                 url="http://www.php.net/manual/en/function.soap-soapclient-getlastrequest.php"><methodname>__getLastRequest()</methodname></ulink>
             and <ulink
             and <ulink
                 url="http://www.php.net/manual/en/function.soap-soapclient-getlastresponse.php"><methodname>__getLastRequest()</methodname></ulink>:
                 url="http://www.php.net/manual/en/function.soap-soapclient-getlastresponse.php"><methodname>__getLastRequest()</methodname></ulink>:

+ 14 - 12
documentation/manual/en/module_specs/Zend_Service_StrikeIron-Overview.xml

@@ -190,7 +190,7 @@ $taxBasic = $strikeIron->getService(array('class' => 'SalesUseTaxBasic'));
         <para>
         <para>
             The <methodname>getService()</methodname> method will return a client for any
             The <methodname>getService()</methodname> method will return a client for any
             StrikeIron service by the name of its <acronym>PHP</acronym> wrapper class. In this
             StrikeIron service by the name of its <acronym>PHP</acronym> wrapper class. In this
-            case, the name <code>SalesUseTaxBasic</code> refers to the wrapper class
+            case, the name 'SalesUseTaxBasic' refers to the wrapper class
             <classname>Zend_Service_StrikeIron_SalesUseTaxBasic</classname>. Wrappers are
             <classname>Zend_Service_StrikeIron_SalesUseTaxBasic</classname>. Wrappers are
             included for three services and described in
             included for three services and described in
             <link linkend="zend.service.strikeiron.bundled-services">Bundled Services</link>.
             <link linkend="zend.service.strikeiron.bundled-services">Bundled Services</link>.
@@ -244,7 +244,7 @@ echo $rateInfo->GST;
 
 
         <para>
         <para>
             The result from <methodname>getTaxRateCanada()</methodname> is stored in
             The result from <methodname>getTaxRateCanada()</methodname> is stored in
-            <varname>$rateInfo</varname> and has properties like <code>province</code>
+            <varname>$rateInfo</varname> and has properties like <property>province</property>
             and <constant>GST</constant>.
             and <constant>GST</constant>.
         </para>
         </para>
 
 
@@ -300,23 +300,25 @@ Zend_Service_StrikeIron_Decorator Object
 
 
         <para>
         <para>
             In the output above, we see that the decorator (<varname>$rateInfo</varname>) wraps an
             In the output above, we see that the decorator (<varname>$rateInfo</varname>) wraps an
-            object named <code>GetTaxRateCanadaResult</code>, the result of the call to
+            object named <classname>GetTaxRateCanadaResult</classname>, the result of the call to
             <methodname>getTaxRateCanada()</methodname>.
             <methodname>getTaxRateCanada()</methodname>.
         </para>
         </para>
 
 
         <para>
         <para>
             This means that <varname>$rateInfo</varname> has public properties like
             This means that <varname>$rateInfo</varname> has public properties like
-            <code>abbreviation</code>, <code>province</code>, and <constant>GST</constant>. These
-            are accessed like <code>$rateInfo->province</code>.
+            <property>abbreviation</property>, <property>province</property>, and
+            <constant>GST</constant>. These are accessed like
+            <command>$rateInfo->province</command>.
         </para>
         </para>
 
 
         <tip>
         <tip>
             <para>
             <para>
                 StrikeIron result properties sometimes start with an uppercase letter such as
                 StrikeIron result properties sometimes start with an uppercase letter such as
-                <code>Foo</code> or <code>Bar</code> where most <acronym>PHP</acronym> object
-                properties normally start with a lowercase letter as in <code>foo</code> or
-                <code>bar</code>. The decorator will automatically do this inflection so you
-                may read a property <code>Foo</code> as <code>foo</code>.
+                <property>Foo</property> or <property>Bar</property> where most
+                <acronym>PHP</acronym> object properties normally start with a lowercase letter as
+                in <property>foo</property> or <property>bar</property>. The decorator will
+                automatically do this inflection so you may read a property <property>Foo</property>
+                as <property>foo</property>.
             </para>
             </para>
         </tip>
         </tip>
 
 
@@ -373,7 +375,7 @@ try {
             the network going down or your subscription expiring.
             the network going down or your subscription expiring.
             Failed method calls that are a common occurrence,
             Failed method calls that are a common occurrence,
             such as <methodname>getTaxRateCanada()</methodname> not finding the
             such as <methodname>getTaxRateCanada()</methodname> not finding the
-            <code>province</code> you supplied, will not result an in exception.
+            <property>province</property> you supplied, will not result an in exception.
         </para>
         </para>
 
 
         <note>
         <note>
@@ -398,7 +400,7 @@ try {
         </para>
         </para>
 
 
         <para>
         <para>
-            Each StrikeIron client returned by the <code>getService</code> method
+            Each StrikeIron client returned by the <methodname>getService()</methodname> method
             has the ability to check the subscription status for that service using
             has the ability to check the subscription status for that service using
             the <methodname>getSubscriptionInfo()</methodname> method of the client:
             the <methodname>getSubscriptionInfo()</methodname> method of the client:
         </para>
         </para>
@@ -417,7 +419,7 @@ echo $subscription->remainingHits;
 
 
         <para>
         <para>
             The <methodname>getSubscriptionInfo()</methodname> method will return an object
             The <methodname>getSubscriptionInfo()</methodname> method will return an object
-            that typically has a <code>remainingHits</code> property. It's
+            that typically has a <property>remainingHits</property> property. It's
             important to check the status on each service that you are using. If
             important to check the status on each service that you are using. If
             a method call is made to StrikeIron after the remaining hits have been
             a method call is made to StrikeIron after the remaining hits have been
             used up, an exception will occur.
             used up, an exception will occur.

+ 22 - 21
documentation/manual/en/module_specs/Zend_Service_Technorati.xml

@@ -132,9 +132,9 @@ $topTags = $technorati->topTags();
             <classname>Zend_Service_Technorati_*ResultSet</classname> objects. A result set object
             <classname>Zend_Service_Technorati_*ResultSet</classname> objects. A result set object
             is basically a collection of result objects. It extends the basic
             is basically a collection of result objects. It extends the basic
             <classname>Zend_Service_Technorati_ResultSet</classname> class and implements the
             <classname>Zend_Service_Technorati_ResultSet</classname> class and implements the
-            <code>SeekableIterator</code> <acronym>PHP</acronym> interface. The best way to consume
-            a result set object is to loop over it with the <acronym>PHP</acronym>
-            <code>foreach</code> statement.
+            <classname>SeekableIterator</classname> <acronym>PHP</acronym> interface. The best way
+            to consume a result set object is to loop over it with the <acronym>PHP</acronym>
+            <methodname>foreach()</methodname> statement.
         </para>
         </para>
 
 
         <example id="zend.service.technorati.consuming-results.example-1">
         <example id="zend.service.technorati.consuming-results.example-1">
@@ -158,8 +158,8 @@ foreach ($resultSet as $result) {
 
 
         <para>
         <para>
             Because <classname>Zend_Service_Technorati_ResultSet</classname> implements the
             Because <classname>Zend_Service_Technorati_ResultSet</classname> implements the
-            <code>SeekableIterator</code> interface, you can seek a specific result object using its
-            position in the result collection.
+            <classname>SeekableIterator</classname> interface, you can seek a specific result
+            object using its position in the result collection.
         </para>
         </para>
 
 
         <example id="zend.service.technorati.consuming-results.example-2">
         <example id="zend.service.technorati.consuming-results.example-2">
@@ -182,9 +182,9 @@ $result = $resultSet->current();
 
 
         <note>
         <note>
             <para>
             <para>
-                <code>SeekableIterator</code> works as an array and counts positions starting from
-                index 0. Fetching position number 1 means getting the second result in the
-                collection.
+                <classname>SeekableIterator</classname> works as an array and counts positions
+                starting from index 0. Fetching position number 1 means getting the second result
+                in the collection.
             </para>
             </para>
         </note>
         </note>
 
 
@@ -245,7 +245,7 @@ echo "</ol>";
         </para>
         </para>
 
 
         <para>
         <para>
-            You should always wrap a Technorati query with a <code>try</code>...<code>catch</code>
+            You should always wrap a Technorati query with a <command>try ... catch</command>
             block.
             block.
         </para>
         </para>
 
 
@@ -307,55 +307,55 @@ echo "Daily Usage: " . $key->getApiQueries() . "/" .
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         <link
                         <link
-                            linkend="zend.service.technorati.queries.cosmos"><code>Cosmos</code></link>
+                            linkend="zend.service.technorati.queries.cosmos">Cosmos</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         <link
                         <link
-                            linkend="zend.service.technorati.queries.search"><code>Search</code></link>
+                            linkend="zend.service.technorati.queries.search">Search</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
-                        <link linkend="zend.service.technorati.queries.tag"><code>Tag</code></link>
+                        <link linkend="zend.service.technorati.queries.tag">Tag</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         <link
                         <link
-                            linkend="zend.service.technorati.queries.dailycounts"><code>DailyCounts</code></link>
+                            linkend="zend.service.technorati.queries.dailycounts">DailyCounts</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         <link
                         <link
-                            linkend="zend.service.technorati.queries.toptags"><code>TopTags</code></link>
+                            linkend="zend.service.technorati.queries.toptags">TopTags</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         <link
                         <link
-                            linkend="zend.service.technorati.queries.bloginfo"><code>BlogInfo</code></link>
+                            linkend="zend.service.technorati.queries.bloginfo">BlogInfo</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         <link
                         <link
-                            linkend="zend.service.technorati.queries.blogposttags"><code>BlogPostTags</code></link>
+                            linkend="zend.service.technorati.queries.blogposttags">BlogPostTags</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
 
 
                 <listitem>
                 <listitem>
                     <para>
                     <para>
                         <link
                         <link
-                            linkend="zend.service.technorati.queries.getinfo"><code>GetInfo</code></link>
+                            linkend="zend.service.technorati.queries.getinfo">GetInfo</link>
                     </para>
                     </para>
                 </listitem>
                 </listitem>
             </itemizedlist>
             </itemizedlist>
@@ -629,8 +629,8 @@ echo "</ol>";
             result set which can be easily iterated, with each result being contained in a type
             result set which can be easily iterated, with each result being contained in a type
             result object. All result set classes extend
             result object. All result set classes extend
             <classname>Zend_Service_Technorati_ResultSet</classname> class and implement the
             <classname>Zend_Service_Technorati_ResultSet</classname> class and implement the
-            <code>SeekableIterator</code> interface, allowing for easy iteration and seeking to a
-            specific result.
+            <classname>SeekableIterator</classname> interface, allowing for easy iteration and
+            seeking to a specific result.
 
 
             <itemizedlist>
             <itemizedlist>
                 <listitem>
                 <listitem>
@@ -778,8 +778,9 @@ echo "</ol>";
 
 
             <para>
             <para>
                 <classname>Zend_Service_Technorati_ResultSet</classname> implements the
                 <classname>Zend_Service_Technorati_ResultSet</classname> implements the
-                <acronym>PHP</acronym> <code>SeekableIterator</code> interface, and you can iterate
-                all result objects via the <acronym>PHP</acronym> <code>foreach</code> statement.
+                <acronym>PHP</acronym> <classname>SeekableIterator</classname> interface, and you
+                can iterate all result objects via the <acronym>PHP</acronym>
+                <methodname>foreach()</methodname> statement.
             </para>
             </para>
 
 
             <example id="zend.service.technorati.classes.resultset.example-1">
             <example id="zend.service.technorati.classes.resultset.example-1">