This page last changed on Jun 24, 2008 by smaddox.

Gallery Macro

Basic usage, showing two parameters:

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

Below is the full list of the parameters available.

Parameter Optional or Mandatory Default Description
title Optional Nothing Specify a title for your gallery.
columns Optional 4 Specify the number of columns for your table.
exclude Optional 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
include Optional 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
page Optional If no page is specified, the gallery displays the images attached to the page containing the macro. 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
slideshow N/A N/A The 'slideshow' parameter is not used in the latest version of the Gallery macro, and the slide show is always enabled. We have left the parameter here for compatibility with older versions of the macro.
sort Optional 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.
reverseSort Optional 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.

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

Document generated by Confluence on Dec 03, 2008 15:04