Table of Contents

The AI Menu

Version 5.21

The menu for the AI is constructed dynamically from a javascript file - /js/menu.js. Doing this makes it easier to modify entries and its appearance.

You should ONLY add links to external pages/sites. Do NOT add pages within the structure of the AI.

It is STRONGLY RECOMMENDED that if you customise this file, you create a new file with a different name, e.g. mymenu.js and change ai-page-ctrl.js line 223 to use that file. This will avoid your customisations being accidentally overwritten during upgrades

Note

The menu now only responds to mouse clicks.

The Sidebar Menu and any dropdown panels will only close when you select another option or re-click on the same one.

Making Changes

Titles

These are the words that will appear on your menu. They are capitalised and in double curly brackets in the file as they are translated by CumulusMX when used on the Interface. If you do not follow this convention, anything that you change will not be translated but appear exactly as you enter it.

  • You can use html tags but the effect may be unpredictable.
  • You should keep entries short, especially in top level items.
  • Top level entries cannot include an 'icon' property.

If the title is "-" then a horizontal divider will be displayed and no other property is required. You should not use these in megaMenus as they will occupy a complete cell.

Url's

This is used to provide the address of the page / site to visit. It is only required for entries that open a page.

Any pages that are not part of the supplied AI will require a full url starting with 'http' or 'https'. You should also consider using the newWindow property to force the page to open in a separate browser/window. Note

megaMenu & subMenu

These are used to define a dropdown menu and are mutually exclusive.

An entry that is declared as a subMenu will cause the following entries to appear on a single column dropdown panel while one declared as a megaMenu will appear as a multi-column dropdown. Note

They must be followed by the property items: [ .. ].

The items section should contain one or more complete { title:“”, url:“” } entries subject to the information below.

If specifying a megaMenu you can also include an order property. This will be used to arrange the entry within a grid. However, this is applied in rows, left to right. If the menu only displays one or two columns, the order may not be as expected. Note

If you don't specify an order value, then the entries are displayed in the order they appear in the file.

You are free to change any of the existing subMenus into megManus or vici-versa as you wish - coding has been made flexible enough to accommodate this.

The 'name' entries are optional.

Icons

These are only valid in subMenu and megaMenu sections. They will be ignored if used at the top level of the menu.

The entry should include all the required elements specified by Font-Awsome®. This can include any additional styles available from them. They can also include theme colour styles.

The link below will display the contents of the js/menu.js file.

The Menu File