Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 1.89 KB

README.md

File metadata and controls

39 lines (22 loc) · 1.89 KB
Raw

#Plugin menus

##Introduction

This plugin allows to display the menu of the pages of the site

It is possible to display :

  • a main menu to access to the pages of one specific level. The first level of menu is displayed by default as main menu
  • a full menu in tree form to access to the pages of the site whatever the level

It is possible to display these different menus in the pages of the site by adding specific markers in the page template page_frameset.html

These markers are the following :

  • ${page_tree_menu_main} : allow to display the menu of pages of one specific level. By default the first level is displayed
  • ${page_tree_menu_tree} : allow to display the menu of child pages of the current page
  • ${page_tree_menu_tree_all_pages} : allow to display the full menu in tree form

This plugin provides a REST service allowing to get the full menu of the site in tree form in JSON format. In the response, each menu item contain page informations with especially the URL to access to the page

##Configuration

The menus display is configurable from parameters of the plugin file properties

The main parameters are the following :

  • menus.mainTreeMenu.depth.main : defines the level of pages displayed through the marker ${page_tree_menu_main}
  • menus.mainTreeMenu.depth.tree : defines the level of the current page to display the menu of child pages through the marker ${page_tree_menu_tre}
  • menus.mainTreeMenu.depth.tree.allpages : defines the number of level to display when displaying the full menu through the marker ${page_tree_menu_tree_all_pages}

##Usage

URL to access to the REST service allowing to get the full menu in JSON format : ${base_url}/rest/menus/tree_menu_pages

Maven documentation and reports

generated by xdoc2md - do not edit directly.