Documentation

Plugins

• RokNavMenu - Boost
• RokNavMenu - Extended Link

Boost, in combination with the administrator menu overrides, provide an ability for template side parameters to load inside the control panel of each menu item. For example, with Nexus, the Subtext, Columns of Children and Menu Image settings are loaded via the RokNavMenu Boost plugin.

All these are loaded from the items.xml file in the themes override directory: /templates/rt_template_name_j15/html/mod_roknavmenu/themes/theme-name/

RokNavMenu Boost is automatically installed when you install mod_roknavmenu.zip under the component installer process.

Extended Link is a useful plugin that presides in the menu item settings, similar to those of Boost, which allows for strings to be added to the end of a Joomla URL.

• Go to Menu Manager → Menu → New / Edit
• Select the Parameters (Extended Query Strings) tag
• Click the Add button
• Insert both the Name and Value - the output will be name=value such as http://yoursite.com/index.php?name=value
• Add More if necessary and Save

RokNavMenu Extended Link is automatically installed when you install mod_roknavmenu.zip under the component installer process.

Module Configuration

Below is a list and explanation of the various parameters in Extensions → Module Manager → RokNavMenu

Menu Name: Select the menu for RokNavMenu to load.

Limit Levels: Choose whether to limit the number of sublevels in the menu.

• Start Level: Set the start level, by default this is 0
• End Level: Set the end level, by default this is 0

Always show submenu items: Set whether to show submenu items always or only when the parent item is active.

Menu Theme: Select the theme for RokNavMenu. Default theme - basic is a simple list menu, comparable to the mod_mainmenu output. Default theme - fusion is a dropdown based menu with javascript enhancements.

When selected, all options pertaining to them will appearing dynamically.

Load CSS: Enable this option to load the inbuilt stylesheets.

Enable Javascript: Toggle between the javascript effects and static CSS modes of the menu. Set to No to mimic Suckerfish type functionality.

Menu Opacity: Set the opacity of the menu dropdowns, use values between 0.1 - 1. The nearer to 0.1, the greater the transparency.

Menu Effect: There are 2 options for the dropdown menu effects. These are Slide, or Slide & Fade.

Hide Delay: Set the duration in milliseconds (1000ms = 1 second) after which you hover off the menu that it hides.

Menu Animation: Choose from a selection of Mootools transition effects for your dropdowns.

Menu Duration: Set the duration in milliseconds (1000ms = 1 second) of the transition effect of the dropdowns.

Enable Pill: Pill describes the javascript follow effect when you hover items. This is best illustrated with Moxy and hover your cursor over the menu and watch the pill follow your cursor. This option enables this behaviour. Note, the template needs to have specific styling to match use of this ability.

Pill Animation: Choose from a selection of Mootools transition effects for the pill.

Pill Duration: Set the duration in milliseconds (1000ms = 1 second) of the transition effect of the pill.

Dropdown Options

• Vertical Animation: Set the animation type for vertical transition
• Vertical Duration: Set the duration, in milliseconds (1000 seconds), of the vertical animation
• Horizontal Animation: Set the animation type for horizontal transition
• Horizontal Duration: Set the duration, in milliseconds (1000 seconds), of the horizontal animation

• Submenu Y Offset: Set the offset (in pixels) of the first level submenu from the top of the menu. Set this to the height of the horizontal menu bar for best results
• Submenu X Offset: Set the offset (in pixels) of the second level submenu from its parent dropdown (left direction). Set this to the width of the dropdowns for best results
• Level 2 Y Offset: Set the offset (in pixels) of the second level submenu from its parent dropdown. Set this to 0 for best results
• Level 2 X Offset: Set the offset (in pixels) of the first level submenu from the top of the menu. Set this to 0 for best results

Enable Active ID: Set to No to avoid CSS validation errors with multiple active Joomla menu items.

Themes

Our RocketTheme templates such as Moxy or Nexus use template overrides to fully utilise the abilities of RokNavMenu without having to modify the original file. These overrides are located in the /templates/rt_template-name_j15/html/mod_roknavmenu/themes/ directory.

There are 4 files that are associated with the theme overrides: formatter.php, items.xml, layout.php and parameters.xml.

The formatter provides with a way to control complex actions of the menu with ease. For example, with Moxy, this adds a series of classes to the menu such as daddy, orphan, etc... providing more states to the menu which allows the styling to be much more extensive.

The formatter class has to be in the form: RokNavMenuFormatterTemplate<Name> such as RokNavMenuFormatterTemplateMoxy

Layout.php, as the name suggests, is the file that provides the HTML structure to the menu. All the UL, LI, A tags are defined here. Therefore, the override provides with completely control over the HTML structure of the menu, leaving the possibilities of customisation wide open.

These XML files control the configuration options of the theme. parameters.xml are the template / module configuration options. These are effectively what you see in the RokNavMenu module manager when you select the theme (and can also be placed in the template manager area as well, as seen in our RokNavMenu 1.7.5+ compatible themes).

items.xml, is a configuration file, but applies to the administrator. RokNavMenu, on installation, adds a series of overrides to the Khepri administrator template. This allows us to override the menu administrator to allow for much greater control. For example, in Moxy, you can select the Menu Icon, Subtext and # of Columns for each menu item which this feature.

Legend:
    
    * -> Security Fix
    # -> Bug Fix
    + -> Addition
    ^ -> Change
    - -> Removed
    ! -> Note
    
    ------- 1.8 Release [16-March-2010] -------
13-March-2010 Brian Towles
# Fix for url type

    
    ------- 1.7.14 Release [28-February-2010] -------
    
    24-Feb-2010 Djamil Legato
    # Dropdowns fusion container now inherits all the classes from the parent element
    
    ------- 1.7.13 Release [30-January-2010] -------
    
    26-Jan-2010 Brian Towles
    # Fixed child level issue
    # Fixed typo in Fusion layout.php
    
    ------- 1.7.12 Release [09-January-2010] -------
    
    09-Jan-2010 Djamil Legato
    # Fixed centered dropdowns in RTL mode
    
    ------- 1.7.11 Release [06-January-2010] -------
    
    06-Jan-2010 Brian Towles
    # Fixed bug in SSL url handling
    
    ------- 1.7.10 Release [04-January-2009] -------
    
    03-Jan-2009 Djamil Legato
    # Fixed a typo that wasn't cleaning the dropdowns when closed.
    
    ------- 1.7.9 Release [30-December-2009] -------
    
    30-Dec-2009 Djamil Legato
    + Added full RTL support
    
    ------- 1.7.8 Release [11-December-2009] -------
    
    11-Dec-2009 Djamil Legato
    # Backward compatibility fix
    
    NOTE: DO NOT USE THIS VERSION WITH NEXUS TEMPLATE
    
    ------- 1.7.7 Release [08-December-2009] -------
    
    08-Dec-2009 Djamil Legato
    # Fixed 'ghosts' submenus that didn't let click on the page in some circumstances
    
    ------- 1.7.6 Release [26-November-2009] -------
    
    
    26-Nov-2009 Djamil Legato
    + Added centering option for having the dropdowns center aligning to the root item
    
    ------- 1.7.5 Release [30-August-2009] -------
    
    30-Aug-2009 Andy Miller
    # Updated CSS and created IE6 CSS for new fusion.js format
    
    29-Aug-2009 Brian Towles
    # Fixed child menus showing up at the wrong time when not showing all links
    
    
    28-Aug-2009 Brian Towles
    # Fixed menulinks to honor their own params and not show as active
    # Fixed extended link query string creation on SEO and not.
    
    ------- 1.7.4 Release [19-August-2009] -------
    
    19-Aug-2009 Brian Towles
    # Fixed handling of HTML Special characters in menu item titles.
    ^ Moved to namespaced events to help prevent collisions with other extensions.
    # Fixed handling of no parameter menu items. 
    
    ------- 1.7.3 Release [14-August-2009] -------
    
    14-Aug-2009 Brian Towles
    # Fixed bug with backwards compatibility with older templates
    
    07-Aug-2009 Brian Towles
    # Fixed bug in fusion theme not calling getLink in the layout
    
    ------- 1.7.2 Release [07-August-2009] -------
    
    06-Aug-2009 Brian Towles
    # Fixed Multiple instances resulting in fatal error
    ^ Moved Formatting classes to be Named based on Default/Template and theme name
    # Fixed issue with multiple roknavmenu instances with different themes causing crashes
    + Added link additions to the node type
    + Added extended link plugin to let menu item use of link additions 
    
    06-Aug-2009 Djamil Legato
    # Fixed javascript error when no sublevels present
    
    ------- 1.7.1 Release [01-August-2009] -------
    
    01-Aug-2009 Brian Towles
    # Fixed php4 compatibility with class_exists
    
    31-July-2009 Brian Towles
    + Added i18n language support for modules theme parameters
    + Added i18n language support for boost menu item parameters 
    
    ------- 1.7 Release [31-July-2009] -------
    
    + New component based installation/uninstallation
    + Added RokNavMenu Theme support for module and templates
    + Added "Boost" plugin to allow overriding of menu items
    + Added NEW Fusion theme
    
    ------- 1.5 Release [18-June-2009] -------
    
    ! Initial release. 
    

    Legend:
    
    * -> Security Fix
    # -> Bug Fix
    + -> Addition
    ^ -> Change
    - -> Removed
    ! -> Note
    
    ------- 1.4 Release [10-January-2009] -------
    10-Jan-2010 Brian Towles
    # Fixed bad comment that removed imports
    
    ------- 1.3 Release [10-December-2009] -------
    4-Sep-2009 Brian Towles
    # Set parameters to only show published menu items for active select 
    
    ------- 1.2 Release [14-August-2009] -------
    
    14-Aug-2009 Brian Towles
    # Minor bugfix for header output
    
    ------- 1.1 Release [11-August-2009] -------
    
    10-Aug-2009 Brian Towles
    # Added Javascript and CSS header output.
    
    ------- 1.0 Release [30-June-2009] -------