Joomla Extensions
RokNavMenuLatest Version: J1.5 3.4 - J2.5 / J3.0 2.0.2
Powerful Core Menu Component RokNavMenu is a powerful menu module which provides functions above and beyond the capabilities of the core Joomla menu. It provides a feature rich platform for extending the menu, allowing for overrides and plugins for the menu itself, in addition to versatile theming capabilities and so much more.
The latest revisions feature inbuilt themes such as fusion, a complex dropdown menu system with optional javascript modes and URL extension capabilities.
List of Features
- Menu Themes: A series of themes ranging from a simple menu list to an advanced dropdown system
- URL Extension: Inbuilt parameter to append strings to Joomla links
- Administrator Overrides: Add custom parameters / options for individual menu items
- Plugin Support: Control all aspects of a menu item such as RokBox integration
- Foundation: RokNavMenu is at the core of all the powerful RocketTheme menus
- Dynamic Child Direction: At the browser windows edge, Fusion will force the pullouts in the opposing direction
Screenshots
RokNavMenu has an inbuilt theme to be easily integrated into any Joomla Template, in addition to its presence in RocketTheme templates and the menu styling that is made possible from it. Below are two sets of screenshots showing the module in both its standalone and integrated forms.
RocketTheme Joomla Template Club Examples:
Standalone Examples & Configuration:
Installation
Downloading the Extension Files
- RokNavMenu Module (mod_roknavmenu.zip) This file contains the module, in addition to the accompanying plugins such as Boost, all wrapped inside a component installer.
Using the Joomla Installer
- Login into the Joomla Administrator at http://yoursite.com/administrator
- Go to Extensions → Install / Uninstall
- Browse for mod_roknavmenu.zip (J15) / roknavmenu.zip (J25/J30)
- Click Upload & Install
Accessing the Extensions
RokNavMenu Module- Go to Extensions → Module Manager
- Find RokNavMenu in the list
- Select the title to access its options
- Go to Extensions → Plugin Manager
- Find RokNavMenu - Boost or another plugin in the list
- Select the title to access its options
Uninstall
- Login into the Joomla Administrator at http://yoursite.com/administrator
- Go to Extensions → Install / Uninstall
- Select the Components tab
- Select com_roknavmenubundle
- Click Uninstall
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.
RokNavMenu - Extended LinkExtended 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.
More Information...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.
Formatter PHPThe 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 PHPLayout.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.
Items & Parameters XMLThese 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.
Joomla 2.5
If you want to use your Joomla menu on phpbb3 side, first you need to make sure you have RokNavMenu module installed on your Joomla 2.5, then you need to install RokNavMenu exporter plugin. To do that, login into your Joomla Administration Control Panel , and click Extensions > Extension Manager from the top menu.
Now, you need to browse to directory where you have RokNaveMenu exporter package. When you find it, just press Upload & Install. Plugin is installed now.Now you need to go to the Extensions > Plugin Manager to browse for installed plugin. You should find similar entry to shown below:
When you enter plugin settings, a screen similar to one below will appear.You will need to set up some variables.
- Highlighted menu item on your phpbb3 board.
- Name of the file for head scripts. (not fully implemented yet)
- Name of the file for non-registered users of your forum.
- Name of the file for registered users of your forum.
- Relative or absolute url type.
- Set this option to "Enabled" to enable the plugin.
Joomla 1.5x
If you want to use your Joomla menu on phpbb3 side, first you need to make sure you have RokNavMenu module installed on your Joomla, then you need to install RokNavMenu exporter plugin. To do that, login into your Joomla Administration Control Panel , and click Extensions > Install/Uninstall from the top menu.
Now, you need to browse to directory where you have RokNaveMenu exporter package. When you find it, just press Upload File & Install. Plugin is installed now.Now you need to go to the Extensions > Plugin Manager to browse for installed plugin. You should find similar entry to shown below:
When you enter plugin settings, a screen similar to one below will appear.You will need to set up some variables.
- Highlighted menu item on your phpbb3 board.
- Name of the file for head scripts. (not fully implemented yet)
- Name of the file for non-registered users of your forum.
- Name of the file for registered users of your forum.
- Relative or absolute url type.
- Set this option to "Yes" to enable the plugin.
phpBB3 Side
Before using our generated menu, we have to set some phpbb3 settings aswell to enable support for RokNavMenu Exporter.
First of all, you need to have both latest version of the RokBB3 phpbb3 administration component and phpbb3 style you want to use.
If you have all necessary things installed (instructions are available on Rockettheme website). You need to select RokBB3 Global Configuration section which look like picture below where we also need to set some settings.
- Path to your joomla installation. It must be relative path. Usually absolute inclusion is blocked on servers. Basically if you are using phpbb3 in bridged mode, you should put there only: "../" , this will point rokbb3 to search for files one directory up.
- Name of the file for non-registered users of your forum. Copy this value from your plugin settings in Joomla, files names must be the same as set in Joomla plugin settings.
- Name of the file for registered users of your forum. Copy this value from your plugin settings in Joomla, files names must be the same as set in Joomla plugin settings.
Changelog
These are non-exhaustive changelogs for RokNavMenu, inclusive of any alpha, beta, release candidate and final versions.
