Footnote Macro

Last modified by Admin on 2017/10/05 15:43

cogAdds a note of text placed (by default) at the bottom of the page
TypeJAR
Developed by

XWiki Development Team

Active Installs0
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise, XWiki Enterprise Manager

Installable with the Extension Manager

Description

The footnote is flagged by a superscript number following that portion of the text the note is in reference to. The superscript number is actually a link to the place (in the page) where that footnote is displayed. When the link is clicked, the target footnote is highlighted. The footnote text in the footnote area is preceded by a back-link, to the place in the text where that footnote is referred.

The {{footnote}} macro can be used with the {{putFootnotes}}, which allows placing the footnote area elsewhere in the page.

Usage

{{footnote}}text{{/footnote}}

Parameters definition

text is the text that will be displayed in the footnote.

Example

Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Vivamus lacus est, euismod at, lobortis eu, rhoncus et,
leo{{footnote}}This is some text from www.lipsum.com{{/footnote}}.

Morbi eget leo. Praesent tempor erat nec sapien. Etiam tincidunt,
tellus et faucibus sagittis, diam diam tincidunt magna, id
fringilla metus libero nec dolor. Curabitur vestibulum
fringilla felis{{footnote}}More dummy text{{/footnote}}. Sed auctor.

Sed scelerisque. Proin sed ipsum. Class aptent taciti sociosqu ad
litora torquent per conubia nostra, per inceptos hymenaeos. Nulla
vestibulum, neque sed sodales laoreet, augue ante varius pede,
quis feugiat quam nisl varius orci. Maecenas ultricies pede vitae
turpis.

Result

The code above results in:

footnote1.png

When the superscript number link is clicked, the corresponding footnote is highlighted:

footnote2.png

When the link that leads back to the reference of a footnote is clicked, the corresponding footnote marker is highlighted:

footnote3.png

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
6.1XWiki Enterprise 6.1

Compatibility with earlier versions: XWiki Platform 2.0M2 and above and 1.9.3 and above

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Dependencies

Dependencies for this extension (org.xwiki.rendering:xwiki-rendering-macro-footnotes 9.8.1):

Tags:
Created by Sergiu Dumitriu on 2009/07/26 17:01
    

Get Connected