menu structures for web/desktop applications


define - create new menu definition

  menu define   AdminName {Menu_DefineOption} [force];

clone - duplicate a menu and set the properties for the new instance

  menu clone  AdminName define AdminName {Menu_EditOption} [force];

edit - update the menu properties

  menu edit   AdminName {Menu_EditOption} [force];

show - print the menu properties

  menu show   AdminName [Menu_GetOption] [Token_Option] [ExportFile_Option] ;

select - extract menus on the base of query filters

  menu select AdminPatternList {Filter_Option} [top] [Menu_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

undefine - remove a menu from the database

  menu undefine AdminName ;

Menu_DefineOption
	description GenericValue
	application AdminName
	image  FileName
	imagedata GenericString
	label GenericValue
	href GenericValue
	alt GenericValue
	[! / not] portfolio
	[! / not] isapplication
	submenu  AdminName { AdminName }
	command AdminName { AdminName }
	[! /not] hidden

Menu_EditOption
	name AdminName
	description GenericValue
	application AdminName
	svnrev NUMBER
	image  FileName
	imagedata GenericString
	label GenericValue
	href GenericValue
	alt GenericValue
	[! / not] portfolio
	[! / not] isapplication
	submenu  Edit_RefOperator   AdminName { Edit_RefOperator   AdminName }
	command  Edit_RefOperator   AdminName { Edit_RefOperator   AdminName }
	[! /not] hidden

Menu_GetOption
	get [Menu_GetBasicOption]
	Menu_GetBasicOption
		{ Menu_GetBasicToken [as IDENTIFIER] { Menu_GetBasicToken [as IDENTIFIER] } }
		Menu_GetBasicToken [as IDENTIFIER]
		Menu_GetBasicToken
			Common_GetBasicOption
			label
			href
			alt
			isportfolio
			isapplication
			supermenu	[. Menu_GetBasicOption]
			supermenu[]	[. Menu_GetBasicOption]
			supermenu[ AdminName ]
			submenu	[. Menu_GetBasicOption]
			submenu[]	[. Menu_GetBasicOption]
			submenu[ AdminName ]
			ownsubmenu	[. Menu_GetBasicOption]
			ownsubmenu[]	[. Menu_GetBasicOption]
			ownsubmenu[ AdminName ]
			command	[. Command_GetBasicOption]
			command[]	[. Command_GetBasicOption]
			command[ AdminName ]
			owncommand	[. Command_GetBasicOption]
			owncommand[]	[. Command_GetBasicOption]
			owncommand[ AdminName ]
			ownchild	[. Command_GetBasicOption]
			ownchild[]	[. Command_GetBasicOption]
			actions	[. MenuItem_GetBasicOption]

MenuItem_GetBasicOption
	{ MenuItem_GetBasicToken [as IDENTIFIER] { MenuItem_GetBasicToken [as IDENTIFIER] } }
	MenuItem_GetBasicToken [as IDENTIFIER]
	MenuItem_GetBasicToken
		name
		image
		imagedata
		label
		href
		alt
		executable
		level

KEYWORDs
	actions	command options computed for creating the user interface menu for the current user
	alt	the tooltip text or label
	application	the associated application menu
	command	menu command item(s)
	description	the menu description
	force	this flag allows to ignore errors during the creation/update (for example, some commands or sub-menus not yet defined)
	hidden	administration hidden objects are not visible/usable
	href	the menu url used to perfom extra actions (for example javascript code)
	image	local path for the menu icon to upload
	imagedata	base64 code for the menu icon
	isapplication	if set defines the menu as an application root menu item
	moddate	last modification date
	label	the menu label (usually translated in dictionary)
	name	the menu name
	ownchild	list of menu direct childs (can be both sub-menus or commands)
	owncommand	list of menu direct commands
	ownsubmenu	list of menu direct sub-menus
	submenu	menu sub-menu item(s)
	supermenu	the parent menu
	svnrev	SVN repository revision number
	top	filter top menus only (without parent menu)