Page tree
Skip to end of metadata
Go to start of metadata

With Lively Theme you can add a header, footer, custom menus and customize your dashboard, space homepages and other pages with beautiful widgets


On this page:

Enabling Lively Theme

In order to use the Lively Theme elements like the header, footer, menus and dashboard, Lively Theme must be enabled in the theme settings. Go to the Confluence Administration → Look and Feel / Themes, select Lively Theme and confirm.


Custom Elements

The custom dashboard, header, footer, menu and submenu are called custom elements in Lively Theme. Those can be separately enabled or disabled in the Lively Theme settings.

Enabling Custom Elements

Go to Administration → Lively Theme → Settings and check those custom elements you want to enable for your Confluence instance. Then click Save at the bottom.

Editing Custom Elements

To edit custom elements, go to a page where you see the element, for example the dashboard, and click on the edit icon in the top right corner of the particular element.

By default, every Confluence administrator can see the edit icon and is able to edit the element until the page is created (see below).

Creating the Custom Element Page

In order to edit any of the custom elements, a Confluence page needs to be created. On the first time clicking the edit icon, you will be presented with a dialog to create the Confluence page. It can be in your personal space, or in any space you like.

If you restrict the editing of the page, you will be the only person that can edit it. You can of course edit the page restrictions to allow additional users to edit the page. Then they will also see the edit icon of the particular custom element.

From now on, if you click the edit icon, you will be redirected in the editing mode of the dashboard page.

Removing or Setting Another Custom Element Page

If you go the Confluence Administration → Lively Theme → Settings you can remove the page for each custom element or choose a different one.

Background Colors

The background color can be changed for every custom element. Go to Administration → Lively Theme → Settings and chose a color with the color picker or enter a hex value manually.

Macros

Widget Macro

The Widgets macro is used on the dashboard page but it actually can be used on any page.

Parameters

AttributeDefault valueDescription
Titlenone

The title of the widget.

Can be any text. Example: My Open Tasks

Colorgray

The widget top color.

This must be a 6 digit color hex code, preceded by the pound sign. Example: #0052CC

Content Stylewidget

The style that should be applied to the content. By default the "widget" style applied to make popular macros and content elements like tables better fit into a widget.

The option "menu" adds styles to make lists and tables look more like a menu and "expand-menu" allows creating menus with the Expand macro.

The option "none" will apply no style and the Confluence content will be displayed as it is.

Examples for content style "widget"

Tasklist maco before:

Tasklist maco after:

Table before:

Table after:

Examples for content style "menu"

Table with icons before:

Table with icons after:

Examples for content style "expand-menu"

Table with Expand macro before:


Table with Expand macro after:

HiddenuncheckedIndicates whether the widget should be displayed or not.

Advanced Parameters

ParameterDefault valueDescription
Actions

none

Further actions are links that are displayed with an icon on the top right of a widget.

Actions are defined as a JSON array of action objects with these keys:

KeyDescription
typeOnly "link" is accepted as a type at the moment. Example: link
linkThe link where the action should point to. This can be an external link (http://...) or an internal link. Example: /plugins/inlinetasks/mytasks.action
iconThe AUI Icon code. Example: arrows-right
tiitleThe title of the action. Can be any text. Example: Tasks

Full Example:

[
  {
    "type": "link",
    "icon": "arrows-right",
    "title": "Tasks",
    "link": "/plugins/inlinetasks/mytasks.action"
  }
]
Macro ParametersnoneComma separated list of a key-value pairs separated by a colon. Allows to set macro parameters of macros inside the widget. It is used for example to set the current user in the task report macro. Example: assignees:@currentUser
Hide SelectornoneA CSS selector to hide element inside the widget macro if they should not be displayed inside the widget.


Column Width Macro

The Column Width macro can be used to customize the width of a section column. Just place it anywhere inside the section. Use a percentage or a pixel value for the column width. Example: 25%

Confluence Element Macro

The Confluence Element macro can be used to display Confluence elements like the all-updates stream, the welcome message or the footer.

With the option "dashboardPanelSelector", a CSS selector can be provided that matches a Confluence web panel that is used on the dashboard. Example: ".new-dashboard-calendar-container" for the Team Calendars panel.

Margin Macro

The Margin macro allows to add a margin to the content contained inside the macro.

The margin is provided in CSS syntax (top right bottom left), so for a top margin of 50 pixels and a right margin of 60 pixels, the value is "50px 60px 0 0".

List Macro

The List macro generates the following 3 lists.

List TypeDescription
recentlyViewedSpacesA list of the max. 10 recently viewed spaces of the current user.
favouriteSpacesA list of the users favourite spaces.
spacesByCategoryA nested list of spaces by category. The categories are provided by a comma separated list. If there is only one category, just a simple list of spaces is returned.


Menu Macro

The Menu macro generates a vertical or horizontal AUI (Atlassian User Interface) menu from a list. If the list is nested, a nested menu will be generated. Additionally a max. width or height in pixels can be provided to restrict the width or height of them menu.

Examples:

List in the editor

Vertical menu

Horizontal menu

Button Macro

The Button macro allows to add AUI (Atlassian User Interface) buttons in normal or primary style and with or without icon to the content. The link can be a page, an external resource or an anchor.

Example (title: My Button, icon: weblink):

Regular buttonPrimary buttonRegular button with iconPrimary button with icon


Widget Examples

NameScreenshotContentContent Style
Welcome Message

Dashboard Element macro

Element: welcome-message

widget
My Open Tasks

Task Report macrowidget
News

Blog Posts macrowidget
Calendar

Confluence Team Calendars must be installed.

Dashboard Element macro

Element: custom

Web Panel Selector: .new-dashboard-calendar-container

widget
Questions

Confluence Questions must be installed

Question List macro

widget
Administrators

User List macro

Groups: confluence-administrators

widget
Link Menu

Links, each in one linemenu
List Menu

Links in a listmenu
Table Menu

Links in a table with one columnmenu
Icon Menu

Links in a table with 2 rows, the first one for the iconsmenu
Expand Menu

Links inside the Expand macroexpand-menu
Icon Menu

Icons with text in a table with one rowwidget
Button Menu

Button images in a table with one columnwidget


Further links



Download Lively Theme for Confluence
from the Atlassian Marketplace and
try it for free!