Skip to end of metadata
Go to start of metadata

Overview:

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.

Parameters:

 

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}

You can also use macros to define a footnote anywhere within your content and to display a list of footnotes, usually at the bottom of a section or page.

 

 

Examples:

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  1 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:

  1. This is a footnote

When you click the footnote marker, the corresponding footnote will be highlighted in the display further 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 link to your footnote:

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

Which results in:

Here we have another footnote 2  

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 3 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:

  1. This footnote contains a link to our homepage
  2. 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.

Cross Reference Footnotes

  • You can insert the same footnote in the text multiple times without creating a duplicate Footnote, and the original footnote will be referenced at multiple locations in the page.
                


  • You can insert more than one footnote for a particular text
               

Hints and Tips:

When reading footnotes, you can mouse-over the icon to the side of them to highlight them and put a box round them.

When you define a footnote 4 , check the page after saving to ensure that it's being displayed.

It's generally a good idea to include the {footnotes} macro at the bottom of any page that defines footnotes - should content be moved around at a later date, the list at the end of the page will display any stray footnotes.

You can use footnotes to display references to publications, etc. Simply format the content of the footnote to get the desired effect (eg. using italic text and bold text to highlight author, publication name, etc).

If footnotes are displayed quite far away from their markers, try to include additional information so the reader can work out what they relate to without reading the content around the marker. For example, which of these makes the most sense:

Bad

This doesn't work in Internet Explorer unless you are using our theme.

Good

Internet Explorer (versions 5 and 6) doesn't properly support transparency in PNG images. You can fix this problem by using our Builder theme.

If you include an image in your footnote, the layout can sometimes look a bit messy. For example:

This footnote contains an image

As you can see, the text is centred against the image and in Example 4 it makes the footnotes look messy.

To get around this problem, set the image alignment as follows:

This footnote contains an image !cubes.png|align=top!

Resulting in:

This footnote contains an image

  • No labels