Free Hmenu Plugin

We reviewed client use cases and found that depreciated Hmenu plugin macros had become an integral part of the theme for several use cases. We then concluded that the simplest solution was to migrate the old menu macros into a separate standalone menu plugin.

If you would like to try this Hmenu plugin you can download it here along with the latest versions of ThemeBuilder and the Exporter plugin. Please note that the plugins are Beta versions and should not be installed on live production systems without suitable testing on a development server. If the beta status is a problem for you, but you find that the plugins solve your menu issues, please check back on this page for an update when new release versions are available.

This free plugin is provided on condition that it will simply reproduce the ThemeBuilder menu code as seen in Confluence versions prior to 5. Any issues reported for the plugin used on Confluence 5 will not be considered if they cover conditions where the conflict is with the new Confluence user interface, any Confluence macro or function, or in page content. In these cases the user will be expected to use ThemeBuilder to remedy the issue by adapting the markup or CSS that produces the menu. An exception to this is code bugs, which will be resolved as developer time allows.

Click to download the free Hmenu plugin.

Using the Exporter and Hmenu Plugins

The Hmenu plugin is designed to work with a Confluence 3 or 4 ThemeBuilder backup that has not been migrated to Confluence 5.

If your Confluence 5 server:

  • HAS NOT been used for a ThemeBuilder migration

  • DOES have ThemeBuilder or the Exporter installed

You should follow all steps from 4 onwards to uninstall the existing ThemeBuilder and Exporter plugins and import the original ThemeBuilder backup from the old Confluence server.


If your Confluence 5 server:

  • HAS NOT been used for a ThemeBuilder migration

  • DOES NOT have ThemeBuilder or the Exporter installed

You should follow all steps from 5 onwards to import the original ThemeBuilder backup from the old Confluence server.


If your Confluence 5 server:

  • HAS BEEN used for a ThemeBuilder migration

  • DOES HAVE ThemeBuilder or the Exporter installed

You should follow all the steps to reset the ThemeBuilder data and then import the original ThemeBuilder backup from the old Confluence server.

Instructions

  1. Go to ThemeBuilder Backup > Create Backup > Backup All Layouts > Check All Boxes.

  2. Click Download and save the zip backup to a safe place. (You will only need this backup if the Hmenu migration fails and you want to return to this state.)

  3. Stay on the ThemeBuilder Backup screen and go to the Reset Layout Data section. (If this is greyed out, run the backup action again. The lower areas on the Backup screen only become active when a backup has been saved.)

    1. Enter the Server Base URL (you can copy this from the General Configuration screen) and select the Delete Layout Data Before Resetting checkbox.

    2. Click Delete All.
      This will clear all ThemeBuilder layout data from your server so only do this if you have the backup from step 1.

  4. Go to Manage Add-Ons and delete the ThemeBuilder and Exporter plugins. Also delete the Hmenu plugin if this has been installed. This is to ensure that all ThemeBuilder data is reset and ready for a fresh migration.

  5. Click to install the latest ThemeBuilder and Exporter plugins.

  6. Go to ThemeBuilder > Backup > Restore Backup.

  7. Upload the un-migrated ThemeBuilder backup from your old Confluence installation.

    1. Select the relevant boxes if you have templates or user macros to import.

      1. Do not select Merge Uploaded Layout Data With Existing Layouts.

      2. Select the Select Builder as the Theme Based on the Data in the Backup File checkbox, if you want to carry over previous Confluence to ThemeBuilder relationships.

      3. Select the Set the Skin Selection Based on the Data in the Backup File checkbox, if you want to carry over previous Space to Skin relationships.

  8. Go to ThemeBuilder > Export Layouts to Skins.

    1. Select Export All in the drop-down menu.

      1. Select the Prevent menulinks and compound-menuitems From Being Converted to web-items checkbox.

      2. Select the Prevent menubar Macros Being Converted Into New Single-Level Format checkbox.

    2. Click Export and save the zip file.

  9. Install the Hmenu plugin.

  10. Go to ThemeBuilder > Backup > Restore Backup.

  11. Upload the migrated ThemeBuilder backup you saved in step 6.

    1. Select the relevant checkboxes if you have templates or user macros to import.

      1. Do not select the Merge Uploaded Layout Data with Existing Layouts checkbox.

      2. Select the Select Builder as the Theme Based on the Data in the Backup File checkbox if you want to carry over previous Confluence to ThemeBuilder relationships.

      3. Select the Set the Skin Selection Based on the Data in the Backup File checkbox if you want to carry over previous Space to Skin relationships.

  12. Go to ThemeBuilder > Edit Skins to view your imported skins.

  13. View a space or page with a ThemeBuilder skin applied and check your menus.

There will still be edits needed for menu items that no longer exist in Confluence, or for %name% functions like %Watch%. Also, note that in our trials we have seen %User% continue to work.