Browse Source

ZF-6490 Added documentation for the Zend_App Navigation Resource Plugin

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@17305 44c647ce-9c0f-0410-b52a-842ac1e357ba
freak 16 years ago
parent
commit
368d21605d

+ 37 - 0
documentation/manual/en/module_specs/Zend_Application-AvailableResources-Navigation.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Reviewed: no -->
+<sect2 id="zend.application.available-resources.navigation">
+    <title>Zend_Application_Resource_Navigation</title>
+
+    <para>
+        <classname>Zend_Application_Resource_Navigation</classname> can be used to configure
+        a <classname>Zend_Navigation</classname> instance. Configuration options are per <link
+            linkend="zend.navigation.pages.common.options">the <classname>Zend_Navigation</classname>
+            options</link>.
+    </para>
+
+    <para>
+        Once done configuring the navigation instance, it by assigns the instance to
+        <classname>Zend_View_Helper_Navigation</classname> by default
+        -- from which you may retrieve it later.
+    </para>
+
+    <example id="zend.application.available-resources.navigation.configExample">
+        <title>Sample Navigation resource configuration</title>
+
+        <para>
+            Below is a sample <acronym>INI</acronym> snippet showing how to
+            configure the navigation resource.
+        </para>
+    
+        <programlisting language="ini"><![CDATA[
+resources.navigation.pages.page1.label = "Label of the first page"
+resources.navigation.pages.page1.route = "Route that belongs to the first page"
+
+; Page 2 is a subpage of page 1
+resources.navigation.pages.page1.pages.page2.type = "Zend_Navigation_Page_Uri"
+resources.navigation.pages.page1.pages.page2.label = "Label of the second page"
+resources.navigation.pages.page1.pages.page2.uri = "/url/to/page/2"
+]]></programlisting>
+    </example>
+</sect2>

+ 1 - 0
documentation/manual/en/module_specs/Zend_Application-AvailableResources.xml

@@ -11,6 +11,7 @@
     <xi:include href="Zend_Application-AvailableResources-Db.xml" />
     <xi:include href="Zend_Application-AvailableResources-Frontcontroller.xml" />
     <xi:include href="Zend_Application-AvailableResources-Modules.xml" />
+    <xi:include href="Zend_Application-AvailableResources-Navigation.xml" />    
     <xi:include href="Zend_Application-AvailableResources-Session.xml" />
     <xi:include href="Zend_Application-AvailableResources-View.xml" />
 </sect1>