Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r6  >  r5  >  r4  >  r3  >  r2  >  r1
FootNotePlugin 6 - 29 Apr 2007 - Main.IanBygrave
Line: 1 to 1
 

FootNotePlugin

Footnotes are notes placed at the end of a topic.

Line: 66 to 66
 
Plugin Author: TWiki:Main.IanBygrave
Copyright: © 2006, TWiki:Main.IanBygrave
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 05 Dec 2006 (V2.000)
>
>
Plugin Version: 30 Apr 2007 (V2.001)
 
Change History: 
<-- versions below in reverse order -->
 
Changed:
<
<
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.
>
>
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
Line: 86 to 87
 -- IanBygrave? - 05 Dec 2006
Changed:
<
<
META FILEATTACHMENT attachment="FootNotePlugin.zip" attr="" comment="" date="1168467235" name="FootNotePlugin.zip" path="FootNotePlugin.zip" size="7372" stream="FootNotePlugin.zip" user="Main.IanBygrave" version="1"
>
>
META FILEATTACHMENT attachment="FootNotePlugin.zip" attr="" comment="" date="1177890237" name="FootNotePlugin.zip" path="FootNotePlugin.zip" size="8652" stream="FootNotePlugin.zip" user="Main.IanBygrave" version="2"

FootNotePlugin 5 - 01 Mar 2007 - Main.IanBygrave
Line: 1 to 1
 

FootNotePlugin

Footnotes are notes placed at the end of a topic.

Line: 41 to 41
 
    • Set DEBUG = 0

  • Heading
Changed:
<
<
    • Set HEADING = Notes
>
>
    • Set HEADER = Notes
    • Set FOOTER = ---
 

Plugin Installation Instructions


FootNotePlugin 4 - 13 Jan 2007 - Main.IanBygrave
Line: 1 to 1
 

FootNotePlugin

Footnotes are notes placed at the end of a topic.

Line: 15 to 15
 %FOOTNOTE{LIST="Web.Topic"}% will be replaced by the notes from an %INCLUDE% ed page.
Added:
>
>		%STARTFOOTNOTE{}% 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

Line: 65 to 67
 
License: GPL (GNU General Public License)
Plugin Version: 05 Dec 2006 (V2.000)
Change History: 
<-- versions below in reverse order -->
 
Changed:
<
<
05 Jun 2006: Initial version was called EndNotePlugin?
>
>
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
Added:
>
>
05 Jun 2006: Initial version was called EndNotePlugin
 
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none

FootNotePlugin 3 - 10 Jan 2007 - Main.IanBygrave
Line: 1 to 1
 

FootNotePlugin

Footnotes are notes placed at the end of a topic.

Line: 7 to 7
 

Syntax Rules

Changed:
<
<		Write {{ note text }} anywhere in a TWiki 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.
Line: 79 to 79
 Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- IanBygrave? - 05 Dec 2006

Added:
>
>
META FILEATTACHMENT attachment="FootNotePlugin.zip" attr="" comment="" date="1168467235" name="FootNotePlugin.zip" path="FootNotePlugin.zip" size="7372" stream="FootNotePlugin.zip" user="Main.IanBygrave" version="1"

FootNotePlugin 2 - 05 Jan 2007 - Main.IanBygrave
Line: 1 to 1
 

FootNotePlugin

Footnotes are notes placed at the end of a topic.


FootNotePlugin 1 - 05 Dec 2006 - Main.IanBygrave
Line: 1 to 1
Added:
>
>

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.

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

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

  • 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 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 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 Dec 2006 (V2.000)
Change History: 
<-- versions below in reverse order -->
 
05 Jun 2006: Initial version was called EndNotePlugin?
05 Dec 2006: Renamed to FootNotePlugin
TWiki Dependency: $TWiki::Plugins::VERSION 1.1
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Benchmarks: GoodStyle 98%, FormattedSearch 98%, 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.


Revision 6r6 - 29 Apr 2007 - 23:43:58 - IanBygrave?
Revision 5r5 - 01 Mar 2007 - 12:12:26 - IanBygrave?
Revision 4r4 - 13 Jan 2007 - 14:27:28 - IanBygrave?
Revision 3r3 - 10 Jan 2007 - 22:13:56 - IanBygrave?
Revision 2r2 - 05 Jan 2007 - 17:20:54 - IanBygrave?
Revision 1r1 - 05 Dec 2006 - 00:33:50 - IanBygrave?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM