Wiki source for FootnoteActionInfo


Show raw source

=====Footnote Action Documentation=====
//Not included in official Wikka version//

>>==See also:==
Development: FootnoteAction>>This is the documentation page for the Footnote action.::c::
===Documentation===

==Short description==
Displays a numbered footnote at the bottom of the page.

==Parameters==
""<table cellspacing="0" cellpadding="2" border="1">
<thead>
<tr><th scope="col">name</th><th scope="col">type</th><th scope="col">required?</th><th scope="col">default</th><th scope="col">description</th></tr>
</thead>
<tbody>
<tr><td>note</td><td>string</td><td>required</td><td></td><td>The text of the footnote.</td></tr>
</tbody>
</table>""
==Notes==
~- Do not insert a footnote number: it is added automatically by the action.
~- Make sure to use single quotes ( ' ) to delimit the 'note' parameter string. If you want to include a single quote inside the string, use the ' entity (see example below.)
~- A limited subset of the wiki formatting markup is allowed in the text of the note. The following will be rendered in the footnote's text:
~~- **bold**, //italic//, __underline__, ++strikethrough++, ''highlight'', ##monospace##, #%key#%
~~- simple URLs (http://wikkawiki.org) and [[http://wush.net/trac/wikka/ | forced links]] to an external URL
~~- automatic links ([[HomePage]]) and [[HomePage | forced links]] to an internal page

==Long description==
This action displays a numeric superscript (starting at 1 and incremented for each additional note on the page) with an hyperlink to the text of the footnote, which is displayed at the bottom of the page.

==Usage==
%%{{footnote note='text of the note'}}%%

===Examples===

//The following page content://

%%
Next to this sentence, there is a footnote{{footnote note='that's the text of the footnote [[[http://wikkawiki.org/FootnoteActionInfo | more info]]]'}}

This
is
more
text
... and here is another, bold-formatted footnote {{footnote note='**note #2**'}}
%%
//is displayed as follows://

""Next to this sentence, there is a footnote<a href='http://wikkawiki.org/wikka.php?wakka=FootnoteActionInfo#fn1' title='that's the text of the footnote [http:wikkawiki.org/FootnoteActionInfo more info]' ><sup id='fnback1'>1</sup></a><br />""
This
is
more
text
""... and here is another, bold-formatted footnote <a href='http://wikkawiki.org/wikka.php?wakka=FootnoteActionInfo#fn2' title='note #2'><sup id='fnback2'>2</sup></a><br />""
""<fieldset style='background-color: #eeeeee; padding: 10px; margin-top: 15px; border: #666666 1px solid; font-size: 0.9em;'><legend> <strong>Notes </strong></legend><a id='fn1' href='http://wikkawiki.org/wikka.php?wakka=FootnoteActionInfo#fnback1' title='Jump back to page'><span style='text-decoration:underline;'>1</span></a>: that's the text of the footnote [<a class="ext" href="http://wikkawiki.org/FootnoteActionInfo">more info</a><span class="exttail">∞</span>]<br />
<a id='fn2' href='http://wikkawiki.org/wikka.php?wakka=FootnoteActionInfo#fnback2' title='Jump back to page'><span style='text-decoration:underline;'>2</span></a>: <strong>note #2</strong></fieldset><br />""
==Author==
DomBonj

----
CategoryDocumentation
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki