Add footnotes to wiki

Description

The FootNoteMacro automatically collates¹ and generates footnotes.

To use it, simply call the FootNoteMacro with the footnote content² as the only argument to the macro:

[[FootNote(This is a footnote)]]

Footnotes are numbered by the order in which they appear.

To create a reference to an existing footnote, pass the footnote number as the only argument to the macro:

[[FootNote(1)]]

In addition, identical footnotes are coalesced into one entry. The following will generate one footnote entry with two references:

Some text[[FootNote(A footnote)]] and some more text [[FootNote(A footnote)]].

[[FootNote]]

And finally, to display a list of foot-notes call the macro with no arguments:

[[FootNote]]

Once a set of footnotes has been displayed, a complete new set of footnotes can be created. This allows multiple sets of footnotes per page.

Bugs/Feature Requests

Existing bugs and feature requests for FootNoteMacro are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out FootNoteMacro from here using Subversion, or browse the source with Trac.

Example

Here are the footnotes assembled from this page.

---

1. 1. Arranges in numerical order
2. 2. Any WikiFormatting can be used as content

---

Here is some wiki markup that will exercise all the functionality of the macro.

Testing out the !FootNoteMacro[[FootNote(Here is the first footnote.)]]. 
This will be a good test to exercise all of its functionality
[[FootNote(Here is the second footnote)]]. And now I'll add an identical
footnote and refer to the first footnote again.
[[FootNote(Here is the second footnote)]][[FootNote(1)]].

Now I've test all of the documented behavior.

[[FootNote]]

Recent Changes

[7527] by rjollos on 02/09/10 08:42:03

Change name in setup.py and bump revision.

[7501] by rjollos on 02/04/10 03:48:47

Applied patch from JoshuaH to fix issue with identical footnotes not bing coalesced into one entry. Fixed #5616.

[7500] by rjollos on 02/04/10 03:41:03

The 0.11 branch has been tested and confirmed to work on Trac 0.12dev-r9098. Incrementing version to 1.01. Fixes #6536

[7499] by rjollos on 02/04/10 03:30:41

Add htdocs/*.js to package_data in setup.py. Thanks for the fix anonymous. Fixes #5525.

Author/Contributors

Authors: athomas, coderanger
Maintainer: rjollos
Contributors: JoshuaH