Add Features to Menu

1. Menu
2. Menu definition
3. Define the order of a menu
4. How to add your pages to the menu

One of the problems you might have when customizing ZenTao is how to add the customized features to the navigation bar. In this chapter, we will talk about how to do it.

1. Menu

The menu in ZenTao includes three level, the top menu, the module menu and the function module.

2. Menu definition

The code of menu definition is saved in the language files in zentao/module/common/lang/en. Now let’s look at the definition of the main menu.

2.1 Define the main menu

83 $lang->menu->qa = 'Testing|index';

Let’s look at the definition of codes 83 $lang->menu->qa = 'Testing|qa|index';

It defines the code of the Testing module. menu->qa defines the key value of the menu, which can be defined according to the actual definition of modules. The three parameters separated by the vertical lines are the text of the menu, the corresponding module and the method. This code is to define a top menu, the text of which is Testing, and link its index method to qa module.

2.2 Define a module menu
Take the module menu of Product as an example.

144 $lang->product->menu->list = '%s';
145 $lang->product->menu->story = array('link' =>'Story|product|browse|productID=%s', 'subModule' =>'story');
155 $lang->product->menu->create = array('link' =>' Newly added product|product|create', 'float' =>'right');
158 $lang->productplan->menu = $lang->product->menu;
159 $lang->release->menu = $lang->product->menu;

These codes define the module menu in the Product and there are some new definitions.

2.2.1 Define links with arrays
145 $lang->product->menu->story = array('link' =>'Story|product|browse|productID=%s', 'subModule' =>'story');

It defines two elements, link and subModule, with array, when defining the link. One parameter field is added, productID=%s, which means the browse method used when linking the "Story" menu to the Product. The parameter passed is productID=%s, and %s will be changed into the actual product ID.

2.2.2 Define submodules
145 $lang->product->menu->story = array('link' => 'Story|product|browse|productID=%s', 'subModule' =>'story');

It is used to define submodules and highlight it. When you are in story module, the defined menu Product will be highlighted.

2.2.3 Define alias of methods with alias
151 $lang->product->menu->view = array('link' =>'Overview|product|view|productID=%s', 'alias' =>'edit');

Alias means that the edit page and view page of the product are the same. Therefore, when you go to edit products, the Overview is still highlighted.

2.2.4 Define the settings of menu

Every menu is displayed on the left by default. If you want to move it to the right, you have to define its float parameter.

155 $lang->product->menu->create = array('link' =>'newly added product|product|create', 'float' =>'right');

By setting the float parameter, you define that the link of the newly added product will be displayed on the right.

2.3 Define a function menu
Function module is printed in each module. Its extension method is the same as that of Views, which we will touch later.

3. Define the order of a menu

What has been mentioned above is how to define a menu in ZenTao. Now we will talk about how to define the order of a menu in ZenTao. In the directory of common/lang/, there is menuOrder.php which is used to define the display order of each menu.

/* Sort of main menu. */
$lang->menuOrder[5] = 'my';
$lang->menuOrder[10] = 'product';
$lang->menuOrder[15] = 'project';
$lang->menuOrder[20] = 'qa';
$lang->menuOrder[25] = 'doc';
$lang->menuOrder[30] = 'report';
$lang->menuOrder[35] = 'company';
$lang->menuOrder[40] = 'admin';
/* index menu order. */
$lang->index->menuOrder[5] = 'product';

$lang->index->menuOrder[10] = 'project';