Wiki

YJMenu Introduction

YJMenu is a confluence plugin which can help to build a user-friendly menu based on page structure.

Why do we choose YJMenu?

Confluence is a very good docment mangament system. It helps users to organise their documents with a very clear an well-structured way. But for some users, they still want to get a menu help their clients to navigate to some purticular pages without involving in confluence massive documents navigation. YJMenu provides users a way to build their smart and elegant menus by just specifying the space or the page without any other extra menu building jobs.

How Macro Looks like

In Confluence, here is the page hierarchy Confluence Pages

And this is the how the macro display this page hierarchy with a menu.

Install YJMenu Macro

UPM Installation

YJMenu is a deployable plugin of confluence. It can be installed direct from Universal Plugin Manager. What you need to do is:

Login Confluence as an administrator
Go to Administration console (On any page, click the menu "Browse -> Confluecen Admin"
Go to "Configuration -> Plugins"
Go to tab "Install"
Input "yjmenu" in search box and click "Search"
Get "YJMenu" plugin from search result and click "Install"

Manual Installation

After downloading the JYMenu JAR file from Altassian Marketplace website, what you need to do is:

Login Confluence as an administrator
Go to Administration console (On any page, click the menu "Browse -> Confluecen Admin"
Go to "Configuration -> Plugins"
Go to tab "Install"
Click "Upload Plugin"
Select YJMenu JAR file which you downloaded from Atlassian website
Click "Upload" button to start the installation.

When the installation is done, that means the plugin has been installed successfully. For using the YJMenu Macro, you hava to get a trial license or a commercial license to active this plugin. Please read the following section "Install the license"

Install the license

To active YJMenu plugin to use the "yjmenu" macro in confluence, you have to get a trial or commercial license first. After you get the license, what you need to do is:

Login Confluence as an administrator
Go to Administration console (On any page, click the menu "Browse -> Confluecen Admin"
Go to "Configuration -> Plugins"
Go to "Manage Existing"
Expand the plugin named with "YJ's jQuery Menu Macro"
Click the link of "Configure"
Input the license you have in the text area and click "Update"
System gives you a message for the successful installation or some failure reason

Use the macro

For use the macro of YJMenu, you have to have the right to edit page.

Select the page you want to edit
On the page editor, choose "Insert".
Choose "Other Macros"
Select "Confluence Content"
Find the macro "yjmenu" and click on it There will be several parameters you can specified.

Parameters	Description
Space Key	Build the YJMenu from which space. This parameter is the "Space key" which could be found in "Space Admin -> Advanced -> Space Detail-> Key"
Page Title	If you don't want YJMenu to build the menu from the root of the space, please specify the page title(under the above space) which you prefer.
Menu Level Depth	Specify how many menu levels you want to display on the menu. (Maximum: 3)
Max Menu Items	Specify how many menu items displayed in each menu level.
Menu Color	Specify the background color of the menu. Eg: #333333 or red
Pop-up Block Color	Specify the background color of the pop-up block. Eg: #cccccc or yellow
Hover Color	Specify the hover color. Eg: #999999 or yellow

After saving the page, you can see how the macro works.