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

[MANUAL] English:

- manual fixes

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

+ 25 - 24
documentation/manual/en/module_specs/Zend_Db_Table.xml

@@ -135,8 +135,8 @@ class Bugs extends Zend_Db_Table_Abstract
                 The schema and table names may also be specified via constructor configuration
                 directives, which override any default values specified with the
                 <varname>$_name</varname> and <varname>$_schema</varname> properties. A schema
-                specification given with the <code>name</code> directive overrides any value
-                provided with the <code>schema</code> option.
+                specification given with the <property>name</property> directive overrides any value
+                provided with the <property>schema</property> option.
             </para>
 
             <example id="zend.db.table.defining.table-schema.example.constructor">
@@ -284,8 +284,8 @@ class Bugs extends Zend_Db_Table_Abstract
                 If application-specific logic needs to be initialized when a Table class is
                 constructed, you can select to move your tasks to the
                 <methodname>init()</methodname> method, which is called after all Table metadata has
-                been processed. This is recommended over the <code>__construct</code> method if you
-                do not need to alter the metadata in any programmatic way.
+                been processed. This is recommended over the <methodname>__construct()</methodname>
+                method if you do not need to alter the metadata in any programmatic way.
             </para>
 
             <example id="zend.db.table.defining.init.usage.example">
@@ -323,7 +323,7 @@ class Bugs extends Zend_Db_Table_Abstract
             <para>
                 The first way to provide a database adapter to a Table class is by passing it as an
                 object of type <classname>Zend_Db_Adapter_Abstract</classname> in the options array,
-                identified by the key <code>'db'</code>.
+                identified by the key '<property>db</property>'.
             </para>
 
             <example id="zend.db.table.constructing.adapter.example">
@@ -376,9 +376,9 @@ $table = new Bugs();
 
             <para>
                 The third way to provide a database adapter to a Table class is by passing a string
-                in the options array, also identified by the <code>'db'</code> key. The string is
-                used as a key to the static <classname>Zend_Registry</classname> instance, where the
-                entry at that key is an object of type
+                in the options array, also identified by the '<property>db</property>' key. The
+                string is used as a key to the static <classname>Zend_Registry</classname> instance,
+                where the entry at that key is an object of type
                 <classname>Zend_Db_Adapter_Abstract</classname>.
             </para>
 
@@ -592,11 +592,11 @@ class BugStatus extends Zend_Db_Table_Abstract
         <title>Updating Rows in a Table</title>
 
         <para>
-            You can update rows in a database table using the <code>update</code> method of a Table
-            class. This method takes two arguments: an associative array of columns to change and
-            new values to assign to these columns; and an <acronym>SQL</acronym> expression that is
-            used in a <constant>WHERE</constant> clause, as criteria for the rows to change in the
-            <constant>UPDATE</constant> operation.
+            You can update rows in a database table using the <methodname>update()</methodname>
+            method of a Table class. This method takes two arguments: an associative array of
+            columns to change and new values to assign to these columns; and an
+            <acronym>SQL</acronym> expression that is used in a <constant>WHERE</constant> clause,
+            as criteria for the rows to change in the <constant>UPDATE</constant> operation.
         </para>
 
         <example id="zend.db.table.update.example">
@@ -933,10 +933,10 @@ $rows = $table->fetchAll($select);
             </example>
 
             <para>
-                You may also pass sorting criteria in an <code>ORDER BY</code> clause, as well as
-                count and offset integer values, used to make the query return a specific subset of
-                rows. These values are used in a <constant>LIMIT</constant> clause, or in equivalent
-                logic for <acronym>RDBMS</acronym> brands that do not support the
+                You may also pass sorting criteria in an <constant>ORDER</constant> BY clause, as
+                well as count and offset integer values, used to make the query return a specific
+                subset of rows. These values are used in a <constant>LIMIT</constant> clause, or in
+                equivalent logic for <acronym>RDBMS</acronym> brands that do not support the
                 <constant>LIMIT</constant> syntax.
             </para>
 
@@ -1341,8 +1341,9 @@ $bugs = new Bugs(array('metadataCache' => $cache));
             <title>Automatic Serialization with the Cache Frontend</title>
 
             <para>
-                Since the information returned from the adapter's describeTable() method is an
-                array, ensure that the <code>automatic_serialization</code> option is set to
+                Since the information returned from the adapter's
+                <methodname>describeTable()</methodname> method is an array, ensure that the
+                <property>automatic_serialization</property> option is set to
                 <constant>TRUE</constant> for the <classname>Zend_Cache_Core</classname> frontend.
             </para>
         </note>
@@ -1397,7 +1398,7 @@ protected $_metadata = array(
 
             <para>
                 You can disable this optimization by turning of the
-                <code>metadataCacheInClass</code> flag:
+                <property>metadataCacheInClass</property> flag:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -1433,8 +1434,8 @@ $bugs->setMetadataCacheInClass(false);
 
             <para>
                 You can specify Row and Rowset classes using the Table constructor's options array,
-                in keys <code>'rowClass'</code> and <code>'rowsetClass'</code> respectively.
-                Specify the names of the classes using strings.
+                in keys '<property>rowClass</property>' and '<property>rowsetClass</property>'
+                respectively. Specify the names of the classes using strings.
             </para>
 
             <example id="zend.db.table.extending.row-rowset.example">
@@ -1586,8 +1587,8 @@ class Bugs extends Zend_Db_Table_Abstract
             </para>
 
             <para>
-                For example, if your table class name is "<code>BugsProducts</code>", it would
-                match the physical table in the database called "<code>bugs_products</code>," if
+                For example, if your table class name is "BugsProducts", it would
+                match the physical table in the database called "bugs_products", if
                 you omit the explicit declaration of the <varname>$_name</varname> class property.
                 In this inflection mapping, the class name spelled in "CamelCase" format would be
                 transformed to lower case, and words are separated with an underscore.

+ 30 - 26
documentation/manual/en/module_specs/Zend_Feed-ConsumingAtom.xml

@@ -9,16 +9,17 @@
         and iteration over entries in the feed. The main difference is in the structure of the Atom
         protocol itself. Atom is a successor to <acronym>RSS</acronym>; it is more generalized
         protocol and it is designed to deal more easily with feeds that provide their full content
-        inside the feed, splitting <acronym>RSS</acronym>' <code>description</code> tag into two
-        elements, <code>summary</code> and <code>content</code>, for that purpose.
+        inside the feed, splitting <acronym>RSS</acronym>' <property>description</property> tag into
+        two elements, <property>summary</property> and <property>content</property>, for that
+        purpose.
     </para>
 
     <example id="zend.feed.consuming-atom.example.usage">
         <title>Basic Use of an Atom Feed</title>
 
         <para>
-            Read an Atom feed and print the <code>title</code> and <code>summary</code> of each
-            entry:
+            Read an Atom feed and print the <property>title</property> and
+            <property>summary</property> of each entry:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -39,37 +40,39 @@ foreach ($feed as $entry) {
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>title</code> - The feed's title, same as <acronym>RSS</acronym>'s channel
-                    title
+                    <property>title</property> - The feed's title, same as <acronym>RSS</acronym>'s
+                    channel title
                 </para>
             </listitem>
 
             <listitem>
-                <para><code>id</code> - Every feed and entry in Atom has a unique identifier</para>
+                <para>
+                    <property>id</property> - Every feed and entry in Atom has a unique identifier
+                </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>link</code> - Feeds can have multiple links, which are distinguished by a
-                    <code>type</code> attribute
+                    <property>link</property> - Feeds can have multiple links, which are
+                    distinguished by a <property>type</property> attribute
                 </para>
 
                 <para>
                     The equivalent to <acronym>RSS</acronym>'s channel link would be
-                    <code>type="text/html"</code>. if the link is to an alternate version of the
-                    same content that's in the feed, it would have a <code>rel="alternate"</code>
-                    attribute.
+                    <command>type="text/html"</command>. if the link is to an alternate version of
+                    the same content that's in the feed, it would have a
+                    <command>rel="alternate"</command> attribute.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>subtitle</code> - The feed's description, equivalent to
+                    <property>subtitle</property> - The feed's description, equivalent to
                     <acronym>RSS</acronym>' channel description
                 </para>
 
-                <para><code>author->name()</code> - The feed author's name</para>
-                <para><code>author->email()</code> - The feed author's email address</para>
+                <para><command>author->name()</command> - The feed author's name</para>
+                <para><command>author->email()</command> - The feed author's email address</para>
             </listitem>
         </itemizedlist>
     </para>
@@ -81,50 +84,51 @@ foreach ($feed as $entry) {
     <para>
         <itemizedlist>
             <listitem>
-                <para><code>id</code> - The entry's unique identifier</para>
+                <para><property>id</property> - The entry's unique identifier</para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>title</code> - The entry's title, same as <acronym>RSS</acronym> item
-                    titles
+                    <property>title</property> - The entry's title, same as <acronym>RSS</acronym>
+                    item titles
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>link</code> - A link to another format or an alternate view of this entry
+                    <property>link</property> - A link to another format or an alternate view of
+                    this entry
                 </para>
             </listitem>
 
             <listitem>
-                <para><code>summary</code> - A summary of this entry's content</para>
+                <para><property>summary</property> - A summary of this entry's content</para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>content</code> - The full content of the entry; can be skipped if the feed
-                    just contains summaries
+                    <property>content</property> - The full content of the entry; can be skipped if
+                    the feed just contains summaries
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>author</code> - with <code>name</code> and <code>email</code> sub-tags
-                    like feeds have
+                    <property>author</property> - with <property>name</property> and
+                    <property>email</property> sub-tags like feeds have
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>published</code> - the date the entry was published, in
+                    <property>published</property> - the date the entry was published, in
                     <acronym>RFC</acronym> 3339 format
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <code>updated</code> - the date the entry was last updated, in
+                    <property>updated</property> - the date the entry was last updated, in
                     <acronym>RFC</acronym> 3339 format
                 </para>
             </listitem>

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

@@ -456,7 +456,7 @@ CREATE TABLE IF NOT EXISTS `subscription` (
                 example, you can set a different lease seconds value using
                 <methodname>Zend_Pubsubhubbub_Subscriber::setLeaseSeconds()</methodname> or show a
                 preference for the async verify mode by using
-                <code>setPreferredVerificationMode(Zend_Feed_Pubsubhubbub::VERIFICATION_MODE_ASYNC)</code>.
+                <methodname>setPreferredVerificationMode(Zend_Feed_Pubsubhubbub::VERIFICATION_MODE_ASYNC)</methodname>.
                 However the Hubs retain the capability to enforce their own preferences and for this
                 reason the component is deliberately designed to work across almost any set of
                 options with minimum end-user configuration required. Conventions are great when

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

@@ -713,15 +713,15 @@ $labels = $categories->getValues();
             will fall back on alternative elements during its search. For
             example, searching an <acronym>RSS</acronym> feed for a modification date is more
             complicated than it looks. <acronym>RSS</acronym> 2.0 feeds should include a
-            <code>&lt;lastBuildDate&gt;</code> tag and/or a
-            <code>&lt;pubDate&gt;</code> element. But what if it doesn't, maybe
+            <command>&lt;lastBuildDate&gt;</command> tag and (or) a
+            <command>&lt;pubDate&gt;</command> element. But what if it doesn't, maybe
             this is an <acronym>RSS</acronym> 1.0 feed? Perhaps it instead has an
-            <code>&lt;atom:updated&gt;</code> element with identical information
+            <command>&lt;atom:updated&gt;</command> element with identical information
             (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
-            <code>&lt;pubDate&gt;</code> element. Assuming it exists... Many
-            feeds also use Dublin Core 1.0/1.1 <code>&lt;dc:date&gt;</code>
-            elements for feeds/entries. Or we could find Atom lurking again.
+            <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>
+            elements for feeds and entries. Or we could find Atom lurking again.
         </para>
 
         <para>
@@ -1214,17 +1214,16 @@ $labels = $categories->getValues();
         <para>
             There are two types of Extensions possible, those which retrieve
             information from elements which are immediate children of the root
-            element (e.g. <code>&lt;channel&gt;</code> for <acronym>RSS</acronym> or
-            <code>&lt;feed&gt;</code> for Atom) and those who retrieve
+            element (e.g. <command>&lt;channel&gt;</command> for <acronym>RSS</acronym> or
+            <command>&lt;feed&gt;</command> for Atom) and those who retrieve
             information from child elements of an entry (e.g.
-            <code>&lt;item&gt;</code> for <acronym>RSS</acronym> or <code>&lt;entry&gt;</code> for
-            Atom). On the filesystem these are grouped as classes within
-            a namespace based on the extension standard's name. For
-            example, internally we have
-            <classname>Zend_Feed_Reader_Extension_DublinCore_Feed</classname>
+            <command>&lt;item&gt;</command> for <acronym>RSS</acronym> or
+            <command>&lt;entry&gt;</command> for Atom). On the filesystem these are grouped as
+            classes within a namespace based on the extension standard's name. For example,
+            internally we have <classname>Zend_Feed_Reader_Extension_DublinCore_Feed</classname>
             and <classname>Zend_Feed_Reader_Extension_DublinCore_Entry</classname>
             classes which are two Extensions implementing Dublin Core
-            1.0/1.1 support.
+            1.0 and 1.1 support.
         </para>
 
         <para>
@@ -1403,7 +1402,7 @@ $updatePeriod = $syndication->getUpdatePeriod();
                 new element per entry supplying the <acronym>ISBN</acronym>-10 or
                 <acronym>ISBN</acronym>-13 number of
                 the publication the entry concerns. They define the new
-                <code>&lt;isbn&gt;</code> element quite simply with a standard
+                <command>&lt;isbn&gt;</command> element quite simply with a standard
                 name and namespace <acronym>URI</acronym>:
             </para>
 
@@ -1482,7 +1481,7 @@ class My_FeedReader_Extension_JungleBooks_Entry
                 This extension is easy enough to follow. It creates a new method
                 <methodname>getIsbn()</methodname> which runs an XPath query on
                 the current entry to extract the <acronym>ISBN</acronym> number enclosed by the
-                <code>&lt;jungle:isbn&gt;</code> element. It can optionally
+                <command>&lt;jungle:isbn&gt;</command> element. It can optionally
                 store this to the internal non-persistent cache (no need to keep
                 querying the <acronym>DOM</acronym> if it's called again on the same entry). The
                 value is returned to the caller. At the end we have a protected
@@ -1519,7 +1518,7 @@ $firstIsbn = $feed->current()->getIsbn();
             <para>
                 Writing a feed level Extension is not much different. The
                 example feed from earlier included an unmentioned
-                <code>&lt;jungle:dayPopular&gt;</code> element which Jungle
+                <command>&lt;jungle:dayPopular&gt;</command> element which Jungle
                 Books have added to their standard to include a link to the
                 day's most popular book (in terms of visitor traffic). Here's
                 an Extension which adds a