This documentation relates to an earlier version of Confluence.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

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. See below for instructions on how to add the gallery macro to your page.

The gallery macro appears as in the screenshot below.

Screenshot: The Gallery Macro in Confluence

On this page:

Usage with the Macro Browser

To insert the gallery macro into a page using the Macro Browser,

  1. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

(tick) You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Once you've found the gallery macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

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

Parameters

Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

The full list of parameters is shown in the following table.

Parameter

Default

Description

Gallery Title
(title)

Nothing

Specify a title for your gallery.

Number of Columns
(columns)

4

Specify the number of columns for your table.

Images to Exclude
(exclude)

No exclusions i.e. include all the pictures on the page.

The gallery will ignore any pictures specified by exclude=picture file name i.e. they will not be included in the gallery. You can specify more than one picture, separated by commas. Example: exclude=my picture.png,my picture2.gif
Please note, the filename and filetype for this parameter are case-sensitive, i.e. 'my picture.PNG' will not be recognised as 'my picture.png'.

Include these Images Only
(include)

Include all the pictures on the page.

If you specifically include one or more pictures, the gallery will show only those pictures. Format is include=picture file name. You can specify more than one picture, separated by commas. Example: include=my picture.png,my picture2.gif
Please note, the filename and filetype for this parameter are case-sensitive, i.e. 'my picture.PNG' will not be recognised as 'my picture.png'.

Use Images in these Pages
(page)

If no page is specified, the gallery macro displays the images attached to the page on which the macro is used.

Specify the title of the page which contains the images you want displayed. If the page is in the same space as the page containing the macro, use the format page=My Page Name. To specify a page in a different space, use page=SPACEKEY:My Page Name, such as page=DOC:Gallery Macro

Reverse Sort
(reverseSort)

Nothing, i.e. sort order is ascending

Used in conjunction with 'sort' parameter above. Use 'reverseSort' to reverse the sort order, from ascending to descending.

Sort Images By
(sort)

None i.e. the sort order is unspecified and therefore unpredictable.

Specify an attribute to sort the images by that attribute. Sort order is ascending, unless you specify the 'reverseSort' parameter (see below). Options are:

  • 'name' – file name.
  • 'comment' – comment linked to the attached file.
  • 'date' – date/time last modified.
  • 'size' – size of the attached file.
Icon

If the actual name of an attachment file or page contains a comma, you can refer to it in the exclude, include, or page parameters above by enclosing it in single or double quotes, for example "this,that.jpg", theother.png.

Considerations for using the gallery macro

Icon
  • 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.

Examples

Basic Usage, Specifying Number of Table Columns

Excluding an Image

Specifying the Images to be Included

The macro code below will show only two images: 'office1.jpg' and '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.

Below, we specify a page in a different space.

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.

Sorting the Images by File Name

Sorting the Images to Show Most-Recently-Modified First



RELATED TOPICS

Viewing Images as a Slide Show
Displaying an Image
Displaying a Thumbnail Image
Attaching Files to a Page
Editing Attachment Properties
Working with Macros

Take me back to the Confluence User's Guide.