Browse Source

[MANUAL] English:

- manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@19435 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 years ago
parent
commit
06098146a1
1 changed files with 53 additions and 33 deletions
  1. 53 33
      documentation/manual/en/module_specs/Zend_View-Helpers-Navigation.xml

+ 53 - 33
documentation/manual/en/module_specs/Zend_View-Helpers-Navigation.xml

@@ -21,19 +21,22 @@
                 used for rendering the path to the currently active page.
                 used for rendering the path to the currently active page.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <link linkend="zend.view.helpers.initial.navigation.links">Links</link>,
                 <link linkend="zend.view.helpers.initial.navigation.links">Links</link>,
                 used for rendering navigational head links (e.g.
                 used for rendering navigational head links (e.g.
-                <code>&lt;link rel="next" href="..." /&gt;</code>)
+                <command>&lt;link rel="next" href="..." /&gt;</command>)
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <link linkend="zend.view.helpers.initial.navigation.menu">Menu</link>,
                 <link linkend="zend.view.helpers.initial.navigation.menu">Menu</link>,
                 used for rendering menus.
                 used for rendering menus.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <link linkend="zend.view.helpers.initial.navigation.sitemap">Sitemap</link>,
                 <link linkend="zend.view.helpers.initial.navigation.sitemap">Sitemap</link>,
@@ -42,6 +45,7 @@
                     format</ulink>.
                     format</ulink>.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <link
                 <link
@@ -64,42 +68,48 @@
     <itemizedlist>
     <itemizedlist>
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>{get|set}Container()</code> gets/sets the navigation
-                container the helper should operate on by default, and
+                <methodname>getContainer()</methodname> and <methodname>setContainer()</methodname>
+                gets and sets the navigation container the helper should operate on by default, and
                 <methodname>hasContainer()</methodname> checks if the helper
                 <methodname>hasContainer()</methodname> checks if the helper
                 has container registered.
                 has container registered.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>{get|set}Translator()</code> gets/sets the
-                translator used for translating labels and titles, and
-                <code>{get|set}UseTranslator()</code> controls whether
+                <methodname>getTranslator()</methodname> and
+                <methodname>setTranslator()</methodname> gets and sets the
+                translator used for translating labels and titles.
+                <methodname>getUseTranslator()</methodname> and
+                <methodname>setUseTranslator()</methodname> controls whether
                 the translator should be enabled. The method
                 the translator should be enabled. The method
                 <methodname>hasTranslator()</methodname> checks if the helper has
                 <methodname>hasTranslator()</methodname> checks if the helper has
                 a translator registered.
                 a translator registered.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>{get|set}Acl()</code>, <code>{get|set}Role()</code>,
-                gets/sets <acronym>ACL</acronym> (<classname>Zend_Acl</classname>) instance and
+                <methodname>getAcl()</methodname>, <methodname>setAcl()</methodname>,
+                <methodname>getRole()</methodname> and <methodname>setRole()</methodname>,
+                gets and sets <acronym>ACL</acronym> (<classname>Zend_Acl</classname>) instance and
                 role (<type>String</type> or
                 role (<type>String</type> or
                 <classname>Zend_Acl_Role_Interface</classname>) used for
                 <classname>Zend_Acl_Role_Interface</classname>) used for
-                filtering out pages when rendering, and
-                <code>{get|set}UseAcl()</code> controls whether <acronym>ACL</acronym> should
+                filtering out pages when rendering. <methodname>getUseAcl()</methodname> and
+                <methodname>setUseAcl()</methodname> controls whether <acronym>ACL</acronym> should
                 be enabled. The methods <methodname>hasAcl()</methodname> and
                 be enabled. The methods <methodname>hasAcl()</methodname> and
                 <methodname>hasRole()</methodname> checks if the helper has an
                 <methodname>hasRole()</methodname> checks if the helper has an
                 <acronym>ACL</acronym> instance or a role registered.
                 <acronym>ACL</acronym> instance or a role registered.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <methodname>__toString()</methodname>, magic method to ensure that
                 <methodname>__toString()</methodname>, magic method to ensure that
-                helpers can be rendered by <code>echo</code>ing the
-                helper instance directly.
+                helpers can be rendered by echoing the helper instance directly.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <methodname>render()</methodname>, must be implemented by concrete
                 <methodname>render()</methodname>, must be implemented by concrete
@@ -116,35 +126,40 @@
      <itemizedlist>
      <itemizedlist>
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>{get|set}Indent()</code> gets/set indentation. The
-                setter accepts a <type>String</type> or an <code>int</code>.
-                In the case of an <code>int</code>, the helper will use
+                <methodname>getIndent()</methodname> and <methodname>setIndent()</methodname>
+                gets and sets indentation. The setter accepts a <type>String</type> or an
+                <type>Integer</type>. In the case of an <type>Integer</type>, the helper will use
                 the given number of spaces for indentation. I.e.,
                 the given number of spaces for indentation. I.e.,
                 <methodname>setIndent(4)</methodname> means 4 initial spaces of
                 <methodname>setIndent(4)</methodname> means 4 initial spaces of
                 indentation. Indentation can be specified for all helpers
                 indentation. Indentation can be specified for all helpers
                 except the Sitemap helper.
                 except the Sitemap helper.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>{get|set}MinDepth()</code> gets/set the minimum depth
-                a page must have to be included by the helper. Setting
-                <constant>NULL</constant> means no minimum depth.
+                <methodname>getMinDepth()</methodname> and <methodname>setMinDepth()</methodname>
+                gets and sets the minimum depth a page must have to be included by the helper.
+                Setting <constant>NULL</constant> means no minimum depth.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>{get|set}MaxDepth()</code> gets/set the maximum depth
-                a page can have to be included by the helper. Setting
-                <constant>NULL</constant> means no maximum depth.
+                <methodname>getMaxDepth()</methodname> and <methodname>setMaxDepth()</methodname>
+                gets and sets the maximum depth a page can have to be included by the helper.
+                Setting <constant>NULL</constant> means no maximum depth.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>{get|set}RenderInvisible()</code> gets/set whether to
+                <methodname>getRenderInvisible()</methodname> and
+                <methodname>setRenderInvisible()</methodname> gets and sets whether to
                 render items that have been marked as invisible or not.
                 render items that have been marked as invisible or not.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <methodname>__call()</methodname> is used for proxying calls to the
                 <methodname>__call()</methodname> is used for proxying calls to the
@@ -154,6 +169,7 @@
                 below.
                 below.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <methodname>findActive($container, $minDepth, $maxDepth)</methodname>
                 <methodname>findActive($container, $minDepth, $maxDepth)</methodname>
@@ -167,30 +183,33 @@
                 found.
                 found.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <methodname>htmlify()</methodname> renders an <code>a</code> HTML
-                element from a <classname>Zend_Navigation_Page</classname>
-                instance.
+                <methodname>htmlify()</methodname> renders an <emphasis>'a'</emphasis> HTML
+                element from a <classname>Zend_Navigation_Page</classname> instance.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
                 <methodname>accept()</methodname> is used for determining if a page
                 <methodname>accept()</methodname> is used for determining if a page
                 should be accepted when iterating containers. This method
                 should be accepted when iterating containers. This method
                 checks for page visibility and verifies that the helper's
                 checks for page visibility and verifies that the helper's
-                role is allowed access to the page's resource/privilege.
+                role is allowed access to the page's resource and privilege.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>static setDefaultAcl()</code> is used for setting
-                a defualt <acronym>ACL</acronym> object that will be used by helpers.
+                The static method <methodname>setDefaultAcl()</methodname> is used for setting
+                a default <acronym>ACL</acronym> object that will be used by helpers.
             </para>
             </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
             <para>
             <para>
-                <code>static setDefaultRole()</code> is used for setting
+                The static method <methodname>setDefaultRole()</methodname> is used for setting
                 a default <acronym>ACL</acronym> that will be used by helpers
                 a default <acronym>ACL</acronym> that will be used by helpers
             </para>
             </para>
         </listitem>
         </listitem>
@@ -198,12 +217,12 @@
 
 
     <para>
     <para>
         If a navigation container is not explicitly set in a helper using
         If a navigation container is not explicitly set in a helper using
-        <code>$helper->setContainer($nav)</code>, the helper will look
+        <command>$helper->setContainer($nav)</command>, the helper will look
         for a container instance with the key <classname>Zend_Navigation</classname> in
         for a container instance with the key <classname>Zend_Navigation</classname> in
         <link linkend="zend.registry">the registry</link>.
         <link linkend="zend.registry">the registry</link>.
         If a container is not explicitly set or found in the registry, the
         If a container is not explicitly set or found in the registry, the
         helper will create an empty <classname>Zend_Navigation</classname>
         helper will create an empty <classname>Zend_Navigation</classname>
-        container when calling <code>$helper->getContainer()</code>.
+        container when calling <command>$helper->getContainer()</command>.
     </para>
     </para>
 
 
     <example id="zend.view.helpers.initial.navigation.proxy.example">
     <example id="zend.view.helpers.initial.navigation.proxy.example">
@@ -234,14 +253,15 @@ $this->navigation()->addPage(array(
             The navigation helpers support translation of page labels and titles.
             The navigation helpers support translation of page labels and titles.
             You can set a translator of type <classname>Zend_Translate</classname>
             You can set a translator of type <classname>Zend_Translate</classname>
             or <classname>Zend_Translate_Adapter</classname> in the helper using
             or <classname>Zend_Translate_Adapter</classname> in the helper using
-            <code>$helper->setTranslator($translator)</code>, or like with other
+            <command>$helper->setTranslator($translator)</command>, or like with other
             I18n-enabled components; by adding the translator to
             I18n-enabled components; by adding the translator to
             <link linkend="zend.registry">the registry</link> by using the key
             <link linkend="zend.registry">the registry</link> by using the key
             <classname>Zend_Translate</classname>.
             <classname>Zend_Translate</classname>.
         </para>
         </para>
 
 
         <para>
         <para>
-            If you want to disable translation, use <code>$helper->setUseTranslator(false)</code>.
+            If you want to disable translation, use
+            <command>$helper->setUseTranslator(false)</command>.
         </para>
         </para>
 
 
         <para>
         <para>