Footnote Macros

Last modified by Admin on 2024/10/10 01:18

cogAdds notes of text placed (by default) at the bottom of the page
TypeJAR
CategoryMacro
Developed by

XWiki Development Team

Active Installs2
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Installable with the Extension Manager

Description

There are 2 macros that work together:

Footnote Macro

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.

If no PutFootnotes macro is used explicitly then one is added automatically at the end of 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

PutFootnotes Macro

When called, it displays the footnotes declared in the whole page content, at the current position. Nothing is displayed if no footnotes exist in the document.

Only a single PutFootnotes macro is supported per page, and only the last usage of this macro displays the footnotes.

Usage

{{putFootnotes/}}

Parameters definition

None

Example

= A title =

Lorem ipsum dolor sit amet{{footnote}}Footnote 1{{/footnote}}, consectetuer
adipiscing elit. Vivamus lacus est, euismod at, lobortis eu, rhoncus
et, leo{{footnote}}Footnote 2{{/footnote}}.

{{putFootnotes/}}

**P.S.:** Morbi eget leo. Praesent tempor erat nec sapien. Etiam tincidunt,
tellus et faucibus sagittis, diam diam tincidunt magna, id
fringilla metus libero nec dolor.

Result

putfootnotes.png

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

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 16.8.0):

Get Connected