Installing Builder

Installing and upgrading the Builder theme...

Requirements

• Check the System Requirements
• The
  Unknown macro: {builder}

  theme requires Confluence 2.1.2 or above.

  • You must have system administration privileges to install the theme
  • You must have sufficient privileges to restart
    Unknown macro: {confluence}

    • You must have correctly set the Base URL in Confluence's [General Configuration] settings.

    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.

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

    For best results, we recommend using Builder 2.0 or above and use of the [Confluence Repository Client] to install the plugins - installing versions which are incompatible with your Confluence install is our #1 installation support request!

    Builder 2.0 and above

    Confluence v2.3 and Above
    You can install the latest versions of the Builder plugin and it's dependencies.

    Confluence v2.2.10 and Below
    You must install the following versions:

    • Builder v2.0.3-conf22
    • Content Formatting Macros v1.6.3
    • Page Info Plugin v1.2.2

    If you use the [Confluence Repository Client], these versions would automatically be selected for you.

    Before installing Builder 2.0, please install the latest versions of the following plugins:

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

    NB: To get the very latest versions of these plugins you might need to configure the repository client to show "All Versions" of plugins.

    You can then install the [Builder Theme] using the plugin repository client.

    Builder 1.5.x and 1.6.x

    Upload the .jar file using the [Plugin Manager] in the [Administration Console] and restart

    .

  Once installed, you will need to apply the theme to a space (see Enabling the Theme).

  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}

  Why all the restarts?

  Theme plugins are generally far more complex than your average plugin. There are some issues in Confluence that require a restart in order to make certain changes to take effect.

  Adaptavist are working closely with Atlassian and with each new release of Confluence, more of these issues are resolved. However, until all of them are resolved, you'll still have to restart Confluence when installing or upgrading the Builder theme.

  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 [Bug Reports and Feature Requests] explains the process for informing us of bugs or ideas for new features for the

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