Menu Item Module

Owned by Maciej Szczytowski (Unlicensed)
Last updated: Jan 24, 2012 by Marcin Kubala (Unlicensed)Version comment
1 min read

Overview

This module is used for defining new second-level menu's item referencing to view.

Module's schema is defined in menu.xsd.

Menu item description in tooltip

You can assign short description available as tooltip to menu items.

To do this just add translation with key matching below pattern:

<plugin_name>.menu.<menu_category_name>.<menu_item_name>.description

For example to add tooltip for Production orders -> Order groups just add to orderGroups_XX.properties (replace XX by language code):

orderGroups.menu.orders.orderGroups.description = A group of production orders usually represents a customers order for multiple products

Attributes

name

type

required

description

name

string

yes

Name of the menu's item.

category

string

yes

Name of the first-level menu's item where the item will be added.

plugin

string

no

Name of the plugin where the view belongs.
If not specified it is assumed that view belongs to the plugin which contains this module.

view

string

yes

Name of the view referenced by the menu's item.

Example

Please find below an example of plugin defining one menu's category module. Line 8 contains a module which defines new second-level menu's item sampleItem in category sampleCategory. The item will be referencing to the sampleView in the plugin otherPlugin. 

<?xml version="1.0" encoding="UTF-8"?>
<plugin plugin="samplePlugin" version="1.0.0" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schema.qcadoo.org/plugin" 
    xmlns:model="http://schema.qcadoo.org/modules/menu" 
    xsi:schemaLocation="http://schema.qcadoo.org/plugin http://schema.qcadoo.org/plugin.xsd http://schema.qcadoo.org/modules/menu http://schema.qcadoo.org/modules/menu.xsd">

    <menu:menu-item name="sampleItem" category="sampleCategory" plugin="otherPlugin" view="sampleView" />

</plugin>