Changes between Version 36 and Version 37 of FootNoteMacro


Ignore:
Timestamp:
Nov 6, 2016, 11:56:07 AM (13 months ago)
Author:
figaro
Comment:

Moved example to functional description

Legend:

Unmodified
Added
Removed
Modified
  • FootNoteMacro

    v36 v37  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Add footnotes to wiki
     3= Add footnotes to wiki page
    44
    55== Description
    66
    7 The FootNoteMacro automatically collates[[FootNote(Arranges in numerical order)]] and generates footnotes.
     7The FootNoteMacro automatically collates[[FootNote(Arranges in numerical order)]] and generates footnotes from a Trac wiki page and displays them at the bottom of the page.
    88
    9  Note:: There is an open ticket for integrating this feature to the Trac core, t:#9037.
     9To use it, simply call the FootNoteMacro with the footnote content[[FootNote(Any WikiFormatting can be used as content)]] as the only argument to the macro:
     10
     11{{{
     12[[FootNote(This is a footnote)]]
     13}}}
     14
     15Footnotes are numbered by the order in which they appear.
     16
     17To create a reference to an existing footnote, pass the footnote number as the only argument to the macro:
     18
     19{{{
     20[[FootNote(1)]]
     21}}}
     22
     23In addition, identical footnotes are coalesced into one entry. The following will generate one footnote entry with two references:
     24
     25{{{
     26Some text[[FootNote(A footnote)]] and some more text [[FootNote(A footnote)]].
     27
     28[[FootNote]]
     29}}}
     30
     31And finally, to display a list of foot-notes call the macro with no arguments:
     32
     33{{{
     34[[FootNote]]
     35}}}
     36
     37Once a set of footnotes has been displayed by the use of `[[FootNote]]` macro, a complete new set of footnotes can be created. This allows multiple sets of footnotes per page.
     38
     39See below for more examples.
     40
     41'''Note''': There is an open ticket for integrating this feature to the Trac core, t:#9037.
    1042
    1143== Bugs/Feature Requests
     
    4678}}}
    4779 1. **Test** if is it working properly (all your environments).
    48 
    49 == Usage
    50 
    51 To use it, simply call the FootNoteMacro with the footnote content[[FootNote(Any WikiFormatting can be used as content)]] as the only argument to the macro:
    52 
    53 {{{
    54 [[FootNote(This is a footnote)]]
    55 }}}
    56 
    57 Footnotes are numbered by the order in which they appear.
    58 
    59 To create a reference to an existing footnote, pass the footnote number as the only argument to the macro:
    60 
    61 {{{
    62 [[FootNote(1)]]
    63 }}}
    64 
    65 In addition, identical footnotes are coalesced into one entry. The following will generate one footnote entry with two references:
    66 
    67 {{{
    68 Some text[[FootNote(A footnote)]] and some more text [[FootNote(A footnote)]].
    69 
    70 [[FootNote]]
    71 }}}
    72 
    73 And finally, to display a list of foot-notes call the macro with no arguments:
    74 
    75 {{{
    76 [[FootNote]]
    77 }}}
    78 
    79 Once a set of footnotes has been displayed (by the use of `[[FootNote]]` macro), a complete new set of footnotes can be created. This allows multiple sets of footnotes per page.
    8080
    8181== Example