FootNotePlugin

Footnotes are notes placed at the end of a topic.

Syntax Rules

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

Examples

  • 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(1) invented the World Wide Web.

Plugin Settings

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)
    • Set DEBUG = 0

  • Heading
    • Set HEADER = Notes
    • Set FOOTER = ---

Plugin Installation Instructions

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:
    • See example above.

Plugin Info

Plugin Author: TWiki:Main.IanBygrave
Copyright: © 2006, TWiki:Main.IanBygrave
License: GPL (GNU General Public License)
Plugin Version: 31 Aug 2008 (V2.008)
Change History:  
31 Aug 2008: Label formats are a single character, so don't interpret footnotes like {{http://www.perlmonks.org/}} as asking for the non-existant label format http.
Implement hex label formats.
24 Aug 2008: Configurable label numbering formats.
4 May 2008: CSS
29 Apr 2008: Fix quoting of text in title attributes of footnote links. Fixes a bug found by TWiki:Main.MaxPar.
27 Apr 2008: Fix conflict with TWiki:Plugins.LatexModePlugin reported by TWiki:Main.TonyLiu.
25 Apr 2008: Put footnote link in parens.
25 Apr 2008: Show footnotes in tooltips.
6 Feb 2008: Render notes in page order on pages using lots of %INCLUDE%
24 May 2007: Replace compatibility with pre-dakar.
Seperately number identical footnotes.
Sort footnotes.
30 Apr 2007: Better way of getting footnotes at the end of the page.
10 Jan 2007: Repair old %FOOTNOTE{...}% markup.
05 Jan 2007: Reset notes at plugin initialisation. Fixes a bug found by TWiki:Main.StefanieWrobel.
05 Dec 2006: Allow line breaks in footnotes. New %STARTFOOTNOTE{}% %ENDFOOTNOTE% markup.
05 Dec 2006: Renamed to FootNotePlugin
05 Jun 2006: Initial version was called EndNotePlugin
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: Roman optional
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle 99%, FormattedSearch 99%, FootNotePlugin 98%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/FootNotePlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/FootNotePluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/FootNotePluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- IanBygrave - 05 Dec 2006

Notes

1 : Tim Berners-Lee is now director of the World Wide Web Consortium, and Professor of Computer Science at Southampton ECS.


Topic attachments
I Attachment Action Size Date Who Comment
Compressed Zip archivezip FootNotePlugin.zip manage 12.7 K 2008-08-24 - 06:54 UnknownUser  
Cascading Style Sheet filecss styles.css manage 0.1 K 2008-08-24 - 10:28 UnknownUser  
r15 - 31 Aug 2008 - 20:52:13 - IanBygrave
 
Linux & Open Source related information for AT91 Smart ARM Microcontrollers

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.

Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.

Atmel® and others, are registered trademarks or trademarks of Atmel Corporation or its subsidiaries. This site is powered by the TWiki collaboration platform

ARM® and others are registered trademarks or trademarks of ARM Ltd. Other terms and product names may be trademarks of others.

Ideas, requests, contributions ? Connect to LinksToCommunities page.

Syndicate this siteRSS ATOM