浏览代码

[MANUAL] English:

- some manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22068 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 15 年之前
父节点
当前提交
979db9c3df

+ 45 - 43
documentation/manual/en/module_specs/Zend_Gdata_Books.xml

@@ -50,16 +50,16 @@
 
         <para>
             The most common action is to retrieve a list of books that match a
-            search query. To do so you create a <code>VolumeQuery</code> object
-            and pass it to the <code>Books::getVolumeFeed</code> method.
+            search query. To do so you create a <classname>VolumeQuery</classname> object
+            and pass it to the <methodname>Books::getVolumeFeed()</methodname> method.
         </para>
 
         <para>
             For example, to perform a keyword query, with a filter on
             viewability to restrict the results to partial or full view books, use
-            the <code>setMinViewability</code> and <code>setQuery</code> methods
-            of the <code>VolumeQuery</code> object. The following code snippet prints
-            the title and viewability of all volumes whose metadata or text matches
+            the <methodname>setMinViewability()</methodname> and <methodname>setQuery()</methodname>
+            methods of the <classname>VolumeQuery</classname> object. The following code snippet
+            prints the title and viewability of all volumes whose metadata or text matches
             the query term "domino":
         </para>
 
@@ -80,8 +80,8 @@ foreach ($feed as $entry) {
 ]]></programlisting>
 
         <para>
-            The <code>Query</code> class, and subclasses like
-            <code>VolumeQuery</code>, are responsible for constructing feed
+            The <classname>Query</classname> class, and subclasses like
+            <classname>VolumeQuery</classname>, are responsible for constructing feed
             <acronym>URL</acronym>s. The VolumeQuery shown above constructs a <acronym>URL</acronym>
             equivalent to the following:
         </para>
@@ -96,63 +96,63 @@ http://www.google.com/books/feeds/volumes?q=keyword&amp;min-viewability=partial
         </para>
 
         <para>
-            Here are some of the most common <code>VolumeQuery</code>
+            Here are some of the most common <classname>VolumeQuery</classname>
             methods for setting search parameters:
         </para>
 
         <para>
-            <code>setQuery:</code> Specifies a search
+            <methodname>setQuery()</methodname>: Specifies a search
             query term. Book Search searches all book metadata and full text for
             books matching the term. Book metadata includes titles, keywords,
             descriptions, author names, and subjects.
             Note that any spaces, quotes or other punctuation in the parameter
-            value must be <acronym>URL</acronym>-escaped. (Use a plus (<code>+</code>) for a space.)
-            To search for an exact phrase, enclose the phrase in quotation marks.
+            value must be <acronym>URL</acronym>-escaped (Use a plus (<emphasis>+</emphasis>) for a
+            space). To search for an exact phrase, enclose the phrase in quotation marks.
             For example, to search for books matching the phrase "spy plane", set
-            the <code>q</code> parameter to <code>%22spy+plane%22</code>.
+            the <property>q</property> parameter to <command>%22spy+plane%22</command>.
             You can also use any of the <ulink url="http://books.google.com/advanced_book_search">
             advanced search operators</ulink> supported by Book Search. For example,
-            <code>jane+austen+-inauthor:austen</code> returns matches that mention
+            <command>jane+austen+-inauthor:austen</command> returns matches that mention
             (but are not authored by) Jane Austen.
         </para>
 
         <para>
-            <code>setStartIndex:</code> Specifies
+            <methodname>setStartIndex()</methodname>: Specifies
             the index of the first matching result that should be included in the
             result set. This parameter uses a one-based index, meaning the first
             result is 1, the second result is 2 and so forth. This parameter works
             in conjunction with the max-results
             parameter to determine which results to return. For example, to
             request the third set of 10 results—results 21-30—set
-            the <code>start-index</code> parameter to <code>21</code> and the
-            max-results parameter to <code>10</code>.
+            the <property>start-index</property> parameter to <emphasis>21</emphasis> and the
+            max-results parameter to <emphasis>10</emphasis>.
             Note: This isn't a general cursoring
             mechanism. If you first send a query with
-            <code>?start-index=1&amp;max-results=10</code> and then send another
-            query with <code>?start-index=11&amp;max-results=10</code>, the
+            <command>?start-index=1&amp;max-results=10</command> and then send another
+            query with <command>?start-index=11&amp;max-results=10</command>, the
             service cannot guarantee that the results are equivalent to
-            <code>?start-index=1&amp;max-results=20</code>, because insertions and
+            <command>?start-index=1&amp;max-results=20</command>, because insertions and
             deletions could have taken place in between the two queries.
         </para>
 
         <para>
-            <code>setMaxResults:</code>
+            <methodname>setMaxResults()</methodname>:
             Specifies the maximum number of results that should be included
             in the result set. This parameter works in conjunction with the
             start-index parameter to determine which
             results to return. The default value of this parameter is
-            <code>10</code> and the maximum value is <code>20</code>.
+            <emphasis>10</emphasis> and the maximum value is <emphasis>20</emphasis>.
         </para>
 
         <para>
-            <code>setMinViewability:</code> Allows you to filter the results according to the books'
-            <ulink
+            <methodname>setMinViewability()</methodname>: Allows you to filter the results according
+            to the books' <ulink
                 url="http://code.google.com/apis/books/docs/dynamic-links.html#terminology">viewability
-                status</ulink>. This parameter accepts one of three values: <code>'none'</code>
-            (the default, returning all matching books regardless of
-            viewability), <code>'partial_view'</code> (returning only books
+                status</ulink>. This parameter accepts one of three values:
+            <emphasis>'none'</emphasis> (the default, returning all matching books regardless of
+            viewability), <emphasis>'partial_view'</emphasis> (returning only books
             that the user can preview or view in their entirety), or
-            <code>'full_view'</code> (returning only books that the user can
+            <emphasis>'full_view'</emphasis> (returning only books that the user can
             view in their entirety).
         </para>
 
@@ -189,7 +189,7 @@ http://www.google.com/books/feeds/p/PARTNER_COBRAND_ID/volumes?q=ball+-soccer
 
             <para>
                 To specify an alternate <acronym>URL</acronym> when querying a volume feed, you can
-                provide an extra parameter to <code>newVolumeQuery</code>
+                provide an extra parameter to <methodname>newVolumeQuery()</methodname>
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -217,9 +217,9 @@ $query =
             </para>
 
             <para>
-                To add a rating, add a <code>Rating</code> object to a
-                <code>VolumeEntry</code> and post it to the annotation feed.
-                In the example below, we start from an empty <code>VolumeEntry</code> object.
+                To add a rating, add a <classname>Rating</classname> object to a
+                <classname>VolumeEntry</classname> and post it to the annotation feed. In the
+                example below, we start from an empty <classname>VolumeEntry</classname> object.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -244,10 +244,10 @@ $books->insertVolume($entry, Zend_Gdata_Books::MY_ANNOTATION_FEED_URI);
                 <title>Adding a review</title>
 
                 <para>
-                    To add a review, add a <code>Review</code> object to a
-                    <code>VolumeEntry</code> and post it to the annotation
+                    To add a review, add a <classname>Review</classname> object to a
+                    <classname>VolumeEntry</classname> and post it to the annotation
                     feed. In the example below, we start from an existing
-                    <code>VolumeEntry</code> object.
+                    <classname>VolumeEntry</classname> object.
                 </para>
 
                 <programlisting language="php"><![CDATA[
@@ -294,9 +294,9 @@ $books->updateVolume($entry, $entryUrl);
                 <title>Submitting a set of labels</title>
 
                 <para>
-                    To submit labels, add a <code>Category</code> object
+                    To submit labels, add a <classname>Category</classname> object
                     with the scheme <constant>LABELS_SCHEME</constant> to a
-                    <code>VolumeEntry</code> and post it to the annotation feed.
+                    <classname>VolumeEntry</classname> and post it to the annotation feed.
                 </para>
 
                 <programlisting language="php"><![CDATA[
@@ -318,7 +318,8 @@ $books->insertVolume($entry, Zend_Gdata_Books::MY_ANNOTATION_FEED_URI);
                 submitted by a given user. Annotations include reviews, ratings, and
                 labels. To retrieve any user's annotations, you can send an
                 unauthenticated request that includes the user's user ID. To retrieve the
-                authenticated user's annotations, use the value <code>me</code> as the user ID.
+                authenticated user's annotations, use the value <emphasis>me</emphasis> as the user
+                ID.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -351,7 +352,7 @@ foreach ($feed as $entry) {
             <para>
                 If you retrieved an annotation entry containing ratings,
                 reviews, and/or labels, you can remove all annotations
-                by calling <code>deleteVolume</code> on that entry.
+                by calling <methodname>deleteVolume()</methodname> on that entry.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -395,7 +396,7 @@ $books->deleteVolume($entry);
                 <para>
                     To retrieve the user's books, send a query to the
                     My Library feed. To get the library of the authenticated
-                    user, use <code>me</code> in place of <constant>USER_ID</constant>.
+                    user, use <emphasis>me</emphasis> in place of <constant>USER_ID</constant>.
                 </para>
 
                 <programlisting language="php"><![CDATA[
@@ -405,7 +406,7 @@ $feed = $books->getUserLibraryFeed();
                 <para>
                     Note: The feed may not contain all of the user's books, because
                     there's a default limit on the number of results returned. For
-                    more information, see the <code>max-results</code> query parameter in
+                    more information, see the <property>max-results</property> query parameter in
                     <ulink url="#zend.gdata.books.searching_for_books">Searching for books</ulink>.
                 </para>
             </sect4>
@@ -418,7 +419,7 @@ $feed = $books->getUserLibraryFeed();
                         url="#zend.gdata.books.searching_for_books">search across all books</ulink>,
                     you can do a full-text search over just the books in a
                     user's library. To do this, just set the appropriate
-                    paramters on the <code>VolumeQuery</code> object.
+                    paramters on the <classname>VolumeQuery</classname> object.
                 </para>
 
                 <para>
@@ -490,7 +491,7 @@ $books->insertVolume(
 
                 <para>
                     The following example adds an existing
-                    <code>VolumeEntry</code> object to the library:
+                    <classname>VolumeEntry</classname> object to the library:
                 </para>
 
                 <programlisting language="php"><![CDATA[
@@ -506,7 +507,8 @@ $books->insertVolume(
 
                 <para>
                     To remove a book from a user's library, call
-                    <code>deleteVolume</code> on the <code>VolumeEntry</code> object.
+                    <methodname>deleteVolume()</methodname> on the
+                    <classname>VolumeEntry</classname> object.
                 </para>
 
                 <programlisting language="php"><![CDATA[

+ 39 - 35
documentation/manual/en/module_specs/Zend_Gdata_Calendar.xml

@@ -254,7 +254,7 @@ $service = new Zend_Gdata_Calendar();
         <para>
             The calendar service supports retrieving a list of calendars for the authenticated
             user. This is the same list of calendars which are displayed in the Google Calendar
-            UI, except those marked as "<code>hidden</code>" are also available.
+            UI, except those marked as "<emphasis>hidden</emphasis>" are also available.
         </para>
 
         <para>
@@ -368,9 +368,9 @@ echo "</ul>";
                 class and specifies the private visibility feed, which requires that an
                 authenticated connection is available to the calendar servers. If a MagicCookie is
                 being used for authentication, the visibility should be instead set to
-                "<code>private-magicCookieValue</code>", where magicCookieValue is the random
-                string obtained when viewing the private <acronym>XML</acronym> address in the
-                Google Calendar UI. Events are requested chronologically by start time and only
+                "<emphasis>private-magicCookieValue</emphasis>", where magicCookieValue is the
+                random string obtained when viewing the private <acronym>XML</acronym> address in
+                the Google Calendar UI. Events are requested chronologically by start time and only
                 events occurring in the future are returned.
             </para>
 
@@ -416,9 +416,9 @@ echo "</ul>";
             <para>
                 To print out all events within a certain range, for example from December 1,
                 2006 through December 15, 2007, add the following two lines to the previous sample.
-                Take care to remove "<code>$query->setFutureevents('true')</code>", since
-                <code>futureevents</code> will override <code>startMin</code> and
-                <code>startMax</code>.
+                Take care to remove "<command>$query->setFutureevents('true')</command>", since
+                <property>futureevents</property> will override <property>startMin</property> and
+                <property>startMax</property>.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -427,8 +427,9 @@ $query->setStartMax('2006-12-16');
 ]]></programlisting>
 
             <para>
-                Note that <code>startMin</code> is inclusive whereas <code>startMax</code> is
-                exclusive. As a result, only events through 2006-12-15 23:59:59 will be returned.
+                Note that <property>startMin</property> is inclusive whereas
+                <property>startMax</property> is exclusive. As a result, only events through
+                2006-12-15 23:59:59 will be returned.
             </para>
         </sect3>
 
@@ -643,17 +644,18 @@ $newEvent = $service->insertEvent($event);
 
             <para>
                 An event's starting time and duration are determined by the value of its
-                <code>when</code> property, which contains the properties
-                <code>startTime</code>, <code>endTime</code>, and <code>valueString</code>.
-                <code>StartTime</code> and <code>EndTime</code> control the duration of the
-                event, while the <code>valueString</code> property is currently unused.
+                <property>when</property> property, which contains the properties
+                <property>startTime</property>, <property>endTime</property>, and
+                <property>valueString</property>. <emphasis>StartTime</emphasis> and
+                <emphasis>EndTime</emphasis> control the duration of the
+                event, while the <property>valueString</property> property is currently unused.
             </para>
 
             <para>
                 All-day events can be scheduled by specifying only the date omitting the time when
-                setting <code>startTime</code> and <code>endTime</code>. Likewise, zero-duration
-                events can be specified by omitting the <code>endTime</code>. In all cases,
-                date/time values should be provided in
+                setting <property>startTime</property> and <property>endTime</property>. Likewise,
+                zero-duration events can be specified by omitting the <property>endTime</property>.
+                In all cases, date and time values should be provided in
                 <ulink url="http://www.ietf.org/rfc/rfc3339.txt">RFC3339</ulink> format.
             </para>
 
@@ -669,20 +671,20 @@ $event->when = array($when);
 ]]></programlisting>
 
             <para>
-                The <code>when</code> attribute also controls when reminders are sent to a user.
-                Reminders are stored in an array and each event may have up to find reminders
+                The <property>when</property> attribute also controls when reminders are sent to a
+                user. Reminders are stored in an array and each event may have up to find reminders
                 associated with it.
             </para>
 
             <para>
-                For a <code>reminder</code> to be valid, it needs to have two attributes set:
-                <code>method</code> and a time. <code>Method</code> can accept one of the following
-                strings: "alert", "email", or "sms". The time should be entered as an integer and
-                can be set with either the property <code>minutes</code>, <code>hours</code>,
-                <code>days</code>, or <code>absoluteTime</code>. However, a valid request may only
-                have one of these attributes set. If a mixed time is desired, convert to the most
-                precise unit available. For example, 1 hour and 30 minutes should be entered as 90
-                minutes.
+                For a <emphasis>reminder</emphasis> to be valid, it needs to have two attributes
+                set: <property>method</property> and a time. <emphasis>Method</emphasis> can accept
+                one of the following strings: "alert", "email", or "sms". The time should be entered
+                as an integer and can be set with either the property <property>minutes</property>,
+                <property>hours</property>, <property>days</property>, or
+                <property>absoluteTime</property>. However, a valid request may only have one of
+                these attributes set. If a mixed time is desired, convert to the most precise unit
+                available. For example, 1 hour and 30 minutes should be entered as 90 minutes.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -711,7 +713,7 @@ $when->reminders = array($reminder);
 
             <para>
                 Exceptions to the recurrence pattern will usually be specified by a distinct
-                <code>recurrenceException</code> attribute. However, the iCalendar standard
+                <property>recurrenceException</property> attribute. However, the iCalendar standard
                 provides a secondary format for defining recurrences, and the possibility that
                 either may be used must be accounted for.
             </para>
@@ -759,9 +761,9 @@ $newEvent = $service->insertEvent($event);
                 QuickAdd is a feature which allows events to be created using free-form text entry.
                 For example, the string "Dinner at Joe's Diner on Thursday" would create an event
                 with the title "Dinner", location "Joe's Diner", and date "Thursday". To take
-                advantage of QuickAdd, create a new <code>QuickAdd</code> property set to
-                <constant>TRUE</constant> and store the freeform text as a <code>content</code>
-                property.
+                advantage of QuickAdd, create a new <property>QuickAdd</property> property set to
+                <constant>TRUE</constant> and store the freeform text as a
+                <property>content</property> property.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -825,9 +827,10 @@ try {
 
         <para>
             In either case, the deleted event will still show up on a user's private event feed if
-            an <code>updateMin</code> query parameter is provided. Deleted events can be
-            distinguished from regular events because they will have their <code>eventStatus</code>
-            property set to "http://schemas.google.com/g/2005#event.canceled".
+            an <property>updateMin</property> query parameter is provided. Deleted events can be
+            distinguished from regular events because they will have their
+            <property>eventStatus</property> property set to
+            "http://schemas.google.com/g/2005#event.canceled".
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -855,8 +858,9 @@ $service->delete($event->getEditLink()->href);
             Working with comments is fundamentally similar to working with events, with the only
             significant difference being that a different feed and event class should be used and
             that the additional meta-data for events such as where and when does not exist for
-            comments. Specifically, the comment's author is stored in the <code>author</code>
-            property, and the comment text is stored in the <code>content</code> property.
+            comments. Specifically, the comment's author is stored in the
+            <property>author</property> property, and the comment text is stored in the
+            <property>content</property> property.
         </para>
 
         <programlisting language="php"><![CDATA[