Access Keys:
Skip to content (Access Key - 0)

Adaptavist Documentation Move

This documentation is deprecated. Adaptavist's documentation has moved to a new location where it is maintained and updated. Please visit Adaptavist's new Documentation area.

footnote macro

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}

Examples:

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 footnote4 , 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 centered 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

See Also:



View old comments


Adaptavist Theme Builder Powered by Atlassian Confluence