wiki:FootNoteMacro

Version 14 (modified by rjollos, 5 years ago) (diff)

Add maintainer

FootNote macro for wiki markup

Description

The FootNoteMacro automatically collates1 and generates footnotes.

To use it, simply call the FootNoteMacro with the footnote content2 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:footnotemacro

Installation

FootNote.py must be installed in the global wikimacros directory due to its use of global variables. This is discussed at length in #13.

Source

You can check out the source for FootNoteMacro from Subversion at http://trac-hacks.org/svn/footnotemacro, or browse the source..

Example

Here are the footnotes assembled from this page.


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

Recent Changes

[14088] by rjollos on 2014-08-14 20:47:15
1.04: PEP-0008 changes and moved COPYING file to proper location.
[13654] by rjollos on 2014-02-11 04:50:30
1.0.4: Attach footnotes to the context to avoid scoping issues when formatting the page. Fixes #9211.
[13552] by rjollos on 2014-01-08 03:31:36
Added unit test harness. Refs #9211.

Author/Contributors

Author: athomas
Maintainer: coderanger
Contributors:

TagIt(macro,athomas,0.8,0.9,0.11)?