This documentation has moved. For the most recent documentation, check out https://docs.adaptavist.com. Please update your bookmarks and links.

Skip to end of metadata
Go to start of metadata

Description

The Lozenge macro creates a lozenge button with optional link.This macro creates a professional lozenge effect that's ideal for creating professional looking buttons, or simply highlighting important information.

The Lozenge macro is designed for small amounts of content (although the width can be changed to accommodate more content if required). This is to ensure that the content contained within the lozenge is concise, and in turn leads to an improved user experience.

Usage

Click Insert > Other Macros.

 

Select the Lozenge macro from the provided list.

 

Complete the desired fields.

ParameterDescriptionType

Default

Required?
Page or URL

If specified, clicking the lozenge will go to the specified link.

string

none

(error)

IconThe url for an image (no larger than 48x48 pixels) or even text if desired.stringnone(error)
TitleThe title of the lozenge, also used as the tooltip for links.stringnone(error)
ColorSpecifies the color of the left portion of the lozenge.single selectnone(error)
Arrow

Defines which arrow to use on the left portion of the lozenge:

  • none (default if no "link" specified) - the arrow will not be displayed
  • blue (default if a link is specified) - a blue arrow will be displayed
  • green - a green arrow will be displayed
single selectnone(error)
WidthThe width of the entire lozenge in px or %. Specify auto to make the lozenge automatically stretch to fit its contents.stringnone(error)
Use the table based lozengeCompatibility setting for use if the lozenge does not display correctly in older browsers.checkboxunselected(error)

 

The macro will then appear on the page.

 

The body of the macro should contain the summary text. This can, for example, be used to place excerpts in to the lozenge using the excerpt-include macro.

If the macro parameter "Page or URL" is supplied with a value that does not exist, when clicking the lozenge the first time Confluence will create a new child page with the value supplied in the "Page or URL" parameter. On subsequent attempts Confluence will navigate to the created page.

 

Colors:

There are 9 colors to choose from for the left side of the lozenge, and two colors for the arrow with the option to show no arrow.

Color

No Arrow

Blue Arrow

Green Arrow

bronze

silver

gold

blue

cyan

green

purple

pink

red

Examples

Basic Lozenge

Create a simple lozenge as follows:

Resulting in:

This is a basic lozenge with default color, no link or icon.

Lozenge Icon or Label

Add icons

The icons are not included in the add-on, you have to supply them.

The icon should ideally be 32x32 or 48x48 pixels. If you are using the Builder theme, you can use PNG images with alpha transparency.

With the Icon parameter set to "bell.png".

Results in:

 

You can also use icons that are attached to other pages (or even external icons by specifying their URL).

 

Alternatively, you can use text instead of an image:

With the Icon parameter set to "Bell".

Results in:

Bell
 

 

Lozenge Arrows

Add a blue arrow to the lozenge as follows:

With the Icon parameter set to "bell.png", the Title parameter set to "Blue", and the Arrow parameter set to "blue".

Resulting in:

Blue
Blue
A blue arrow...

 

When you add a link to the lozenge, it will automatically get a blue arrow:

With the Icon parameter set to "bell.png", the Link parameter set to "lozenge macro", and the Title parameter set to "Click me".

Resulting in:

This lozenge links to Adaptavist website.

The title is linked so that browsers with JavaScript disabled can still follow the link. If a title is not specified, the link will disappear so browsers without JavaScript won't be able to follow the link.

Always specify a title for linked lozenges.

 

You can choose a green arrow as follows:

With the Icon parameter set to "bell.png", the Link parameter set to "lozenge macro", the Title parameter set to "Click me", and the Arrow parameter set to "green".

Resulting in:

This lozenge links to Content Formatting macro.

Or no arrow at all:

With the Icon parameter set to "bell.png", the Link parameter set to "lozenge macro", the Title parameter set to "Click me", and the Arrow parameter set to "none".

Resulting in:

This lozenge links to Content Formatting macro.

Lozenge Color

Choose the lozenge colors by editing the macro (see parameter table above)

Two Lozenge macros each in a Column macro within a Section macro.

Resulting in:

Take the Blue Pill
Take the Blue Pill
Wake up in your bed and believe whatever you want to believe...
Take the Red Pill
Take the Red Pill
Stay in Wonderland and I show you how deep the rabbit hole goes...

The section macro and column macro are ideal for putting lozenges side by side as shown above. The lozenges default width is designed to allow two lozenges to be displayed side by side within the default Builder page width of 750px which fits nicely on an 800x600 screen.

Lozenge Width

By default, all lozenges are 347px wide. However, you can make them stretch to fit their content.

With the Icon parameter set to "compass.png", and the Width parameter set to "auto".

Resulting in:

Lorem ipsum dolor sit amet, ea vel legere euismod senserit,  inimicus rationibus vel an. Porro labitur nostrum has ad, no epicurei similique conclusionemque vix,  ne vel suas graeci impedit. Ei pro quaeque facilis imperdiet, cum ad ludus platonem iracundia. Virtute consulatu per at, vix amet inani alterum ut.

You can also set a percentage width as follows:

With the Width parameter set to "70%".

Resulting in:

70% of available width.

Or you can set the width in pixels as follows:

With the Width parameter set to "200px".

Resulting in:

200 pixels

 

Frequently Asked Questions:

Q

I've put in the name of an icon as shown in the example, but it's not appearing and I get an error message.

A

You need to attach the icon to your page or provide a URL to an icon elsewhere - this macro doesn't contain the icons.

 

Top of page

  • No labels