Changes between Version 43 and Version 44 of S3/S3Navigation

Timestamp:

03/05/12 21:27:08 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3Navigation

@@ -407 +407 @@
 
 is rendered as {{{/pr/person}}} but matches both {{{/pr/person}}} and {{{/pr/index}}}.
+
+== Manipulating Menus ==
+
+You can use the call-method later to append more items:
+{{{
+# Append another item to the menu
+my_menu(MyMenuLayout("Third Item"))
+}}}
+
+If you want to insert an item at a particular position, use the insert method:
+
+{{{
+my_menu.insert(0, MyMenuLayout("New First Item"))
+}}}
+
+You can also remove items from a certain position:
+
+{{{
+my_menu.pop(0) # Remove "New First Item" again
+}}}
+
+Note that every item can only ever belong to exactly one parent item. If you append or insert the same item to a different parent item, it will automatically be removed from the original parent:
+
+{{{
+# CLI example
+>>> menu_1 = M("Menu 1")  # define menu 1
+>>> menu_2 = M("Menu 2")  # define menu 2
+>>> item_1 = M("Item 1")  # define a menu item
+>>> menu_1.append(item_1) # append the menu item to menu 1
+<S3OptionsMenuLayout:Menu 1 {<S3OptionsMenuLayout:Item 1>}>
+>>> menu_2
+<S3OptionsMenuLayout:Menu 2>
+>>> menu_2.append(item_1) # append the menu item to menu 2
+<S3OptionsMenuLayout:Menu 2 {<S3OptionsMenuLayout:Item 1>}>
+>>> menu_1
+<S3OptionsMenuLayout:Menu 1> # => menu item no longer component of menu 1
+}}}
+
+Thus, if you want to re-use a sequence of menu items, make their definition a function and call it at each place you need the sequence.
+
+NB: at the CLI, you can also see the item rendered as HTML, by calling:
+
+{{{
+>>> menu_2.xml()
+'<ul id="subnav"><li><div class="hoverable"><a href="/vita/default/index">Item 1</a></div></li><li><div class="hoverable"><a href="/vita/default/index">Item 1</a></div></li></ul>'
+}}}
+
+Note that this performs status checks, i.e.:
+{{{
+>>> menu_3 = M("Menu 3", c="pr")
+>>> menu_3.xml()
+''                 # <- CLI has controller="default", function="index", i.e. this menu item is inactive
+}}}
+
+It does also perform authorization checks, i.e.
+{{{
+>>> current.request.controller = "pr"
+>>> menu_3 = M("Menu 3", c="pr")
+>>> menu_3.xml()
+''                        # <- Item is active, but unauthorized
+>>> menu_3.check_permission()
+False
+>>> auth.override = True
+>>> menu_3.xml()
+'<ul id="subnav"></ul>'   # <- Now we're allowed to access this item
+>>> auth.override = False
+>>> menu_3.xml()
+''
+}}}