UsingFootnotes

From 40tude Dialog Wiki

Contents

Using Footnotes

This little tutorial explains how footnotes with this script inside 40tude Dialog will work.


General introductions

Specials


Everything gets reformated

Normal use of Footnotes - everything gets reformated.

Your text inside the editor-window:

Der Spitzenreiter #fn# Man nennt sie auch den 1.FC Knochenbruch.## musste
am Sonntag Federn lassen. Greuther Fürth verlor im Topspiel gegen den
MSV Duisburg mit 0:1. Köln#fn# Das ist die Metropole am Rhein.## hingegen
drehte das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt mit dem
6:2 gegen RWO einen Kantersieg ein und Trier feiert den ersten Saisonsieg
gegen Unterhaching.

Output:

Der Spitzenreiter [1] musste am Sonntag Federn lassen. Greuther Fürth
verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln[2] hingegen drehte
das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt mit dem 6:2 gegen
RWO einen Kantersieg ein und Trier feiert den ersten Saisonsieg gegen
Unterhaching.

Footnotes:
¯¯¯¯¯¯¯¯¯¯
[1] Man nennt sie auch den 1.FC Knochenbruch.
[2] Das ist die Metropole am Rhein.

Reformat until first line break

Everything till the first blank line will be reformated.


Your text inside the editor-window:

Der Spitzenreiter #fn# Man nennt sie auch den 1.FC Knochenbruch.## musste
am Sonntag Federn lassen. 

Greuther Fürth verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln
hingegen drehte das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt
mit dem 6:2 gegen RWO einen Kantersieg ein und Trier feiert den ersten
Saisonsieg gegen Unterhaching.

Output:

Der Spitzenreiter [1] musste am Sonntag Federn lassen.

Greuther Fürth verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln
hingegen drehte das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt
mit dem 6:2 gegen RWO einen Kantersieg ein und Trier feiert den ersten
Saisonsieg gegen Unterhaching.

Footnotes:
¯¯¯¯¯¯¯¯¯¯
[1] Man nennt sie auch den 1.FC Knochenbruch.

Reformat until ConstRewrapToLine

Everything until << (defined in ConstRewrapToLine) gets reformated.


Your text inside the editor-window:

Der Spitzenreiter #fn# Man nennt sie auch den 1.FC Knochenbruch.## musste
am Sonntag Federn lassen.<<
Greuther Fürth verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln
hingegen drehte das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt
mit dem 6:2 gegen RWO einen Kantersieg ein und Trier feiert den ersten
Saisonsieg gegen Unterhaching.

Output:

Der Spitzenreiter [1] musste am Sonntag Federn lassen.
Greuther Fürth verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln
hingegen drehte das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt
mit dem 6:2 gegen RWO einen Kantersieg ein und Trier feiert den ersten
Saisonsieg gegen Unterhaching.

Footnotes:
¯¯¯¯¯¯¯¯¯¯
[1] Man nennt sie auch den 1.FC Knochenbruch.

Long Footnotes

Also long Footnotes are possible.


Your text inside the editor-window:

Der Spitzenreiter #fn# Man nennt sie auch den 1.FC Knochenbruch, auch 
wenn der Greuther Anhang sicherlich nicht ganz konform mit dieser 
Beschreibung des eigenen Lieblingsclubs geht. Manchmal muss man der 
Realität halt tief ins Auge blicken.## musste am Sonntag Federn lassen. 
Greuther Fürth verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln 
hingegen drehte das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt 
mit dem 6:2 gegen RWO einen Kantersieg ein und Trier feiert den ersten 
Saisonsieg gegen Unterhaching.

Output:

Der Spitzenreiter [1] musste am Sonntag Federn lassen. Greuther Fürth
verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln hingegen drehte
das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt mit dem 6:2 gegen
RWO einen Kantersieg ein und Trier feiert den ersten Saisonsieg gegen
Unterhaching.

Footnotes:
¯¯¯¯¯¯¯¯¯¯
[1] Man nennt sie auch den 1.FC Knochenbruch, auch wenn der Greuther
    Anhang sicherlich nicht ganz konform mit dieser Beschreibung des
    eigenen Lieblingsclubs geht. Manchmal muss man der Realität halt
    tief ins Auge blicken.

Footnotes inside Boxquotes

Footnotes inside Boxquotes, if you want to use a merged script.

Your text inside the editor-window:
Please note that you have to end with << (defined in ConstRewrapToLine)

box:
Fussball-Sonntag
-
Der Spitzenreiter #fn# Man nennt sie auch den 1.FC Knochenbruch.## musste
am Sonntag Federn lassen. Greuther Fürth verlor im Topspiel gegen den
MSV Duisburg mit 0:1. Köln hingegen drehte das Spiel gegen Dresden und
siegt 3:2. Frankfurt fährt mit dem 6:2 gegen RWO einen Kantersieg ein
und Trier feiert den ersten Saisonsieg gegen Unterhaching.<<
-

Output:

,---- [Fussball-Sonntag] 
| Der Spitzenreiter [1] musste am Sonntag Federn lassen. Greuther Fürth
| verlor im Topspiel gegen den MSV Duisburg mit 0:1. Köln hingegen drehte
| das Spiel gegen Dresden und siegt 3:2. Frankfurt fährt mit dem 6:2 gegen
| RWO einen Kantersieg ein und Trier feiert den ersten Saisonsieg gegen
| Unterhaching.
'----

Footnotes:
¯¯¯¯¯¯¯¯¯¯
[1] Man nennt sie auch den 1.FC Knochenbruch.



Install & Setup the script

Of course the tags alone won't do much. You have to insert the script into the OnBeforeSendingMessage event of your scripting window.


Setup in the script:
If you want to change the setup for the footnotes, you have to edit the lines below inside the script.

// configuration options
// Set this to true, if you want a footnote-header (see example).
// Footnotes:
// ==========
ConstFootnoteHead = True;

// Define the text, you want to see in your footnote-header.
ConstFootnoteHeadTxt = 'Footnotes:';

// Here you can define the character which one should underline the
// footnote-header. If there should be no underline, just set
// "ConstFootnoteHeadUnderline = '';" (without quotation marks).
ConstFootnoteHeadUnderline = '¯';

// If there should be a blank line between footnote-header and footnotes,
// set this to "True". Otherwhise (False) there is no empty line between.
ConstEmptyLine = False;

// Defines start-tag for footnote recognition. Everything after that (and
// between end-tag) is recogniced as footnote.
ConstStartupFootnote = '#fn#';

// Defines end-tag of footnote recognation. Please be sure to use chars,
// you normaly not typing inside your text.
ConstEndFootnote = '##';

// For longer footnotes its important to reformat the footnote. This number
// defines the column-number (should always be 1 char higher, than inside
// Dialog). You will find this option in Settings -> General settings... ->
// Posting -> Wrap lines after xx chars
ConstReWrapEdge = 73;

// Defines a control character to expand the footnote to a blank line.
// Change it as your own wish.
ConstMultiLine = '%%';

// Define char(s) until this the paragraph will be reformated by the
// footnote-logic. Its very important if you want to use footnotes inside
// boxquotes, to put this at the end from your footnote!
ConstRewrapToLine = '<<';

// Useful if you want to talk about this footnote-skript inside 40tude Dialog,
// just comment them out. Note that the comment-chars will be not deleted in
// the article.
ConstComments = '//';

// By default this script adds a blank line before the footnote block.
// Set this to false if you do not want the blank line.
ConstEmptyLineBeforeFootnote = true;

Questions, Bugs & Comments

If you have questions, comments or found a bug please post to de.comm.software.40tude-dialog.


René Fischer