Loading...
 
Skip to main content

History: Menu Handler

Source of version: 12

Copy to clipboard
            This is a ((handler)) to create menus and options. A menu object is the equivalent of a menu, a user module and a module in Tikiwiki. It also contains all the options.

!Complete sample for a basic menu
{CODE(caption=>YAML)}
objects:
 -
  type: menu
  ref: my_menu
  data:
   name: My Menu
   description: A menu containing the base navigation of the site
   collapse: none
   position: left
   order: 1
   groups: [ Anonymous ]
   items:
    -
     name: Home
     url: ((HomePage))
     groups: [ Anonymous ]
    -
     name: Private Area
     url: ((PrivateArea))
     groups: [ Registered ]
     items:
      -
       name: Forum
       url: tiki-forums.php
    -
     name: Administration
     url: tiki-admin.php
     permissions: [ admin ]
     items:
      -
       name: Account Moderation
       url: tiki-adminusers.php
       permissions: [ admin_users ]
{CODE}

!Menu Object
||__Field Name__|__Mandatory__|__Value__
name|yes|The name of the module as listed in the administration panel.
description| |Menu description
collapse| |''collapsed'', ''expanded'' or ''none'', default is collapsed
icon| |Icon to be used for collapsable items, see menu documentation
items|yes|List of ''item'' objects, see below
position| |''left'' or ''right'', required to add as module
module_arguments| |If extra arguments must be passed to the {menu} tag in the user module (see ((Split_Level_Menu)))
order| |Numeric value, lower values are displayed above, required to add as module
cache| |Default ''0'', time to cache in seconds, only used when added as module
groups| |List of group names allowed to view the module, only used when added as module
||

!Item Object
||__Field Name__|__Mandatory__|__Value__
name|yes|Item label
url|yes|Item URL or wiki page name as ~np~((PageName))~/np~
items| |List of children ''item'' objects
groups| |List of groups allowed to view the item
permissions| |List of permissions required to view the item
level| |?
section| |?
||

        

History

Information Version
Sun 14 of Jun, 2020 14:36 GMT-0000 Jonny Bradley add parse 17
Mon 13 of Sep, 2010 22:36 GMT-0000 Marc Laporte cleaner 16
Thu 15 of Apr, 2010 07:39 GMT-0000 Geoff Brickell 15
Wed 24 of Feb, 2010 17:52 GMT-0000 sylvie 14
Sat 18 of Apr, 2009 14:57 GMT-0000 Marc Laporte 13
Mon 02 of Mar, 2009 21:41 GMT-0000 System Administrator an example with 2 section 0 12
Mon 02 of Mar, 2009 20:12 GMT-0000 System Administrator 11
Sat 23 of Aug, 2008 15:37 GMT-0000 Marc Laporte 9
Sat 23 of Aug, 2008 15:27 GMT-0000 Marc Laporte 8
Sat 23 of Aug, 2008 15:19 GMT-0000 Marc Laporte 7
Mon 11 of Aug, 2008 14:55 GMT-0000 System Administrator 5
Mon 11 of Aug, 2008 14:55 GMT-0000 System Administrator 4
Wed 06 of Aug, 2008 20:18 GMT-0000 System Administrator 3
Wed 06 of Aug, 2008 20:17 GMT-0000 System Administrator 2
Wed 06 of Aug, 2008 18:07 GMT-0000 System Administrator 1