FootNotePlugin
Footnotes are notes placed at the end of a topic.
Write
{{ note text }} anywhere in a TWiki topic.
This will be replaced with a link to the note at the end of the topic.
The footnote has a link back to the text where it was inserted.
Write
{{f: note text }} to use label format
f instead
of the default numerical footnote labeling.
Available formats are:
-
1 : Arabic numerals
-
A , a : Upper- or Lower-case letters
-
I , i : Upper- or Lower-case roman numerals
-
X , x : Upper- or Lower-case hexadecimal numbers.
Write
{{l:: note text }} to use the label
l
instead of automatic numbering.
Valid labels may be any length and contain alphanumeric characters,
but must not include spaces.
%FOOTNOTELIST% will be replaced by the notes so far on the page.
%FOOTNOTE{LIST="Web.Topic"}% will be replaced by the notes from an
%INCLUDE% ed page.
%STARTFOOTNOTE{LABEL="l" LABELFORMAT="f"}% note text %ENDFOOTNOTE% may also be used instead of
{{ note text }}
Do not embed footnotes in headings. That will break the heading in the
%TOC%.
- You type:
-
Tim Berners-Lee{{Tim Berners-Lee is now director of the World Wide Web Consortium, and Professor of Computer Science at Southampton ECS.}} invented the World Wide Web.
- If the plugin is installed you get:
- Tim Berners-Lee(1) invented the World Wide Web.
- And this at the end of the page:
- 1: Tim Berners-Lee is now director of the World Wide Web Consortium, and Professor of Computer Science at Southampton ECS.
- Actual example, it renders properly if the Plugin is installed and enabled:
- Tim Berners-Lee invented the World Wide Web.
Plugin settings are stored as preferences variables. To reference a plugin setting write
%<plugin>_<setting>%, i.e.
%NEWPLUGIN_SHORTDESCRIPTION%
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Footnotes are notes placed at the end of a topic.
- Default label numbering format - sitewide (here), per web (in WebPreferences) or per topic.
- Set FOOTNOTELABELFORMAT = 1
- Debug plugin: (See output in
data/debug.txt)
- Heading
- Set HEADER = Notes
- Set FOOTER = ---
- Full URL of the CSS to use to format footnotes.
Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.
- Download the ZIP file from the Plugin web (see below)
- Unzip
FootNotePlugin.zip in your twiki installation directory. Content:
|
|
| File: |
Description: |
data/TWiki/FootNotePlugin.txt |
Plugin topic |
data/TWiki/FootNotePlugin.txt,v |
Plugin topic repository |
lib/TWiki/Plugins/FootNotePlugin.pm |
Plugin Perl module |
lib/TWiki/Plugins/FootNotePlugin/Note.pm |
lib/TWiki/Plugins/FootNotePlugin/LabelFormat.pm |
pub/TWiki/FootNotePlugin/styles.css |
CSS |
|
|
|
- Configure the Plugin:
- TWiki 4.0 and up: Run the configure script to enable the Plugin
- Change the Plugin settings as needed
- Test if the installation was successful:
Related Topics: TWikiPlugins,
DeveloperDocumentationCategory,
AdminDocumentationCategory,
TWikiPreferences
--
IanBygrave - 05 Dec 2006
Notes
:
