This page last changed on Dec 17, 2009 by ggaskell.

Use Confluence's Attachments Macro to display a list of attachments that belong to the current page. It will generate a table like the image shown below.

Screenshot: List of attachments from 'Attachments' macro

On this page:

Usage with the Macro Browser

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

  1. Open your desired Confluence page or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
  2. Click the Macro Browser icon on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode.
  3. Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
  4. Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to put the macro into the page.

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


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

Usage with the Wiki Markup Editor

What you need to type What you will get
{attachments}
Name Size Creator Creation Date Comment  
JPEG File office1.jpg 94 kB Vidya Madabushi Aug 09, 2005 20:13    
JPEG File waterfall.jpg 1.27 MB Vidya Madabushi Aug 09, 2005 20:13    
File editProfile.png 33 kB Sarah Maddox [Atlassian Technical Writer] Oct 08, 2007 00:02    

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 (:).

Parameter Default Description
Filename Patterns
(patterns)
all Specify which attachments to display using filename patterns.
Include Old Attachment Versions
(old)
false Include old attachments versions in the list.
Sort By
(sortBy)
date Specify the sort order for attachments. Valid values are "date", "size" and "name".
Allow Upload
(upload)
false Adds functionality to allow the upload of new attachments.

Examples

1. Filter Attachments by File Name

{attachments:patterns=.*jpg,.*gif}

Use a comma-separated list of regular expressions to specify the filenames of the attachments you want displayed.

Note
The patterns are regular expressions, so to match a file suffix of 'jpg', use .*jpg, not *.jpg.

Here's a detailed tutorial on regular expressions.

2. Include Old Attachments

{attachments:old=true}

An optional true/false value determines whether to show old versions of attachments. This is set to false by default.

Viewing and Editing Files from the Attachments Macro

If an attachment is an Office or PDF file, you will see a 'View' link as shown in the screen snippet below. Furthermore, if the attachment is an Office file, it will also have an 'Edit in Office' link.

Screenshot: Office and PDF file page attachments with 'View' and 'Edit in Office' links



Click the 'View' link to view the content of the Office file within Confluence.

Click the 'Edit in Office' link to edit the content of the Office file in your Office application. You must have a compatible Office application installed to do this. Refer to Working with the Office Connector for more information.

Attachment Information Icon

When a page you are viewing contains attachments, a small paperclip icon like this:     appears next to the page byline. Clicking the paperclip will take you to the 'Attachments View', where the full list of attachments is displayed.

RELATED TOPICS

Working with Attachments Overview
Working with Macros

Take me back to the Confluence User's Guide.


waterfall.jpg (image/jpeg)
office1.jpg (image/jpeg)
editProfile.png (image/png)
editProfile.png (image/png)
Document generated by Confluence on Jul 09, 2010 01:08