View Source

The Gallery macro displays a gallery of thumbnail images in a table, based on the images attached to a Confluence page. When viewing the page, a user can click a thumbnail image to zoom into the full-size image and then view the images as a slide show.

For more information about how your readers will view the gallery, please refer to Viewing Images as a Slide Show. Below we tell you how to add the Gallery macro to your page.

The images shown in the gallery are taken from the files attached to the Confluence page. You can also specify a different page where the attachments are located. For information about attaching images to a page, see Attaching Files to a Page.
The comments below the images are drawn from the comments on the attachments. For information about adding comments to attachments, see Attaching Files to a Page.
By default, the gallery will include all the images attached to the page. You can also exclude or include images using parameters as described below.
Only the following file formats are supported: gif, png, jpeg. The bmp format is not supported.
You can sort your images into a particular order — see details below.
You can specify a title for the gallery and also configure how many columns you want for the table in which your images are displayed. See below for details of the parameters to use.
Read the rest of this page for more information.

On this page:

Using the Gallery Macro

Include the following markup in your page, replacing the title with your own:

What you need to type
{gallery:title=Some office photos, and a waterfall}
What you will get

Optional Parameters

Examples of Optional Parameters

Specifying the Number of Columns for your Table

{gallery:title=Some office photos, and a waterfall|columns=3}

Excluding an Image

{gallery:title=Some office photos, without the waterfall|exclude=waterfall.jpg}

Specifying the Images to be Included

The macro code below will show only two images: 'office1.jpg' and 'waterfall.jpg'.

{gallery:title=One office photo, and a waterfall|include=office1.jpg,waterfall.jpg}

Specifying a Page Name

By default, the images shown in the gallery are taken from the files attached to the Confluence page which contains the macro. You can also specify a different page where the attachments are located. For information about attaching images to a page, see Attaching Files to a Page.

The macro code below expects that the images are attached to a page called 'Gallery of Pictures', in the same space as the page containing the macro.

{gallery:title=Some office photos, and a waterfall|page=Gallery of Pictures}

Below, we specify a page in a different space.

{gallery:title=Some office photos, and a waterfall|page=DOC:Gallery of Pictures}

Combining the page and the include parameters, the code below will show only the two images specified, where the images are held as attachments on a different page.

{gallery:title=One office photo, and a waterfall|page=Gallery of Pictures|include=office1.jpg,waterfall.jpg}

Sorting the Images by File Name

{gallery:title=Some office photos, and a waterfall|sort=name}

Sorting the Images to Show Most-Recently-Modified First

{gallery:title=Some office photos, and a waterfall|sort=date|reverseSort}