CUTE for Jira and Confluence
Page tree

We have finally moved our support portal to the cloud, which includes this documentation as well.
All documentations here are therefore no longer up to date.
Please follow the link for the latest documentation: https://communardo.atlassian.net/wiki/spaces/cute/overview

Skip to end of metadata
Go to start of metadata

Content

 

 

Installation

Installing the Plugin

Confluence

The plugin is available at the Atlassian Marketplace (CUTE for Confluence, CUTE for JIRA). To install the plugin, log in as system administrator and navigate to the global administration (Browse > Confluence Admin). Enter the Plugins section and navigate to the "Install"-Tab". Search for "CUTE" and press "Install".

If the installation was successful, a new item should appear in the "Look and Feel" section of the system administration, called "CUTE". All settings of the theming extension are configured at this place. If this link is not visible, please ensure that all required modules of the plugin are enabled. You can do this by clicking "Manage Plugins" in the global administration and selecting the "CUTE". The module "Cute Empty Dashboard" might only be enabled if you intend to replace the Confluence system dashboard with own extensions. Otherwise you may wish to leave this disabled.

JIRA

The plugin is available at the Atlassian Marketplace (CUTE for Confluence, CUTE for JIRA). To install the plugin, log in as system administrator and enter the global administration. At the "Plugins" Tab navigate to the "Install Plugins", search for "CUTE" and press "Install".

If the installation was successful, a new item should appear in the "User Interface" section of the system administration, called "CUTE". All settings of the theming extension are configured at this place. If this link is not visible, please ensure that all required modules of the plugin are enabled. You can do this by clicking "Manage Plugins" in the global administration and selecting the "CUTE".

Licensing

During Beta Phase the add-on is available without charge in the Atlassian Marketplace (CUTE for Confluence, CUTE for JIRA). For further information on licensing see CUTE Licensing.

Backup CUTE data

Depending on the way you chose to backup your JIRA or Confluence instance a separate backup of your CUTE extensions might be needed.

  1. If you perform your backup by backing up the database and the whole home directory then all CUTE Extensions are automatically included.
  2. In case you opt to perform a XML backup of your Atlassian product you need to backup your CUTE Extensions separately. You can do this by simply saving the "cute" folder in the applications home directory.

Theming

Working with Extensions

As mentioned above, all theming is applied in the system administration. Theming is highly flexible and is applied via one or more extensions. Extensions basically define a set of customizations, ranging from a simple message box to a full-fledged theme for Confluence and JIRA. Extensions can be either created from scratch or imported as CUTE-file. A good place to start theming with CUTE is to visit this page and download one of the provided example Extensions.

The following screen gives you an overview on how to work with extensions.

              1. Shows an active Extension
              2. Shows an inactive extension
              3. Options for adding extensions
              4. Options to edit existing extensions

 

Editing an extension

The following image shows the edit extension dialogue:


              1. General Configuration
              2. Extension Properties
              3. Configuration of the Theme

 

 

 

 

The General Configuration provides options to enter a name, a unique key, a version and a description for the extension. The description and the version can be provided optionally while the other details are mandatory for each extension.

Extension Properties can be used to provide parameters of the extension that might be quickly adjusted without changing the HTML, Javascript or Stylesheet sections (more on that in a second) of the extension. This can be useful to define a basic extension that can be modified for each different JIRA/Confluence instance (e.g. different customers) by the system administrator who might not happen to be a developer. Extension Properties are called in the Configuration of the Theme.
The defined property values can be used in all resource files (except images (smile)) by calling them with @PROPERTYNAME. 

The Configuration of the Extension enables you to describe all your adjustments in detail. It provides sections for Templates, Stylesheets, Javascripts and Images that can be used to refine your Extension. Please note that changes made to any of these options will be visible as soon as the changes are saved.

 

 

 

 

 

 

Other Versions