An attachment is any file that is included with your page. Examples of attachments are screenshots, photographs, other images, Word documents, presentations, PDF documents, videos and sound files. Attachments are useful when you want to share information that exists in another file format.

You can display a list of attachments on your page – these may be the files that are attached to the page or to any page in the space. Use the Attachments macro to show a list of the attachments on the current page. Use the Space Attachments macro to show a list of the attachments in the current space. Both these macros generate a table of attachments which is clickable.

Using the macros

To add the Attachments or Space Attachments macro to a page:

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

Speeding up macro entry with autocomplete:

Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

To edit an existing macro: Click the macro placeholder and choose Edit. This will display the parameters of the macro in the Macro Browser.

Parameters of the Attachments macro

Parameters are options that you can set to control the content or format of the macro output.

Parameter

Default

Description

Filename Patterns

all

A comma-separated list of regular expressions, used to filter the attachments by file name. Note that the parameter values must be regular expressions. For example:

  • To match a file suffix of 'jpg', use .*jpg (not *.jpg).
  • To match file names ending in 'jpg' or 'png', use .*jpg,.*png

Here is a tutorial on regular expressions.

Attachment Labels(none)A list of labels, used to filter the attachments to display. If you wish to enter more than one label, separate the labels with commas. Confluence will show only attachments that have all the labels specified. (The match is an AND, not an OR.) For information on labelling the attachments, see Adding Labels.

Include Old Attachment Versions

false

A value of true will include previous attachment versions in the list.

Sort By

date

The sort order for attachments. Note that people viewing the page can change the sort order by clicking the column headings. Valid values are:

  • date – sorts by reverse chronological order (newest first)
  • size – sorts largest to smallest
  • name – sorts alphabetically
Sort OrderascendingUsed in combination with the Sort By parameter, to sort the attachments in ascending or descending order.

Allow Upload

true

If selected, the list of attachments will include options allowing users to browse for, and attach, new files.

Page Title(none)Used to display attachments from another page. If you do not enter a page title, the macro will display the files attached to the current page.

 

Viewing files and changing file properties from the Attachments macro

The list of files displayed by the Attachments macro includes options for viewing the files and other actions, provided the user has the relevant permissions.

  • If you have specified the 'Allow Upload' parameter, users will be able to upload attachments directly from the list.
  • Users can remove attachments. Note that they can only remove the entire attachment, including all versions of the attachment. To remove a specific version of an attachment, they must go to the 'Attachments' view. See Deleting an Attachment.
  • Users can edit attachment properties and labels. If an attachment is an Office or PDF file, they will see the appropriate options for Office Connector files.

Screenshot 1: The Attachments macro

Parameters of the Space Attachments macro

Parameters are options that you can set to control the content or format of the macro output.

ParameterDefaultDescription
Space(none)Selects the Confluence space to display all attachments for. If no space is specified, the current space will be used.
Attachment Labels(none)Filters the attachments to display, based on a list of labels. If you wish to enter more than one label, separate the labels with commas. For information on labelling the attachments, see Adding Labels.
Show Filter ControlstrueDetermines whether or not the filter panel is shown. The filter panel allows you to filter the list of attachments by file type (extension).

Screenshot 2: The Space Attachments macro


 

  • No labels