[All Adaptavist Apps]

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
h1. Installing Builder

...


{scrollbar

...

:no-css

...

Excerpt

Find out how quick and easy it is to install the Builder theme...

System Requirements

...

=true}

*{excerpt}Find out how quick and easy it is to install the Builder theme...{excerpt}*

h2. System Requirements

Builder requires Confluence 2.1.2 or above

...

Intalling the Theme

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

...

.

h2. Installing the Builder Plugin

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

*Builder 1.4.x:

...

*

Copy the .jar file in to your WEB-INF/lib folder and restart Confluence.

...



*Builder 1.5 and

...

Upload the .jar file using the Plugin Manager in the Administration Console.

Instructions for upgrading the theme can be found later in this tutorial.

Applying the Theme to a Space

We strongly advise you to create a test space in order to ensure that the theme is working correctly. You will also be able to test out various configuration options and style sheets within the test space which can then be copied over to "live" spaces as and when required.

To apply the theme to a space, please see our tutorial on setting the Space Theme.

Customising the Theme

When the theme is first installed, it will look ugly - you'll need to apply the relevant customisation to make it meet your requirements. For more details, please see Theme Configuration.

Upgrading Builder

Always take a full backup. In addition, manually copy the settings from the theme configuration screen as some versions of Confluence will not include these in the backup.

Before upgrading Builder, please 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 and click the "Uninstall Plugin" link to remove it

After uninstalling any previous versions, you can install the new version.

...

 above:*

{note}If you are upgrading from Builder 1.4.x to Builder 1.5 or above, please see the important notes on [upgrading Builder|#Upgrading Builder] later in this tutorial.{note}

Upload the .jar file using the [Plugin Manager] in the [Administration Console]{footnote}After installing the new version, it's usually best to restart Confluence to ensure that any old templates are cleared from the cache.{footnote}.

h2. Applying the Theme to a Space

We strongly advise you to create a test space in order to ensure that the theme is working correctly. You will also be able to test out various configuration options and style sheets within the test space which can then be copied over to "live" spaces as and when required.

To apply the theme to a space, please see our tutorial on setting the [Space Theme].

h2. Customising the Theme

When the theme is first installed, it will look ??ugly?? - you'll need to apply the relevant customisation to make it meet your requirements. For more details, please see [Theme Configuration].

h2. Upgrading Builder

Always take a full backup.  In addition, manually copy the settings from the theme configuration screen as some versions of Confluence will not include these in the backup.

Before upgrading Builder, please 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{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.{footnote}

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

{display-footnotes}