EndNotePlugin

Endnotes are notes placed at the end of a topic. They are just like footnotes.

Syntax Rules

Write the command %ENDNOTE{ note text }% anywhere in a TWiki topic. This will be replaced with a link to the note at the end of the topic. The endnote has a link back to the text where it was inserted.

Do not embed endnotes in headings. That will break the heading in the %TOC%. Endnotes at the end of headings seem to work.

Examples

• You type:
  • Tim Berners-Lee%ENDNOTE{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¹ 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%ENDNOTE{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.

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 Text Formatting Rules topic:
  • Set SHORTDESCRIPTION = End notes are notes about the text of a topic, which are listed at the end of the page.

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

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 EndNotePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/EndNotePlugin.txt	Plugin topic
  data/TWiki/EndNotePlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/EndNotePlugin.pm	Plugin Perl module

• 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

Related Topics: T Wiki Plugins, Developer Documentation Category, Admin Documentation Category, T Wiki Preferences

-- TWiki:Main.IanBygrave - 05 Jun 2006