wiki:FootNoteMacro

Version 27 (modified by rjollos, 12 months ago) (diff)

Point to ticket in the Trac core.

Add footnotes to wiki

Description

The FootNoteMacro automatically collates1 and generates footnotes.

Note: There is an open ticket for integrating this feature to the Trac core, t:#9037.

Example

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 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)]].

[[FootNote]]

Now that I've called the !FootNoteMacro to print all the footnotes
[[FootNote(I did that in the paragraph above)]], I should be able to
generate more
footnotes[[FootNote(It would be really cool if this feature was integrated into the Trac core)]]
and print just the one that have been generated since the start of the second paragraph.
Just for good measure I'll try referring to some footnotes in the first paragraph
again[[FootNote(1)]][[FootNote(Here is the second footnote)]].

[[FootNote]]

Screen capture of the output that is produced:

Recent Changes

[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.
[13269] by rjollos on 2013-06-07 02:20:07
Fixed incorrect URL in setup.py.

Author/Contributors

Authors: athomas, coderanger
Maintainer: rjollos
Contributors: JoshuaH

Attachments (1)

Download all attachments as: .zip