Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt
hiddentrue

menu-category - defines new first-level menu's item.

Overview

This module is used for defining new first-level menu's item.

Module's schema is defined in menu.xsd.

Menu category description in tooltip

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

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

Code Block
themeEclipse
languagejava
<plugin_name>.menu.<menu_category_name>.description

For example to add tooltip for Production orders just add to orders_XX.properties (replace XX by language code):

Code Block
themeEclipse
languagejava
orders.menu.orders.description = Orders to produce a certain product.

Attributes

name

type

required

description

name

string

yes

Name of the menu's category.

Example

Please find below an example of plugin defining one menu's category module. Line 8 contains a module which defines new first-level menu's item sampleCategory.

Code Block
themeEclipse
languagexml
linenumberstrue
<?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-category name="sampleCategory" />

</plugin>