This page last changed on Aug 26, 2009 by ggaskell.
The Recently Updated macro displays a list of the most recently changed content within Confluence.
The Recently Updated Dashboard macro is similar to this macro, but is intended for display on the Confluence dashboard.
On this page:
Usage with the Macro Browser
To insert the recently updated macro into a page using the Macro Browser,
- Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
- Next, click the Macro Browser icon
on the editor toolbar. The Macro Browser will open in the middle of the screen.
- In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.
Once you've found the recently updated macro and have added the required parameter values, click ' insert' to add it to your page.
Usage with the Wiki Markup Editor
Working Example of Usage
Below is a working example of the 'Recently Updated' macro which by default, lists 15 results.
What you need to type |
What you will get |
{recently-updated} |
Recently Updated
|
Parameters
Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.
Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).
Parameter |
Required? |
Default |
Description |
Author(s) by username
(author) |
no |
None specified i.e. display all content |
Filter the results by author. The macro will display only the pages etc which were last modified by the author(s) you specify here.
You can specify one or more authors, separated by a comma or a space.
|
Label(s)
(label) or (labels) |
no |
None specified i.e. display all content |
Filter the results by label. The macro will display only the pages etc which are tagged with the label(s) you specify here.
You can specify one or more label values, separated by a comma or a space.
- To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
- To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'.
If there are no pages matching any of the specified labels, then Confluence will ignore the labels and will list all recently updated pages, as well as showing a message, "These labels don't exist and were ignored: xxx ". This unexpected behaviour is noted in issue CONF-10167. |
Maximum Number of Results
(max) or (maxResults) |
no |
15 |
Specify the maximum number of results to be displayed. Note that the results are sorted first, and then the maximum parameter is applied. If this parameter is omitted, then a maximum of 15 results are displayed. The theoretical maximum value that this parameter can accept is 2 to the power of 31, minus 1 (or 2147483647). |
Reverse Sort
(reverse) |
no |
false |
Use this parameter in conjunction with the sort parameter described below. Set reverse=true to change the sort from ascending to descending order.
This parameter is ignored if the sort parameter is not specified. |
Show User Profile Pictures
(showProfilePic) |
no |
false |
Specify showProfilePic=true to display the profile pictures of the users who updated the content. |
Sort By
(sort) |
no |
modified |
Specify how the results should be sorted. To change the sort order from ascending to descending, use the reverse parameter described above.
If this parameter is not specified, the sort order defaults to descending order based on the last modification date.
Values:
- creation — Sort by the date on which the content was added.
- title — Sort alphabetically by title.
- modified — Sort by the date on which the content was last updated.
|
Space(s)
(space) or (spaces) |
no |
@self, i.e. the space which contains the page on which the macro is used |
This parameter allows you to filter content by space. The macro will display only the pages etc which belong to the space(s) you specify here.
You can specify one or more space keys, separated by a comma or a space.
- To exclude content in a specific space, put a minus sign (-) immediately in front of that space key. For example: If you specify a space key of -BADSPACE you will get only content which is not in the BADSPACE.
- To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.)
Special values:
- @self — The current space.
- @personal — All personal spaces.
- @global — All global spaces.
- @favorite — The spaces you have marked as favourite.
- @favourite — The same as @favorite above.
- @all — All spaces in your Confluence site.
- * — The same as @all above.
When specifying a personal space, remember to use the tilde (~) sign in front of the username, such as ~jbloggs or ~jbloggs@example.com. |
Include these Content Types Only
(type) or (types) |
no |
all types |
This parameter allows you to filter content by content type. The macro will display only the content of the type you specify here.
You can specify one or more types, separated by a comma or a space.
To exclude content of a given content type, put a minus sign (-) immediately in front of that content type. For example: If you specify a content type of -blogpost you will get pages and all other content except for blog posts.
Available values:
|
Width of Table
(width) |
no |
100% |
Specify the width of the macro display, as a percentage of the window width. |
theme
(theme) |
no |
'concise' with the heading 'Recently Updated' |
Choose the appearance of this macro:
- concise — the default list, showing the names of pages which were updated or commented on, the users who made the page modifications and time when the modifications occurred.
- social — lists recent modifications in reverse chronological order, but groups them by user into short time segments. A 'sub' list appears within each user's time segment, showing the names of pages which they updated or commented on and time when these modifications occurred.
- sidebar — lists recent updates in reverse chronological order, showing the names of pages which were updated or commented on and time when the page modifications occurred. This theme does not show authorship.
|
Examples
1. Include content from all spaces
The code below will show all the pages from all the spaces that have been recently updated:
{recently-updated:space=@all}
2. Include content from specific spaces
Use the code below to specify the spaces for which you want to view recently updated content:
{recently-updated:space=SPACEKEY1,SPACEKEY2}
3. Specify the width of the display
Use the code below to limit the width of the display to 50% of the window:
{recently-updated:width=50%}
4. Filter content using labels
The code below will include recently updated content labelled with 'timesheets' or 'summaries', from the 'sales' and 'marketing' spaces, provided that the content is not labelled with 'obsolete':
{recently-updated:space=sales,marketing|label=timesheets,summaries,-obsolete}
5. Sort the results
Use the code below to sort the list of items by date last modified, with the most recent at the top:
{recently-updated:sort=modified|reverse=true}
6. Filter by content type
Use the code below to show pages only (not news items, comments or any other content type) and sort the list of items by date last modified, with the most recent at the top:
{recently-updated:sort=modified|reverse=true|type=page}
7. Change the number of results in the list
The code below changes the number of results listed (from the default value of 15) to 8:
{recently-updated:maxResults=8}
8. Display profile pictures
The code below will display the profile picture of the user who most recently updated the content.
{recently-updated-dashboard:showProfilePic=true}
9. Display recent comments, including profile pictures and text
The code below will display recent comments in the current space, showing the profile picture of the users who made the comments, plus the first line or two of the comment text.
This is the only way to ensure that the text of the comments is displayed, using this macro.
{recently-updated-dashboard:types=comment|showProfilePic=true}
RELATED TOPICS
Recently Updated Dashboard Macro
Viewing Recently Updated Content
Working with Macros
Take me back to the Confluence User Guide.
|