[All Adaptavist Apps]

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 35 Next »

Installing Builder

Installing and upgrading the Builder theme...

Requirements

  • You must have system administration privileges to install the theme
  • You must have correctly set the Base URL in Confluence's [General Configuration] settings.

Should you encounter any problems, please see our [Troubleshooting Guide] which lists all common problems and how to fix them.

Installing the Builder Plugin

If you are upgrading from an earlier version of Builder, please see the important notes on upgrading Builder later in this tutorial.

When manually downloading plugins using Internet Explorer, make sure the file extension isn't changed to ".zip" - if it is, change it back to ".jar" before installing the plugin.

Plugin Requirements Overview

Confluence Version

Plugin Repository

Theme Builder

Content Formatting Macros

Page Information Tools

1.4.x

n/a

1.4

n/a

n/a

2.0.x – 2.1.x

1.2

2.0.3

1.6.3

1.2.2

2.2.x

1.2

2.0.3-conf22

1.6.3

1.2.2

2.3.x - 2.4.x

Pre-installed

2.0.4

Latest

1.2.5

2.5.x

Pre-installed

2.0.9 or above

Latest

1.2.5

2.6.x

Pre-installed

2.0.9 or above, 3.x for best results

Latest

1.2.8 or above

Confluence 1.4.x is no longer supported - you can try Builder 1.4 or 1.5 if desired. The Content Formatting and Page Information Tools plugins were not required for Builder 1.x.

Installing Dependant Plugins

Theme Builder requires two open source plugins, both developed by Adaptavist, to be installed:

  • [Page Information Tools Plugin] (CONFEXT)
  • [Content Formatting Macros] (CONFEXT)

The easiest way to install these plugins is via the Plugin Repository. Alternatively you can download these plugins manually and install via the Plugin Manager or "Uploads" tab on the Plugin Repository.

Note: These plugins are only required for the navigation and title panels default settings - if you don't want to use tables or display page information in your customised theme design, you will not require these plugins.

Installing Theme Builder

Take a full backup of Confluence then follow the instructions applicable to the [version of the Builder theme] you are using as shown below:

  1. Manually download the plugin from the URL in your license email.
  2. Install the plugin using the Confluence Plugin Manager (in Administration Console)
  3. Restart Confluence to complete the installation
  1. Manually download the plugin from the URL in your license email.
  2. Install the plugin using the Confluence Plugin Manager (in Administration Console)
  1. Install the plugin using the Plugin Repository
  2. Click the "config" link that appears next to the plugin and enter your license key

Upgrading Builder

Before upgrading Builder, please take a full backup and ensure that you have uninstalled any previous versions:

  • If you manually installed the plugin to the WEB-INF/lib folder, you must manually delete that file
  • If you uploaded via the [Plugin Manager], select the "Site Builder" plugin from within the [Plugin Manager] and click the "Uninstall Plugin" link to remove it
    Unknown macro: {footnote}

    On some occasions, you may get an error message stating that the plugin could not be uninstalled. Should this happen, restart Confluence and try again.

After uninstalling any previous versions, you can install the new version as described earlier in this tutorial.

Unknown macro: {display-footnotes}

Bug Reports and Feature Requests

Before reporting a bug, please check our [Builder Release Notes] - it's possible a recent version of the theme already resolves the issue you have.

Our tutorial on [Reporting Bugs] explains the process for informing us of bugs or ideas for new features for the

Unknown macro: {builder}

theme. It also lists all currently reported items and has a link to our development roadmap.

  • No labels