One of the problems we encountered in extending ZenTao was how to register the features we added to the menu, and this article is about how to implement this feature.

1. Composition of the menu

There are 3 parts in ZenTao navigation menus: top menu, module menu, and the function menu.

2. The definition of menu

The code definition of the menu is in the language file zentao/module/common/lang/zh-cn. Now let's check the definition of the main menu.

2.1 The definition of the main navigation menu

80 $lang->menu->my = ' dashboard|my|index';

81 $lang->menu->product = 'product view|product|index';

82 $lang->menu->project = 'project view|project|index';

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

Let's check the meaning of the code: 83 $lang->menu->qa = 'QA view|qa|index';

This line of code defines the code of the test view, where menu->qa defines the keys of the menu, which can be defined according to the actual module. The following are three parameters separated by vertical lines, which are the text of the menu, corresponding to the module and method. This statement means that you want to define a top-level menu with the text "test view", linked to the index method of the qa module.

2.2 The definition of the module menu

Let's take the module menu of the product view 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' => ' new added product|product|create', 'float' => 'right');

158 $lang->productplan->menu = $lang->product->menu;

159 $lang->release->menu = $lang->product->menu;

These lines of code define the module menu for the Product View module, which appears to define a number of new methods.

2.2.1 Defining links by arrays

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

This line of code defines the link by an array, which defining 2 elements: link and subModule. There is one more parameter filed in "link": productID=%s, which means that the "story" menu of the product view will be linked to the browse method of the product module, and the passed parameter is productID=%s, where the %s will be replaced by the current product id.

2.2.2 Defining sub-modules by subModule

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

The subModule defines its sub-modules, which is needed to keep the menu highlighted. This way, when the story module is accessed, the "product view" definition menu will remain highlighted.

2.2.3 Defining method aliases by alias

151 $lang->product->menu->view = array('link' => 'overview|product|view|productID=%s', 'alias' => 'edit');

The alias here means that the edit page of the product and the view page of the product are the same, so that the "overview" menu will remain highlighted when the product is edited.

2.2.4 Defining the location of the menu

All menus are displayed on the left side by default, if you need to display the menu on the right side, you need to define its float parameter.

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

By setting the float parameter, you can define this new product link to be displayed on the right side of the page.

2.3 The definition of the function menu

The function menu is printed inside the view file of each module and is expanded in the same way as the view is expanded, which will be covered later.

3. The definition of the menu sequence

The previous section describes the definition of the ZenTao menu, and the following section defines the menu sequence. Under common/lang/ there is a menuOrder.php file, in which the display order of each menu is defined.

/* 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';

4. How to register your page to the menu

Once you understand the menu mechanism of ZenTao, it's very easy to make extensions. Let's check the procedures.

1. Create a file under module/common/ext/lang/zh-cn/, for example it is called abc.php (the name of the file can be defined arbitrarily)

2. Just add your own menu to this file, such as the repository menu in ZenTao Pro:

   $lang->menu->repo = 'repository|repo|browse';

   $lang->menuOrder[21] = 'repo';

   $lang->repo->menu->list = '%s' . $lang->arrow;

   $lang->repo->menu->browse = array('link' =>'browse|repo|browse|repoID=%s', 'alias' => 'diff, log, view, revision, showsynccomment');

   $lang->repo->menu->settings = 'settings|repo|settings|repoID=%s';

   $lang->repo->menu->delete = array('link' => 'delete|repo|delete|repoID=%s', 'target' => 'hiddenwin');

   $lang->repo->menu->create = array('link' => 'new added repository|repo|create|', 'float' => 'right');

5. How to add external links to the menu

For example, we want to hang a Sina URL in the top menu of ZenTao, and we want to open this URL in a new window.

1. Create a new file footer.sina.html.hook.php under module/common/ext/view
2. After adding the following and saving it, you can open ZenTao to see the new link appear in the top menu, and it opens in a new window.

   <script> 
   $(document).ready(function()
   {
       $("#navbar ul.nav").append('<li><a id="menusina" href="http://www.sina.com.cn"  target="_blank">Sina</ a><\/li>');
   });
   </script>