Tags:
create new tag
, view all tags
ALERT! NOTE: This plugin topic is obsolete, the plugin has been renamed to FootNotePlugin

EndNotePlugin

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

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 endnote has a link back to the text where it was inserted.

%ENDNOTELIST% will be replaced by the notes so far on the page.

%ENDNOTE{LIST="Web.Topic"}% will be replaced by the notes from an %INCLUDE% ed page.

Do not embed endnotes 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-Lee1 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{{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 TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Endnotes are notes placed at the end of a topic. They are just like footnotes.

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

  • Heading
    • Set HEADING = Notes

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
    lib/TWiki/Plugins/EndNotePlugin/Note.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

Plugin Author: TWiki:Main.IanBygrave
Copyright: © 2006, TWiki:Main.IanBygrave
License: GPL (GNU General Public License)
Plugin Version: 05 Jun 2006 (V1.000)
Change History:  
05 Jun 2006: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle 98%, FormattedSearch 98%, EndNotePlugin 98%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/EndNotePlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/EndNotePluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/EndNotePluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.IanBygrave - 05 Jun 2006

ALERT! NOTE: This plugin topic is obsolete, the plugin has been renamed to FootNotePlugin
Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 EndNotePlugin.md5 r2 r1 manage 0.2 K 2008-12-12 - 11:23 SopanShewale checksum file , Uploaded as a part of Release Process
Compressed Zip archivetgz EndNotePlugin.tgz r2 r1 manage 4.0 K 2008-12-12 - 11:23 SopanShewale See EndNotePlugin for details. Untar and run the installer script, Uploaded as a part of Release Process
Compressed Zip archivezip EndNotePlugin.zip r6 r5 r4 r3 r2 manage 5.4 K 2008-12-12 - 11:23 SopanShewale See EndNotePlugin for details. Unzip and run the installer script , Uploaded as a part of Release Process
Unknown file formatEXT EndNotePlugin_installer r2 r1 manage 3.4 K 2008-12-12 - 11:23 SopanShewale Installer Script, Uploaded as a part of Release Process
Edit | Attach | Watch | Print version | History: r12 < r11 < r10 < r9 < r8 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r12 - 2008-12-12 - SopanShewale
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.