Gallery Macro

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.

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.

For more information, refer to Gallery Macro.

Troubleshooting

If you encounter the following error message: System does not support thumbnails: no JDK image support then ensure that you have following system property available for your JVM:

JAVA_OPTS=-Djava.awt.headless=true

Also see CONF-1737

Please note that gallery-ext.jar is available at CONF-6620

  • No labels