Browse Source

[MANUAL] English:

- several manual fixes

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

+ 5 - 5
documentation/manual/en/module_specs/Zend_Memory-MemoryManager.xml

@@ -38,7 +38,7 @@ $memoryManager = Zend_Memory::factory('File', $backendOptions);
         </para>
         </para>
 
 
         <para>
         <para>
-            You may use the special name '<code>None</code>' as a backend name,
+            You may use the special name 'None' as a backend name,
             in addition to standard <classname>Zend_Cache</classname> backends.
             in addition to standard <classname>Zend_Cache</classname> backends.
         </para>
         </para>
 
 
@@ -47,14 +47,14 @@ $memoryManager = Zend_Memory::factory('None');
 ]]></programlisting>
 ]]></programlisting>
 
 
         <para>
         <para>
-            If you use '<code>None</code>' as the backend name, then the memory
+            If you use 'None' as the backend name, then the memory
             manager never swaps memory blocks. This is useful if you know that
             manager never swaps memory blocks. This is useful if you know that
             memory is not limited or the overall size of objects never reaches
             memory is not limited or the overall size of objects never reaches
             the memory limit.
             the memory limit.
         </para>
         </para>
 
 
         <para>
         <para>
-            The '<code>None</code>' backend doesn't need any option specified.
+            The 'None' backend doesn't need any option specified.
         </para>
         </para>
     </sect2>
     </sect2>
 
 
@@ -178,8 +178,8 @@ $memoryManager->setMemoryLimit($newLimit);     // Set memory limit in bytes
 
 
             <para>
             <para>
                 The default value is two-thirds of the value of
                 The default value is two-thirds of the value of
-                '<code>memory_limit</code>' in php.ini or 'no limit' (-1)
-                if '<code>memory_limit</code>' is not set in php.ini.
+                'memory_limit' in php.ini or 'no limit' (-1)
+                if 'memory_limit' is not set in php.ini.
             </para>
             </para>
         </sect3>
         </sect3>
 
 

+ 13 - 13
documentation/manual/en/module_specs/Zend_Mime_Message.xml

@@ -33,26 +33,26 @@
         <para>
         <para>
             <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
             <link linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
             Objects can be added to a given <classname>Zend_Mime_Message</classname> object by
             Objects can be added to a given <classname>Zend_Mime_Message</classname> object by
-            calling <code>-&gt;addPart($part)</code>
+            calling <methodname>addPart($part)</methodname>
         </para>
         </para>
 
 
         <para>
         <para>
             An array with all <link
             An array with all <link
                 linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
                 linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
-            objects in the <classname>Zend_Mime_Message</classname> is returned
-            from the method <code>-&gt;getParts()</code>. The <classname>Zend_Mime_Part</classname>
+            objects in the <classname>Zend_Mime_Message</classname> is returned from the method
+            <methodname>getParts()</methodname>. The <classname>Zend_Mime_Part</classname>
             objects can then be changed since they are stored in the array as references. If
             objects can then be changed since they are stored in the array as references. If
             parts are added to the array or the sequence is changed, the array needs
             parts are added to the array or the sequence is changed, the array needs
             to be given back to the <link
             to be given back to the <link
                 linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
                 linkend="zend.mime.part"><classname>Zend_Mime_Part</classname></link>
-            object by calling <code>-&gt;setParts($partsArray)</code>.
+            object by calling <methodname>setParts($partsArray)</methodname>.
         </para>
         </para>
 
 
         <para>
         <para>
-            The function <code>-&gt;isMultiPart()</code> will return <constant>TRUE</constant> if
-            more than one part is registered with the <classname>Zend_Mime_Message</classname>
-            object and thus the object would generate a Multipart-Mime-Message when generating the
-            actual output.
+            The function <methodname>isMultiPart()</methodname> will return
+            <constant>TRUE</constant> if more than one part is registered with the
+            <classname>Zend_Mime_Message</classname> object and thus the object would generate a
+            Multipart-Mime-Message when generating the actual output.
         </para>
         </para>
     </sect2>
     </sect2>
 
 
@@ -66,20 +66,20 @@
             object used by <classname>Zend_Mime_Message</classname>, you can instantiate the
             object used by <classname>Zend_Mime_Message</classname>, you can instantiate the
             <classname>Zend_Mime</classname> object yourself and then register it to
             <classname>Zend_Mime</classname> object yourself and then register it to
             <classname>Zend_Mime_Message</classname>. Usually you will not need to do this.
             <classname>Zend_Mime_Message</classname>. Usually you will not need to do this.
-            <code>-&gt;setMime(Zend_Mime $mime)</code> sets a special instance of
+            <methodname>setMime(Zend_Mime $mime)</methodname> sets a special instance of
             <classname>Zend_Mime</classname> to be used by this
             <classname>Zend_Mime</classname> to be used by this
             <classname>Zend_Mime_Message</classname>
             <classname>Zend_Mime_Message</classname>
         </para>
         </para>
 
 
         <para>
         <para>
-            <code>-&gt;getMime()</code> returns the instance of
+            <methodname>getMime()</methodname> returns the instance of
             <classname>Zend_Mime</classname> that will be used to render the message when
             <classname>Zend_Mime</classname> that will be used to render the message when
             <methodname>generateMessage()</methodname> is called.
             <methodname>generateMessage()</methodname> is called.
         </para>
         </para>
 
 
         <para>
         <para>
-            <code>-&gt;generateMessage()</code> renders the <classname>Zend_Mime_Message</classname>
-            content to a string.
+            <methodname>generateMessage()</methodname> renders the
+            <classname>Zend_Mime_Message</classname> content to a string.
         </para>
         </para>
     </sect2>
     </sect2>
 
 
@@ -96,7 +96,7 @@
         <para>
         <para>
             <methodname>Zend_Mime_Message::createFromMessage($str, $boundary)</methodname>
             <methodname>Zend_Mime_Message::createFromMessage($str, $boundary)</methodname>
             decodes the given string and returns a <classname>Zend_Mime_Message</classname>
             decodes the given string and returns a <classname>Zend_Mime_Message</classname>
-            Object that can then be examined using <code>-&gt;getParts()</code>
+            Object that can then be examined using <methodname>getParts()</methodname>
         </para>
         </para>
     </sect2>
     </sect2>
 </sect1>
 </sect1>

+ 6 - 6
documentation/manual/en/module_specs/Zend_Navigation-Containers.xml

@@ -462,7 +462,7 @@ $container->setPages($pages);
             Removing pages can be done with <methodname>removePage()</methodname> or
             Removing pages can be done with <methodname>removePage()</methodname> or
             <methodname>removePages()</methodname>. The first method accepts a an instance
             <methodname>removePages()</methodname>. The first method accepts a an instance
             of a page, or an integer. The integer corresponds to the
             of a page, or an integer. The integer corresponds to the
-            <code>order</code> a page has. The latter method will remove all
+            <property>order</property> a page has. The latter method will remove all
             pages in the container.
             pages in the container.
         </para>
         </para>
 
 
@@ -511,7 +511,7 @@ $container->removePages();      // removes all pages
             <methodname>findAllBy($property, $value)</methodname>, and
             <methodname>findAllBy($property, $value)</methodname>, and
             <methodname>findBy($property, $value, $all = false)</methodname>.
             <methodname>findBy($property, $value, $all = false)</methodname>.
             Those methods will recursively search the container for
             Those methods will recursively search the container for
-            pages matching the given <code>$page->$property == $value</code>.
+            pages matching the given <command>$page->$property == $value</command>.
             The first method, <methodname>findOneBy()</methodname>, will return a
             The first method, <methodname>findOneBy()</methodname>, will return a
             single page matching the property with the given value, or
             single page matching the property with the given value, or
             <constant>NULL</constant> if it cannot be found. The second method will return
             <constant>NULL</constant> if it cannot be found. The second method will return
@@ -522,9 +522,9 @@ $container->removePages();      // removes all pages
 
 
         <para>
         <para>
             The finder methods can also be used magically by appending the
             The finder methods can also be used magically by appending the
-            property name to <code>findBy</code>, <code>findOneBy</code>, or
-            <code>findAllBy</code>, e.g. <methodname>findOneByLabel('Home')</methodname> to
-            return the first matching page with label <code>Home</code>.
+            property name to <property>findBy</property>, <property>findOneBy</property>, or
+            <property>findAllBy</property>, e.g. <methodname>findOneByLabel('Home')</methodname> to
+            return the first matching page with label 'Home'.
             Other combinations are <methodname>findByLabel(...)</methodname>,
             Other combinations are <methodname>findByLabel(...)</methodname>,
             <methodname>findOnyByTitle(...)</methodname>,
             <methodname>findOnyByTitle(...)</methodname>,
             <methodname>findAllByController(...)</methodname>, etc. Finder
             <methodname>findAllByController(...)</methodname>, etc. Finder
@@ -686,7 +686,7 @@ foreach ($it as $page) {
             The method <methodname>hasPage(Zend_Navigation_Page $page)</methodname> checks
             The method <methodname>hasPage(Zend_Navigation_Page $page)</methodname> checks
             if the container has the given page. The method <methodname>hasPages()</methodname>
             if the container has the given page. The method <methodname>hasPages()</methodname>
             checks if there are any pages in the container, and is equivalent
             checks if there are any pages in the container, and is equivalent
-            to <code>count($container) > 1</code>.
+            to <command>count($container) > 1</command>.
         </para>
         </para>
 
 
         <para>
         <para>

+ 5 - 5
documentation/manual/en/module_specs/Zend_Navigation-Introduction.xml

@@ -26,8 +26,8 @@
                 in its most basic form – is an object that holds a pointer
                 in its most basic form – is an object that holds a pointer
                 to a web page. In addition to the pointer itself, the page
                 to a web page. In addition to the pointer itself, the page
                 object contains a number of other properties that are
                 object contains a number of other properties that are
-                typically relevant for navigation, such as <code>label</code>,
-                <code>title</code>, etc.
+                typically relevant for navigation, such as <property>label</property>,
+                <property>title</property>, etc.
             </para>
             </para>
 
 
             <para>
             <para>
@@ -76,9 +76,9 @@
             namespace do not deal with rendering of navigational elements.
             namespace do not deal with rendering of navigational elements.
             Rendering is done with navigational view helpers. However,
             Rendering is done with navigational view helpers. However,
             pages contain information that is used by view helpers
             pages contain information that is used by view helpers
-            when rendering, such as; label, <acronym>CSS</acronym> class, title,
-            <code>lastmod</code> and <code>priority</code> properties for
-            sitemaps, etc.
+            when rendering, such as; <property>label</property>, <acronym>CSS</acronym> class,
+            <property>title</property>, <property>lastmod</property> and
+            <property>priority</property> properties for sitemaps, etc.
         </para>
         </para>
 
 
         <para>
         <para>

+ 3 - 3
documentation/manual/en/module_specs/Zend_Navigation-Pages-Custom.xml

@@ -12,12 +12,12 @@
         <methodname>setOptions()</methodname> or <methodname>setConfig()</methodname> respectively.
         <methodname>setOptions()</methodname> or <methodname>setConfig()</methodname> respectively.
         Those methods will in turn call <methodname>set()</methodname> method, which
         Those methods will in turn call <methodname>set()</methodname> method, which
         will map options to native or custom properties. If the option
         will map options to native or custom properties. If the option
-        <code>internal_id</code> is given, the method will first look for a
+        <property>internal_id</property> is given, the method will first look for a
         method named <methodname>setInternalId()</methodname>, and pass the option to this
         method named <methodname>setInternalId()</methodname>, and pass the option to this
         method if it exists. If the method does not exist, the option will be
         method if it exists. If the method does not exist, the option will be
         set as a custom property of the page, and be accessible via
         set as a custom property of the page, and be accessible via
-        <code>$internalId = $page->internal_id;</code> or
-        <code>$internalId = $page->get('internal_id');</code>.
+        <command>$internalId = $page->internal_id;</command> or
+        <command>$internalId = $page->get('internal_id');</command>.
     </para>
     </para>
 
 
     <example id="zend.navigation.custom.example.simple">
     <example id="zend.navigation.custom.example.simple">