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,
- Open your desired Confluence page or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
- Click the Macro Browser icon
on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode. - 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.
- Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to put the macro into the page.
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} |
|
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.
Comments (62)
Jul 26, 2007
Carol Kiparsky says:
In addition to selecting which columns to display, I would like to customize the...In addition to selecting which columns to display, I would like to customize the titles of the columns. Is that possible?
Jul 30, 2007
Rosie Jameson [Atlassian Technical Writer] says:
Hi Carol, This is not something that Confluence provides out-of-the-box. If you...Hi Carol,
This is not something that Confluence provides out-of-the-box. If you'd like to pursue other options, could I suggest that you try the Confluence forum at http://forums.atlassian.com, or contact Technical Support at http://support.atlassian.com ?
Regards,
Rosie
Jul 30, 2007
David Peterson [CustomWare] says:
You could use the Reporting Plugin, something like this.You could use the Reporting Plugin, something like this.
Jan 17, 2008
Anonymous says:
Is there any way to display the attachments for an entire space (rather than the...Is there any way to display the attachments for an entire space (rather than the page) using this macro? I am currently using the
with the
as an alternative but this limits the list to the name only and I can't edit/remove the attachments. Are there any other ways to accomplish this with the
Jan 20, 2008
Choy Li Tham says:
Hi, May I know if you are using the Reporting plugin macros to display the atta...Hi,
May I know if you are using the Reporting plugin macros to display the attachments for an entire space. If that is the case, Sorry to say that I'm not familiar with the usage of the macros that you have mentioned. Perhaps, you may want to contact the plugin author regarding the problem that you are having via the following link:
Meanwhile, I have found a similar feature request being tracked at the following:
The feature request above is pertaining to have a {space-attachments} macro that lists all the attachments in space within Confluence.
If you are keen on this feature, feel free to case a vote to increase its popularity as well as add yourself as a watcher to get the updates. Also, you may want to add a comment to truly reflect your idea.
Regards,
Choy Li
Feb 01, 2008
Anonymous says:
I wish we could customize the columns. That would make it a whole lot easier Ja...I wish we could customize the columns. That would make it a whole lot easier
Jake
dual action cleanse
Feb 01, 2008
David Peterson [CustomWare] says:
See here for custom attachment display.See here for custom attachment display.
Mar 18, 2008
R Ganz says:
The ...The
Has anyonw else hit this problem?
Mar 18, 2008
Choy Li Tham says:
Hi Ganz, I would suggest you to create a support ticket at the following link a...Hi Ganz,
I would suggest you to create a support ticket at the following link and we will further investigate this issue from there:
Regards,
Choy Li
Mar 22, 2008
CYTEXONE says:
Was this macro changed in the most recent version? in 2.7 it would display...Was this macro changed in the most recent version? in 2.7 it would display an alternating background file listing. It would also keep them displayed quite nicely (as seen above).. In 2.7.3 the formatting is completely gone.
Perhaps something is missing out of the CSS?
Dan
Mar 24, 2008
Ming Giet Chong says:
Hi, It would be appreciated if you can raise this issue at our issue tracker: ...Hi,
It would be appreciated if you can raise this issue at our issue tracker:
Regards,
MG
Jun 04, 2008
Gregory Wexler says:
It would be a nice feature if we could customize the fields that are available f...It would be a nice feature if we could customize the fields that are available for attachments. For example, if I wish to add a field name "Project Manager" to an attachment.
Jun 27, 2008
Christopher Christophorou says:
Hi, is there a way to show the attachments of one page into a different page? ...Hi,
is there a way to show the attachments of one page into a different page?
Thanks,
Chris
Jul 01, 2008
Azwandi Mohd Aris [Atlassian] says:
Hi Chris, There is an ongoing feature request, being tracked at: http://jira...Hi Chris,
There is an ongoing feature request, being tracked at:
Feel free to cast your vote, add your comments or be a watcher to keep yourself updated on the issue.
Cheers,
Azwandi
Jul 08, 2008
R Ganz says:
I know there's an upload option for this, because I've used it, but I now can't ...I know there's an upload option for this, because I've used it, but I now can't find any documentation on it. Can anyone point me to it?
Thanks
Jul 10, 2008
Ming Giet Chong says:
Hi R Ganz, The detailed doc regarding attaching file to a page is available at:...Hi R Ganz,
The detailed doc regarding attaching file to a page is available at:
Hope this helps.
Regards,
MG
Jul 10, 2008
R Ganz says:
Thanks, but that's not what I'm after. I'm currently using the attachments macro...Thanks, but that's not what I'm after. I'm currently using the attachments macro with this syntax
I'm on 2.6.2 and about to upgrade to 2.8.2, but I can't find this option for the macro documented anywhere in either set of documentation, nor do I know how I got it.
Cheers
Dec 24
Anonymous says:
Is this upload attachment from wiki page feature available in 3.1? I think our u...Is this upload attachment from wiki page feature available in 3.1? I think our users would be interested in this feature as well. The extra click to the attachment page is just too much.
Dec 28
Mark Hrynczak [Atlassian] says:
The "Allow Upload" parameter is documented above. Use the macro syntax: {attac...The "Allow Upload" parameter is documented above. Use the macro syntax:
{attachments:upload=true}This is available in 3.1.
Jul 31, 2008
Anonymous says:
Hi everybody 2 questions about the attachment macro: I would like to on...Hi everybody
2 questions about the attachment macro:
At this time my macro is the following: "attachments:patterns=.*pdf|upload=true|sortBy=date|time=1m"
Time parameter doesn't seem to work
Many thanks
Best regards
Pierre
Aug 01, 2008
Tony Cheah Tong Nyee says:
Hi Pierre, You might want to take a look at the available/valid parameters for ...Hi Pierre,
You might want to take a look at the available/valid parameters for this macro here. There seems to have no parameters called "time". Perhaps you would like to share with us on where the parameter "time" comes from? Do you have a documentation that you could share with us regarding it?
Cheers,
Tony
Aug 01, 2008
Frank Erzfeld says:
Nice feature, but I am getting an additional link at the bottom of the page sayi...Nice feature, but I am getting an additional link at the bottom of the page saying "OPEN WEB FOLDER" which will lead to a 404. Any idea what this link is supposed to be for?
Aug 04, 2008
Azwandi Mohd Aris [Atlassian] says:
Hi Frank, The link is supposed to be used in conjunction with WebDAV Plugin. It...Hi Frank,
The link is supposed to be used in conjunction with WebDAV Plugin. It is meant to allow you to open a local directory containing the attachments. However, it is also known that users who do not use this plugin will still be presented with this link. There is a bug report, being tracked at:
Please add your comments or be watcher to keep yourself updated on the issue. Hope this helps.
Cheers,
Azwandi
Aug 13, 2008
Gerin Abraham says:
Hi , I am encountering an issue with attachments whereby when one uses the ...Hi ,
I am encountering an issue with attachments whereby when one uses the
macro on a page it works fine but the same is not so for a template
It gives an error msg:Error formating macro :attachments:java.lang.NullPointerException
Is this a bug ? All the other basic macros like tip, info works fine on templates
Confluence version: 2.4.3
Thanks
Gerin
Aug 19, 2008
Azwandi Mohd Aris [Atlassian] says:
Hi Gerin, To my understanding, the error message is thrown because attachment o...Hi Gerin,
To my understanding, the error message is thrown because attachment objects are not available in the template page. In a normal page, attachment objects are available and accessible by the macro, hence there is no error. However, I have tested this in Confluence 2.9. The error message will not be displayed when you view the template page, but it will appear in the template preview. Hope this helps.
Cheers,
Azwandi
Apr 09, 2009
Tony Goymerac says:
I was looking for a way to reverse the sort order,and the reverse=true parameter...I was looking for a way to reverse the sort order,and the
reverse=true parameter, as used in eg. the blog-posts macro, appears to work.
Is this intended/reliable behavior? If so, you may want to add it to the documentation.
edit to add : on closer inspection, the reverse=true doesn't seem to affect anything, it's just that the default sort order of the sortBy=date parameter apear to be reverse, ie. newest first.
whatever the intended behavior is meant to be, it probably should be documented.
also, the reverse paramater would be a handy thing to have, doesn't seem to be too difficult given it's presence in other macros.
Apr 10, 2009
Zed Yap [Atlassian] says:
Hi Tony, Thanks for the notification. The feature requested is not available y...Hi Tony,
Thanks for the notification.
The feature requested is not available yet. However, there is a a improvement report being raised in JIRA:
Feel free to add your comment, vote for it and add yourself as a watcher for future updates. Also, I have created a task for our technical writer to review this issue.
Hope that helps.
Best rgds,
Zed
Jul 10, 2009
Tony Kosturi says:
Is there a way to display a list of attachments from another page? I tried the ...Is there a way to display a list of attachments from another page?
I tried the attachments macro with the page key but the key was ignored and the attachments of the ''same page" were displayed instead:
I know there is a way to link to an attachment from another page:
The reasoning behind this:
We have a need to group attachments by specific function and there is no way to do it via labels (the way you can with pages). So we created separate pages to group attachments via pages. Now it would be nice to display them all in one place but organized in groups.
We are using version 2.5.7 (I know... very old). Commenting was not available on the documentation of that version.
Any help would be appreciated,
Thanks!
Jul 14, 2009
Jennifer Rushing says:
Hi there, I can't get the "Comment" field to wrap.. Long comments make for a ve...Hi there,
I can't get the "Comment" field to wrap.. Long comments make for a very broken page!!
Any help would be greatly appreciated.. Thanks!
-Jen
Aug 07, 2009
Anonymous says:
Me too. This is very annoying because users are not putting comments on the atta...Me too. This is very annoying because users are not putting comments on the attachments to stop the page getting too wide. Is this issue being looked at?
Aug 17, 2009
Azwandi Mohd Aris [Atlassian] says:
Hi there, I have added a tentative workaround in the following report: http:...Hi there,
I have added a tentative workaround in the following report:
Hope that helps,
Azwandi
Jul 15, 2009
Bret Wilson says:
Ditto -- I'm having the same problem.Ditto -- I'm having the same problem.
Jul 21, 2009
Anonymous says:
this patterns parameter doesn't seem to match the filename. or at least the reg...this patterns parameter doesn't seem to match the filename. or at least the regex engine is not behaving as expected.
if i had a file called "The Quick Brown Fox.doc" you would think "patterns=\bFox\b" or even just "Fox" would match, but it doesn't. what is the trick to matching on the name of a file rather than just a list of extensions?
Aug 12, 2009
Sashidaran Jayaraman [Atlassian] says:
Hi, Based on your description, I have found a similar bug report raised previou...Hi,
Based on your description, I have found a similar bug report raised previously. Here is the bug report raised on this issue:
I would suggest you to add yourself as a watcher for the aforementioned bug report and feel free to comment or address your concerns through it.
Cheers
JSashi
Jul 30, 2009
Anonymous says:
It would be nice to have an option to enable or disable whether the text "There ...It would be nice to have an option to enable or disable whether the text "There are currently no attachments on this page." is shown or not when there are no attachments on a page.
The reason why is that I would like to include the attachments macro at the bottom of the page layout, and it doesn't look very nice when the text is displayed at the bottom of every page.
Aug 04, 2009
Zed Yap [Atlassian] says:
Hi, As far a s I know the feature requested is not available yet. However, I fo...Hi,
As far a s I know the feature requested is not available yet. However, I found this improvement request:
Please add your comments to the discussion, vote on it and add yourself as a watcher for future updates. Also, please bare in mind the following document on how we schedule features for inclusion in our products: Implementation of New Features and Improvements.
Hope that helps.
Best rgds,
Zed
Aug 27, 2009
Anonymous says:
When viewing text attachments, they do not display with any line wrapping and th...When viewing text attachments, they do not display with any line wrapping and thus can give a very wide horizontal scrollbar for the browser. Is there a way to get text attachments to have a width based on the browser width and then line wrap within that width?
-Lynn
Sep 07, 2009
Zed Yap [Atlassian] says:
Hi, I have a mere suggestion, instead of making the table to have the wrap abil...Hi,
I have a mere suggestion, instead of making the table to have the wrap ability and specify the width. You might want to try to make the Attachments macro to have scrollbar if the attachment description is too long. I have created an example shown below. Hopefully you will be able to have better understanding on this. Please follow the steps shown below:
{html} <style> div.test { width:1398px; overflow:auto; } </style> {html} {html} <div class="test" width='100px'> {html} {attachments} {html} </div> {html}Hope that helps,
Best rgds
Zed
Nov 09
Stefan Lenis says:
Hello! Thank you for this explanation. But is there a way not doing this wi...Hello!
Thank you for this explanation. But is there a way not doing this with html, as this macro is deactivated in our organization on purpose...
Thx, BR Stefan
Dec 27
Nikolaus Pohle says:
If you are allowed to change the page layout of the space, you can overwrite the...If you are allowed to change the page layout of the space, you can overwrite the CSS white-space declaration for the attachments table. Just put the following lines before the line <div class="wiki-content">. It doesn't look perfect but it does the job:
<style> table.attachments th {white-space: normal;} table.attachments td {white-space: normal;} </style>As David Peterson pointed out above you can also use the Reporting Plugin to built your own attachments table:
{report-table} {local-reporter:content:attachments} {text-sort:content:title} {local-reporter} {report-column:title=File Name}{report-info:content:title|link=true}{report-column} {report-column:title=Comment}{report-info:content:comment}{report-column} {report-column:title=Size}{report-info:content:nice file size}{report-column} {report-column:title=Version}{report-info:content:attachment version}{report-column} {report-column:title=Modifier}{report-info:content:modifier}{report-column} {report-column:title=Modification}{report-info:content:modification date}{report-column} {report-empty}_No files have been attached to this page._{report-empty} {report-table}This is very flexible and you can also create a shortcut by defining a user macro.
Sep 06, 2009
kaz says:
Someone has asked me if I can use a sort default based on creation date, ra...Someone has asked me if I can use a sort default based on creation date, rather than the last modified date.
Is this possible?
-kaz
Sep 14, 2009
Zed Yap [Atlassian] says:
Hi Kaz, Someone has asked me if I can use a sort default based on creation dat...Hi Kaz,
I am afraid the feature request is not available yet. However, you might want to launch a feature request in JIRA:
Hope that helps.
Best rgds,
Zed
Sep 15, 2009
kaz says:
great thanks Zed, i'll post there. -kazgreat thanks Zed, i'll post there.
-kaz
Sep 15, 2009
kaz says:
Hi all, I am trying to display a couple of lists of page attachments, limi...Hi all,
I am trying to display a couple of lists of page attachments, limited to files with names that contain particular strings. Here is the macro I've tried, with criteria for the file name contents....
Files with "fredjones" in them
(open curly bracket)attachments:patterns=.*fredjones|sortBy=name(closed curly bracket)
Files with "fredsmith" in them
(open curly bracket)attachments:patterns=.*fredsmith|sortBy=name(closed curly bracket)
Unfortunately, this results in the text "No attachments on this page" being displayed, despite there being files with "fredjones" and "fredsmith" in the file names.
Am I correct to assume that the patterns criteria is based on file extension, not file name? If so, what can I use to filter the files by what is in the text of the name, before the extension?
cheers
-Kaz
Sep 15, 2009
Zed Yap [Atlassian] says:
Hi Kazb, I am not sure if I got you correctly. If so, what can I use to filter...Hi Kazb,
I am not sure if I got you correctly.
You want to filter a list of attachment depending on the file name and extension? If yes, you can try this code
{attachments:patterns=<attachment name>.<extension>}NOTE: You might want to change <attachment name> and <extension> to the desire file name and extension.
Yes by using the following syntax:
{attachments:patterns=.*fredsmith|sortBy=name}That pattern which is define is to search for the *.fredsmith extention
Hope that helps,
Best rgds
Zed
Feb 16
kaz says:
Thanks Zed, when you first posted this, I thought it worked... but today again I...Thanks Zed, when you first posted this, I thought it worked... but today again I am trying to apply a filter so that my attachments only include files with the word "agenda" in them... and ".*agenda" just simply doesn't work.
Like Anonymous below, I still need an answer here!
This has nothing to do with the file extension... just the contents of the file name.
-Kaz
Feb 09
Anonymous says:
Is there a way to filter the list using the filename? Not the file extension? F...Is there a way to filter the list using the filename? Not the file extension?
For example, if I want only files (attached to the page) that start with the letter A, using the following syntax doesn't work.
{attachments:patterns=.*A |sortBy=Name}Thanks!
Feb 17
Zed Yap [Atlassian] says:
Hi all, Is there a way to filter the list using the filename? Not the file ext...Hi all,
Yes, I believe you can archive your requirement. I have created a macro below to only filter the attachment which starts with the letter a:
{attachments:patterns=a.*|sortBy=name}Please give the above macro a try.
Hope that helps.
Best rgds,
Zed
Dec 21
Francis vila says:
Can I specify that I want the attachments of a specific page? This would allow...Can I specify that I want the attachments of a specific page?
This would allow me to create a number of different pages with a dozen attachments each, then have a master page with expand macros on titles that open the table of attachments of a given page when the user clicks on them. Something like this:
Table of attachments appears here
Francis
Jan 12
Azwandi Mohd Aris [Atlassian] says:
There is no macro parameter to cater for this requirement. However, you can incl...There is no macro parameter to cater for this requirement. However, you can include or excerpt-include page A and page B. For instance, in page A and page B:
Some contents ... {excerpt} {attachments} {excerpt}In the main page:
{excerpt-include:page A} {excerpt-include:page B}Hope this helps!
Jan 27
David Hergert says:
I think it would be *really* helpful if this macro allowed for a simple ...I think it would be *really* helpful if this macro allowed for a simple listing, like allowing you to somehow specify that you just want the filename to show. Maybe add an attribute "columns=filename,size,etc" or a "simple=true".
Jan 27
Jack Low [Atlassian] says:
Hi David, I agree with you that would be a nice feature. As far as I understand,...Hi David,
I agree with you that would be a nice feature. As far as I understand, this feature is not available yet. Please feel free to make a feature request under Confluence project at http://jira.atlassian.com. jira.atlassian.com is where our programmers keep track of the bugs, task, feature & improvement request, etc. Please share your comment by creating a new issue, vote on it, and add yourself as a watcher for future update.
Thanks & regards,
Jack
Feb 01
Anonymous says:
Is there a way which attachments can be rated in a similar way to the Rate macro...Is there a way which attachments can be rated in a similar way to the Rate macro ?
Feb 04
Zed Yap [Atlassian] says:
Hi, As far as I know, the feature requested is not available for the Attacment ...Hi,
As far as I know, the feature requested is not available for the Attacment macro. You might want to create a feature request in JIRA:
Hope that helps.
Best rgds,
Zed
Feb 03
Anonymous says:
Why is the name column of the attachments macro so small, and the comment column...Why is the name column of the attachments macro so small, and the comment column soo big?
Where can this be modified? It doesn't seem to work with changing the css.
Thanks!
Feb 03
Jordi Wauters says:
I have that problem too...I have that problem too...
Feb 17
Sabine Schalch says:
I have a problem with the column headings of the attachments macro. For example ...I have a problem with the column headings of the attachments macro. For example instead of "name" it shows this "/display/testDemonstration+Office+Anbingung?sortBy=name" as a link.
Does anyone know how I coud fix this?
Thanks!
Feb 17
Sashidaran Jayaraman [Atlassian] says:
Hi Sabine, I would highly suggest you to raise a support ticket to https://supp...Hi Sabine,
I would highly suggest you to raise a support ticket to https://support.atlassian.com for this problem so that the issue can be further investigated. Also provide the following:.
Cheers
JSashi
Mar 09
Rudy Bake says:
I get the same thing. /display/2009VBRC/1.+Royal+Commission+introduction+...I get the same thing.
/display/2009VBRC/1.+Royal+Commission+introduction+and+overview+documents?sortBy=name
Not pretty.
Did you get a solution?
Thank you.
Rudy Bake
Mar 11
Sabine Schalch says:
I didn't get a sulution, but somehow the problem is gone. I think a restart did ...I didn't get a sulution, but somehow the problem is gone. I think a restart did it, but I don't know for sure because I was working on a different issue when I noticed that everything was fine again.
Mar 10
Jordi Wauters says:
I had this in Confluence 3.1 After a re-index and restart, it was gone. Now upg...I had this in Confluence 3.1
After a re-index and restart, it was gone. Now upgraded to 3.1.2 and I don't have the problem anymore.
However, I am still looking for an easy way to adjust the column sizes....
The comment column is so big, while the name is too small. Anyone has suggestions?
yesterday at 11:51:01
Anonymous says:
regular expressions don't seem to work in attachment macro. the pipe for o...regular expressions don't seem to work in attachment macro. the pipe for or and the parenthesies for groupings are both part of macro syntax and throw an error when you attempt to put them in regular expression, even if you escape them. Is there documentation anywhere on regular expressions as modified for use in the attachments macro attribute for confluence?
Add Comment