Просмотр исходного кода

[MANUAL] English:

- some manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22392 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 15 лет назад
Родитель
Сommit
6c54fc3f32

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

@@ -372,7 +372,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                         </row>
 
                         <row>
-                            <entry>hub.lease_seconds</entry>
+                            <entry><property>hub.lease_seconds</property></entry>
                             <entry>2592000</entry>
 
                             <entry>
@@ -391,7 +391,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                         </row>
 
                         <row>
-                            <entry>hub.mode</entry>
+                            <entry><property>hub.mode</property></entry>
                             <entry>subscribe</entry>
 
                             <entry>
@@ -403,7 +403,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                         </row>
 
                         <row>
-                            <entry>hub.topic</entry>
+                            <entry><property>hub.topic</property></entry>
                             <entry>http://www.example.net/rss.xml</entry>
 
                             <entry>
@@ -416,7 +416,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                         </row>
 
                         <row>
-                            <entry>hub.verify</entry>
+                            <entry><property>hub.verify</property></entry>
                             <entry>sync</entry>
 
                             <entry>
@@ -430,7 +430,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                         </row>
 
                         <row>
-                            <entry>hub.verify</entry>
+                            <entry><property>hub.verify</property></entry>
                             <entry>async</entry>
 
                             <entry>
@@ -444,7 +444,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                         </row>
 
                         <row>
-                            <entry>hub.verify_token</entry>
+                            <entry><property>hub.verify_token</property></entry>
                             <entry>3065919804abcaa7212ae89.879827871253878386</entry>
 
                             <entry>

+ 21 - 16
documentation/manual/en/module_specs/Zend_Feed_Reader.xml

@@ -10,7 +10,7 @@
             <classname>Zend_Feed_Reader</classname> is a component used to
             consume <acronym>RSS</acronym> and Atom feeds of any version, including
             <acronym>RDF</acronym>/<acronym>RSS</acronym> 1.0,
-            <acronym>RSS</acronym> 2.0 and Atom 0.3/1.0. The <acronym>API</acronym> for
+            <acronym>RSS</acronym> 2.0, Atom 0.3 and Atom 1.0. The <acronym>API</acronym> for
             retrieving feed data is
             deliberately simple since <classname>Zend_Feed_Reader</classname> is
             capable of searching any feed of any type for the information
@@ -42,7 +42,7 @@
             <acronym>URI</acronym> if
             the cache is valid. Second, the Feed and Entry level <acronym>API</acronym> is backed
             by an internal cache (non-persistant) so repeat <acronym>API</acronym> calls for the
-            same feed will avoid additional <acronym>DOM</acronym>/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
             <acronym>HTTP</acronym> Conditional <acronym>GET</acronym> requests
             which allow servers to issue an empty 304 response when the
@@ -433,7 +433,7 @@ foreach ($links as $link) {
             types from the various feed and entry level methods may include an object
             of type <classname>Zend_Feed_Reader_Collection_CollectionAbstract</classname>.
             Despite the special class name which I'll explain below, this is just a simple
-            subclass of SPL's <classname>ArrayObject</classname>.
+            subclass of <acronym>SPL</acronym>'s <classname>ArrayObject</classname>.
         </para>
 
         <para>
@@ -487,8 +487,9 @@ foreach ($categories as $cat) {
             as a simple array using the <methodname>getValues()</methodname> method. The concept
             of "most relevant" is obviously a judgement call. For categories it means the category
             labels (not the terms or schemes) while for authors it would be the authors' names
-            (not their email addresses or URIs). The simple array is flat (just values) and passed
-            through <methodname>array_unique()</methodname> to remove duplication.
+            (not their email addresses or <acronym>URI</acronym>s). The simple array is flat (just
+            values) and passed through <methodname>array_unique()</methodname> to remove
+            duplication.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -508,10 +509,10 @@ $labels = $categories->getValues();
         <title>Retrieving Feed Information</title>
 
         <para>
-            Retrieving information from a feed (we'll cover entries/items in the
+            Retrieving information from a feed (we'll cover entries and items in the
             next section though they follow identical principals) uses a clearly
             defined <acronym>API</acronym> which is exactly the same regardless of whether the feed
-            in question is <acronym>RSS</acronym>/<acronym>RDF</acronym>/Atom. The same goes for
+            in question is <acronym>RSS</acronym>, <acronym>RDF</acronym> or Atom. The same goes for
             sub-versions of these standards and we've tested every single
             <acronym>RSS</acronym> and Atom version. While
             the underlying feed <acronym>XML</acronym> can differ substantially in terms of the
@@ -601,7 +602,8 @@ $labels = $categories->getValues();
                             Returns the <acronym>URI</acronym> of this feed, which may be the
                             same as the <acronym>URI</acronym> used to import the feed. There
                             are important cases where the feed link may differ because the source
-                            URI is being updated and is intended to be removed in the future.
+                            <acronym>URI</acronym> is being updated and is intended to be removed in
+                            the future.
                         </entry>
                     </row>
 
@@ -700,7 +702,7 @@ $labels = $categories->getValues();
                             Returns a <classname>Zend_Feed_Reader_Collection_Category</classname>
                             object containing the details of any categories associated with the
                             overall feed. The supported fields include "term" (the machine readable
-                            category name), "scheme" (the categorisation scheme/domain for this
+                            category name), "scheme" (the categorisation scheme and domain for this
                             category), and "label" (a <acronym>HTML</acronym> decoded human readable
                             category name). Where any of the three fields are absent from the field,
                             they are either set to the closest available alternative or, in the case
@@ -740,7 +742,7 @@ $labels = $categories->getValues();
             (Atom may be used to supplement <acronym>RSS</acronym>'s syntax)? Failing that, we
             could simply look at the entries, pick the most recent, and use its
             <command>&lt;pubDate&gt;</command> element. Assuming it exists... Many
-            feeds also use Dublin Core 1.0/1.1 <command>&lt;dc:date&gt;</command>
+            feeds also use Dublin Core 1.0 or 1.1 <command>&lt;dc:date&gt;</command>
             elements for feeds and entries. Or we could find Atom lurking again.
         </para>
 
@@ -817,7 +819,8 @@ $labels = $categories->getValues();
                             Returns the encoding of the source <acronym>XML</acronym> document
                             (note: this cannot account for errors such as the
                             server sending documents in a different encoding). Where not
-                            defined, the default UTF-8 encoding of Unicode is applied.
+                            defined, the default <acronym>UTF-8</acronym> encoding of Unicode is
+                            applied.
                         </entry>
                     </row>
 
@@ -1013,9 +1016,10 @@ $labels = $categories->getValues();
                             attributes from a multi-media &lt;enclosure&gt; element including
                             as array keys: <emphasis>url</emphasis>,
                             <emphasis>length</emphasis>, <emphasis>type</emphasis>.
-                            In accordance with the RSS Best Practices Profile of the RSS
-                            Advisory Board, no support is offers for multiple enclosures
-                            since such support forms no part of the RSS specification.
+                            In accordance with the <acronym>RSS</acronym> Best Practices Profile of
+                            the <acronym>RSS</acronym> Advisory Board, no support is offers for
+                            multiple enclosures since such support forms no part of the
+                            <acronym>RSS</acronym> specification.
                         </entry>
                     </row>
 
@@ -1057,7 +1061,7 @@ $labels = $categories->getValues();
                             Returns a <classname>Zend_Feed_Reader_Collection_Category</classname>
                             object containing the details of any categories associated with the
                             entry. The supported fields include "term" (the machine readable
-                            category name), "scheme" (the categorisation scheme/domain for this
+                            category name), "scheme" (the categorisation scheme and domain for this
                             category), and "label" (a <acronym>HTML</acronym> decoded human readable
                             category name). Where any of the three fields are absent from the field,
                             they are either set to the closest available alternative or, in the case
@@ -1168,7 +1172,8 @@ $labels = $categories->getValues();
                             Returns the encoding of the source <acronym>XML</acronym> document
                             (note: this cannot account for errors such as the server sending
                             documents in a different encoding). The default encoding applied
-                            in the absence of any other is the UTF-8 encoding of Unicode.
+                            in the absence of any other is the <acronym>UTF-8</acronym> encoding of
+                            Unicode.
                         </entry>
                     </row>
 

+ 14 - 13
documentation/manual/en/module_specs/Zend_Feed_Writer.xml

@@ -9,11 +9,12 @@
         <para>
             <classname>Zend_Feed_Writer</classname> is the sibling component to
             <classname>Zend_Feed_Reader</classname> responsible for generating feeds for output. It
-            supports the Atom 1.0 specification (RFC 4287) and <acronym>RSS</acronym> 2.0 as
-            specified by the <acronym>RSS</acronym> Advisory Board (<acronym>RSS</acronym> 2.0.11).
-            It does not deviate from these standards. It does, however, offer a simple Extension
-            system which allows for any extension and module for either of these two specifications
-            to be implemented if they are not provided out of the box.
+            supports the Atom 1.0 specification (<acronym>RFC</acronym> 4287) and
+            <acronym>RSS</acronym> 2.0 as specified by the <acronym>RSS</acronym> Advisory Board
+            (<acronym>RSS</acronym> 2.0.11). It does not deviate from these standards. It does,
+            however, offer a simple Extension system which allows for any extension and module for
+            either of these two specifications to be implemented if they are not provided out of the
+            box.
         </para>
 
         <para>
@@ -68,8 +69,8 @@
             <classname>Zend_Feed_Writer_Deleted</classname>. The former implements Atom 2.0 source
             elements which carry source feed metadata for a specific entry within an aggregate feed
             (i.e. the current feed is not the entry's original source). The latter implements the
-            Atom Tombstones RFC allowing feeds to carry references to entries which have been
-            deleted.
+            Atom Tombstones <acronym>RFC</acronym> allowing feeds to carry references to entries
+            which have been deleted.
         </para>
 
         <para>
@@ -109,7 +110,7 @@
         <para>
             Using <classname>Zend_Feed_Writer</classname> is as simple as setting data and
             triggering the renderer. Here is an example to generate a minimal Atom 1.0 feed.
-            As this demonstrates, each feed/entry uses a separate data container.
+            As this demonstrates, each feed or entry uses a separate data container.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -516,8 +517,8 @@ $out = $feed->export('atom');
         <note>
             <para>
                 In addition to these setters, there are also matching getters to retrieve data from
-                the Entry data container. For example, <methodname>setImage()</methodname> is matched
-                with a <methodname>getImage()</methodname> method.
+                the Entry data container. For example, <methodname>setImage()</methodname> is
+                matched with a <methodname>getImage()</methodname> method.
             </para>
         </note>
 
@@ -675,7 +676,7 @@ $out = $feed->export('atom');
                         <entry>
                             Sets the number of comments associated with this entry. Rendering
                             differs between <acronym>RSS</acronym> and Atom 2.0 depending
-                            on the element/attribute needed.
+                            on the element or attribute needed.
                         </entry>
                     </row>
 
@@ -712,8 +713,8 @@ $out = $feed->export('atom');
                         <entry><methodname>setEncoding()</methodname></entry>
 
                         <entry>
-                            Sets the encoding of entry text. This will default to UTF-8 which
-                            is the preferred encoding.
+                            Sets the encoding of entry text. This will default to
+                            <acronym>UTF-8</acronym> which is the preferred encoding.
                         </entry>
                     </row>
                 </tbody>