The {version-history} macro allows you to display a table detailing the changes that have been made to the page...

Although this information is already available elsewhere, it is often useful to display it on the page itself. The macro is ideal for formal documentation as it allows you to quickly add a self-updating version history of the page that will be present in printouts. Furthermore, the table displays edit comments alognside each version.

Add the macro to your page as follows:

{version-history:page=Home|dateFormat:ddMMYY HHmm|reverse=true|first=5}

Parameters

Parameter	Required	Notes
page		The name of the page whose version history you wish to display, if none is given then the current page is assumed. (@self and @parent are also valid)
dateFormat		Allows you to override the format used to display dates. Details of the pattern syntax may be found Date Formats. If omitted, the date format defined in Confluence General Configuration will be used.
reverse		Whether to reverse the list (sorted in revision order)
first		Only display the first x entries

This plug-in is available without cost for both commercial and non-commercial purposes. However, if you have found it to be useful, particularly within a commercial environment, please consider making a donation to the author. This will encourage continued development of this and other plug-ins, as well as speeding up the response for your latest maintenance request.

If you wish to donate, it can be done easily with a credit card or bank transfer using PayPal. No account sign-up is required for credit or debit card payments.

This software is released under a BSD License

© 2005 Adaptavist.com Limited

This macro has been tested by Adaptavist with Confluence 2.1.2

It is usually pre-installed when using our Host service. To install it on your own Confluence installation, please see Footnotes Plugin

Adaptavist maintain a JIRA Project for tracking bug reports and feature requests for this macro. The currently reported items are shown below:

• page-info macro
• [USERGUIDE:change-history macro]

Displaying the current page's history

{version-history}

Which produces a table displaying version information about the current page:

Version	Date	Author	Comment
19	May 11, 2009 22:42	Alain Moran
18	Apr 26, 2009 18:39	Guy Fraser
17	Jul 21, 2008 19:10	Guy Fraser
16	Jul 21, 2008 19:08	Guy Fraser
15	Jul 21, 2008 19:06	Guy Fraser
14	Jan 10, 2007 17:47	Alain Moran
13	Jun 15, 2006 02:15	Guy Fraser	fixed issue tracker url
12	Mar 29, 2006 10:37	Guy Fraser	adding link to change-history macro (not yet documented)
11	Mar 29, 2006 10:33	Guy Fraser	Fixing links to date formats tutorial
10	Mar 24, 2006 00:03	Guy Fraser
9	Mar 23, 2006 18:30	Alain Moran
8	Mar 23, 2006 14:54	Alain Moran
7	Mar 23, 2006 14:54	Alain Moran
6	Mar 23, 2006 14:46	Alain Moran	Date formatting
5	Mar 23, 2006 14:42	Alain Moran
4	Mar 23, 2006 14:32	Alain Moran	Displaying the version data for a different page
3	Mar 23, 2006 14:27	Alain Moran	Reversing the order of items displayed
2	Mar 23, 2006 14:24	Alain Moran	Limiting the number of items displayed
1	Mar 23, 2006 14:21	Alain Moran

Limiting the number of items displayed

On pages that are frequently edited there may be far too many entries in the version history to conveniently display all of them, you can limit the number of entries displayed using the first parameter

{version-history:first=3}

Which produces a table containing limited to displaying three entries

Version	Date	Author	Comment
19	May 11, 2009 22:42	Alain Moran
18	Apr 26, 2009 18:39	Guy Fraser
17	Jul 21, 2008 19:10	Guy Fraser

Reversing the order of items displayed

By default the versions listed are sorted into oldest to newest version (first revision to most recent revision), often you may wish to reverse this order, especially when using the first parameter since this can give you a list of the most recent changes to a page

{version-history:first=3|reverse=true}

Which displays a table containing the three most recent modifications to their page.

Version	Date	Author	Comment
1	Mar 23, 2006 14:21	Alain Moran
2	Mar 23, 2006 14:24	Alain Moran	Limiting the number of items displayed
3	Mar 23, 2006 14:27	Alain Moran	Reversing the order of items displayed

Displaying the version data for a different page

At times it may be useful to display the version history for a different page

{version-history:page=Home|first=3|reverse=true}

The following table details the three most recent revisions made to the Home page in this space

Version	Date	Author	Comment
1	Jul 21, 2008 18:31	Guy Fraser
2	Jul 22, 2008 05:16	Guy Fraser
3	Aug 11, 2008 22:12	Guy Fraser

Setting the date format

You may also wish to set the format that the date appears in, this can be done using the format parameter. Details of the syntax for the format definition can be found Date Formats.

{version-history:first=3|dateFormat=dd MMMM yyyy, hh.mm aa}

As can be seen below:

Version	Date	Author	Comment
19	11 May 2009, 10.42 PM	Alain Moran
18	26 April 2009, 06.39 PM	Guy Fraser
17	21 July 2008, 07.10 PM	Guy Fraser