wiki:FootNoteMacro

Version 21 (modified by Ryan J Ollos, 14 years ago) (diff)

Adding an example for a user to test all of the macro functionality.

Add footnotes to wiki

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 the zipped source from [download:footnotemacro 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 th:FootNoteMacro [[FootNote(Here is the first
footnote)]]. This will be a good test to excercise 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]]

No image "FootNoteMacroExample.png" attached to FootNoteMacro

Recent Changes

18152 by Cinc-th on 2021-04-04 18:59:18
FootNoteMacro: minor Python 3 fix. Bumped version to 1.6.1. Added more classifiers to setup.py.

Testing indicates that the plugin works with Trac 1.5/Trac 1.6.

16604 by rjollos on 2017-05-22 04:08:35
TracFootNoteMacro 1.6: Change package name
16395 by rjollos on 2017-03-25 09:25:02
Remove obsolete "0.8" directories
(more)

Author/Contributors

Authors: athomas, coderanger
Maintainer: rjollos
Contributors: JoshuaH