The {footnote} and {display-footnotes} macros allow you to easily create footnotes in your content...

Define footnotes within your content using the {footnote} macro. A marker will be shown to indicate where there are footnotes and clicking on this icon will take you to the displayed footnote further down the page.

Use the {display-footnotes} to output all currently unlisted footnotes from the content above. Each footnote is listed alongside it's corresponding numbered marker and you can click that marker to return to your previous position in the content above.

The macros have been designed with maximum usability and accessibility in mind. They do not require JavaScript, although they will be more interactive if it is enabled. The footnotes are designed to be easily recognisable in print, email and page exports (Word and PDF), as well as being easy to create and use when viewed in a web browser.

To define a footnote anywhere within your content, use the following notation:

{footnote}this is a footnote{footnote}

And to display a list of footnotes, usually at the bottom of a section or page, use the following notation:

{display-footnotes}

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:

• Download and Installation Instructions

Basic Use

To create a marker for a simple text-only footnote use the following format:

Here we have some text{footnote}This is a footnote{footnote} which contains a footnote.

Which results in:

Here we have some text ¹ which contains a footnote.

To display footnotes, use the following notation below the point where you defined the footnote marker:

{display-footnotes}

Which results in:

Footnotes

Reference	Notes
1	This is a footnote

When you click the footnote marker, the corresponding footnote will be highlighted in the display futher down the page. To return to the content above, click the marker within the footnote display.

Links in Footnotes

There are times when you may want a footnote to refer to another web page, to do this simply add a [USERGUIDE:link] to your footnote:

Here we have anothe footnote{footnote}This footnote contains a [link to our homepage|http://www.adaptavist.com]{footnote}

Which results in:

Here we have anothe footnote ²

Note: Be wary of displaying the list of footnotes within a tabbed panel as we are doing here - the tab that displays the footnotes (in this case "Example 4") will not automatically be selected.

Images in Footnotes

As you've probably guessed by now, you can use any Wiki Markup Editor in footnotes, including images:

Another footnote appears{footnote}This footnote contains an image !cubes.png!{footnote}

Which results in:

Yet another footnote ³

Warning: Images sometimes don't display properly if you export the page as Word or PDF format, and they sometimes don't work when the page is emailed (eg. when watching a page).

Multiple Footnote Lists

Normally, you'll just want to list the footnotes at the end of a document (similar to what we showed in Example 1), however you can display more than one list of footnotes if desired:

{display-footnotes}

Which results in:

Footnotes

Reference	Notes
2	This footnote contains a link to our homepage
3	This footnote contains an image

As you can see, each time you use the {display-footnotes} macro it lists out all the footnotes that haven't already been listed. This is ideal for creating section-level footnotes, etc.