Tags:
create new tag
, view all tags

Feature Proposal: Footnotes

Motivation

Footnotes are very useful when writing documentation. In fact, TWiki can succeed more in tech writing if it supports footnotes.

Description

We can borrom the syntax shamelessly from DokuWiki, http://wiki.splitbrain.org/wiki:syntax#footnotes

You write:

    Embed footnotes ((This is a footnote)) anywhere by using double parenthesises.

You get: (simulated)

Embed footnotes 1) anywhere by using double parenthesises.

-- PeterThoeny - 19 Jan 2006

Impact and Available Solutions

Documentation

Examples

Implementation

Discussion

I'd suggest to stick with TML tags:

%FOOTNOTE{"This is a footnote"}%
and
%STARTFOOTNOTE%
This is another footnote.
%STOPFOOTNOTE%

-- MichaelDaum - 20 Jan 2006

What is the reason? %FOOTNOTE{"This is a footnote"}% ir more typing than (()).

-- PeterThoeny - 20 Jan 2006

ok, you will break existing installations by stealing another character from users - the obvious example is those people that use TWiki to document and markup source code.

also, using TML tag syntax for everything would simplify the parser, and the wysiwyg editor - this might be something we should consider for all new syntax

and lastly, should this be new syntax that is domain specific? in which case a plugin is in order - then if its popular, one can consider shipping it by default....

-- SvenDowideit - 20 Jan 2006

I agree with SvenDowideit in that this feature should be implemented as a plugin. This means less code in the core, and can evolve independantly of the TWiki release.

Now that I think about it, SomeTWikiVariablesShouldBeInPlugins

-- RafaelAlvarez - 22 Jan 2006

I've just written EndNotePlugin

-- IanBygrave - 06 Jun 2006


1) This is a footnote
Edit | Attach | Watch | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r6 - 2006-06-06 - IanBygrave
 
  • 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.