Difference between revisions of "Command/setupfootnotes"

From ConTeXt wiki
Jump to navigationJump to search
(Create reference page)
 
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<!-- please remove this and the following line if you have checked this page -->
 
{{Reference_Cleanup}}
 
 
{{Reference
 
{{Reference
 
|name=setupfootnotes
 
|name=setupfootnotes
Line 6: Line 4:
 
}}
 
}}
  
 +
== [[Help:Reference|Syntax]] (autogenerated) ==
 +
<syntax>setupfootnotes</syntax>
 
== [[Help:Reference|Syntax]] ==
 
== [[Help:Reference|Syntax]] ==
 
<table cellspacing="4" cellpadding="2" class="cmd">
 
<table cellspacing="4" cellpadding="2" class="cmd">
Line 12: Line 12:
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:conversion|conversion]]</td>
+
     <td class="cmd">[[Command/keyword:conversion|conversion]] or [[Command/keyword:numberconversion|numberconversion]]</td>
     <td>[[Reference/en/value:numbers|numbers]] [[Reference/en/value:characters|characters]] [[Reference/en/value:Characters|Characters]] [[Reference/en/value:romannumerals|romannumerals]] [[Reference/en/value:Romannumerals|Romannumerals]] </td>
+
     <td>[[Command/value:numbers|numbers]] [[Command/value:characters|characters]] [[Command/value:Characters|Characters]] [[Command/value:romannumerals|romannumerals]] [[Command/value:Romannumerals|Romannumerals]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:way|way]]</td>
+
     <td class="cmd">[[Command/keyword:way|way]]</td>
     <td>[[Reference/en/value:bytext|bytext]] [[Reference/en/value:bysection|bysection]] </td>
+
     <td>[[Command/value:bytext|bytext]] [[Command/value:bysection|bysection]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:location|location]]</td>
+
     <td class="cmd">[[Command/keyword:location|location]]</td>
     <td>[[Reference/en/value:page|page]] [[Reference/en/value:text|text]] [[Reference/en/value:columns|columns]] [[Reference/en/value:firstcolumn|firstcolumn]] [[Reference/en/value:lastcolumn|lastcolumn]] [[Reference/en/value:high|high]] [[Reference/en/value:none|none]] </td>
+
     <td>[[Command/value:page|page]] [[Command/value:text|text]] [[Command/value:columns|columns]] [[Command/value:firstcolumn|firstcolumn]] [[Command/value:lastcolumn|lastcolumn]] [[Command/value:high|high]] [[Command/value:none|none]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:rule|rule]]</td>
+
     <td class="cmd">[[Command/keyword:rule|rule]]</td>
     <td>[[Reference/en/value:on|on]] [[Reference/en/value:off|off]] </td>
+
     <td>[[Command/value:on|on]] [[Command/value:off|off]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:before|before]]</td>
+
     <td class="cmd">[[Command/keyword:rulecolor|rulecolor]]</td>
     <td>[[Reference/en/value:command|command]] </td>
+
     <td>[[Command/value:name|name]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:after|after]]</td>
+
     <td class="cmd">[[Command/keyword:before|before]]</td>
     <td>[[Reference/en/value:command|command]] </td>
+
     <td>[[Command/value:command|command]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:width|width]]</td>
+
     <td class="cmd">[[Command/keyword:after|after]]</td>
     <td>[[Reference/en/value:dimension|dimension]] </td>
+
     <td>[[Command/value:command|command]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:height|height]]</td>
+
     <td class="cmd">[[Command/keyword:width|width]]</td>
     <td>[[Reference/en/value:dimension|dimension]] </td>
+
     <td>[[Command/value:dimension|dimension]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:bodyfont|bodyfont]]</td>
+
     <td class="cmd">[[Command/keyword:height|height]]</td>
     <td>5pt ... 12pt [[Reference/en/value:small|small]] [[Reference/en/value:big|big]] </td>
+
     <td>[[Command/value:dimension|dimension]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:style|style]]</td>
+
     <td class="cmd">[[Command/keyword:bodyfont|bodyfont]]</td>
     <td>[[Reference/en/value:normal|normal]] [[Reference/en/value:bold|bold]] [[Reference/en/value:slanted|slanted]] [[Reference/en/value:boldslanted|boldslanted]] [[Reference/en/value:type|type]] [[Reference/en/value:cap|cap]] [[Reference/en/value:small...|small...]] [[Reference/en/value:command|command]] </td>
+
     <td>5pt ... 12pt [[Command/value:small|small]] [[Command/value:big|big]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:distance|distance]]</td>
+
     <td class="cmd">[[Command/keyword:style|style]]</td>
     <td>[[Reference/en/value:dimension|dimension]] </td>
+
     <td>[[Command/value:normal|normal]] [[Command/value:bold|bold]] [[Command/value:slanted|slanted]] [[Command/value:boldslanted|boldslanted]] [[Command/value:type|type]] [[Command/value:cap|cap]] [[Command/value:small...|small...]] [[Command/value:command|command]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:columndistance|columndistance]]</td>
+
     <td class="cmd">[[Command/keyword:distance|distance]]</td>
     <td>[[Reference/en/value:dimension|dimension]] </td>
+
     <td>[[Command/value:dimension|dimension]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:margindistance|margindistance]]</td>
+
     <td class="cmd">[[Command/keyword:columndistance|columndistance]]</td>
     <td>[[Reference/en/value:dimension|dimension]] </td>
+
     <td>[[Command/value:dimension|dimension]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:n|n]]</td>
+
     <td class="cmd">[[Command/keyword:margindistance|margindistance]]</td>
     <td>[[Reference/en/value:number|number]] </td>
+
     <td>[[Command/value:dimension|dimension]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:numbercommand|numbercommand]]</td>
+
     <td class="cmd">[[Command/keyword:n|n]]</td>
     <td>[[Reference/en/value:oneargument|oneargument]] </td>
+
     <td>[[Command/value:number|number]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:textcommand|textcommand]]</td>
+
     <td class="cmd">[[Command/keyword:numbercommand|numbercommand]]</td>
     <td>[[Reference/en/value:oneargument|oneargument]] </td>
+
     <td>[[Command/value:oneargument|oneargument]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:split|split]]</td>
+
     <td class="cmd">[[Command/keyword:textcommand|textcommand]]</td>
     <td>[[Reference/en/value:tolerant|tolerant]] [[Reference/en/value:strict|strict]] [[Reference/en/value:verystrict|verystrict]] [[Reference/en/value:number|number]] </td>
+
     <td>[[Command/value:oneargument|oneargument]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:textstyle|textstyle]]</td>
+
     <td class="cmd">[[Command/keyword:split|split]]</td>
     <td>[[Reference/en/value:normal|normal]] [[Reference/en/value:bold|bold]] [[Reference/en/value:slanted|slanted]] [[Reference/en/value:boldslanted|boldslanted]] [[Reference/en/value:type|type]] [[Reference/en/value:cap|cap]] [[Reference/en/value:small...|small...]] [[Reference/en/value:command|command]] </td>
+
     <td>[[Command/value:tolerant|tolerant]] [[Command/value:strict|strict]] [[Command/value:verystrict|verystrict]] [[Command/value:number|number]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:textcolor|textcolor]]</td>
+
     <td class="cmd">[[Command/keyword:textstyle|textstyle]]</td>
     <td>[[Reference/en/value:name|name]] </td>
+
     <td>[[Command/value:normal|normal]] [[Command/value:bold|bold]] [[Command/value:slanted|slanted]] [[Command/value:boldslanted|boldslanted]] [[Command/value:type|type]] [[Command/value:cap|cap]] [[Command/value:small...|small...]] [[Command/value:command|command]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:interaction|interaction]]</td>
+
     <td class="cmd">[[Command/keyword:textcolor|textcolor]]</td>
     <td>[[Reference/en/value:yes|yes]] [[Reference/en/value:no|no]] </td>
+
     <td>[[Command/value:name|name]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
     <td class="cmd">[[Reference/en/keyword:factor|factor]]</td>
+
     <td class="cmd">[[Command/keyword:interaction|interaction]]</td>
     <td>[[Reference/en/value:number|number]] </td>
+
    <td>[[Command/value:yes|yes]] [[Command/value:no|no]] </td>
 +
  </tr>
 +
  <tr valign="top" class="first">
 +
    <td class="cmd">[[Command/keyword:factor|factor]]</td>
 +
     <td>[[Command/value:number|number]] </td>
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="first">
 
   <tr valign="top" class="first">
 
     <td class="cmd">[...,...=...,...]</td>
 
     <td class="cmd">[...,...=...,...]</td>
     <td>see [[Reference/en/framed|\framed]] </td>
+
     <td>see [[Command/framed|\framed]] </td>
 
   </tr>
 
   </tr>
 
</table>
 
</table>
Line 103: Line 107:
  
 
== Description ==  
 
== Description ==  
== comment ==
+
Setup the properties of the footnote blocks (which may contain multiple footnotes), and some properties of the note marks in that block.
<pre>
 
\setupfootnotes[interaction=no]
 
will switch off interaction in footnotes. This is
 
available in new releases only (beginning Feb. 24 2004)
 
</pre>
 
  
 +
== Keys ==
  
 +
{| class=wikitable
 +
|-
 +
! '''Key'''
 +
! '''Values'''
 +
|- style="vertical-align: top"
 +
| {{key|conversion}}
 +
| '''numbers''' characters Characters romannumerals Romannumerals
 +
|- style="vertical-align: top"
 +
| {{key|way}}
 +
| '''bytext''' bysection
 +
Start numbering from 1 again at the start of every section?
 +
|- style="vertical-align: top"
 +
| {{key|location}}
 +
| '''page''' text columns firstcolumn lastcolumn high none
 +
Where to place the footnotes?
 +
|- style="vertical-align: top"
 +
| {{key|rule}}
 +
| '''on''' off
 +
|- style="vertical-align: top"
 +
| {{key|rulecolor}}
 +
| ''name''
 +
|- style="vertical-align: top"
 +
| {{key|before}}
 +
| ''command''
 +
|- style="vertical-align: top"
 +
| {{key|after}}
 +
| ''command''
 +
|- style="vertical-align: top"
 +
| {{key|width}}
 +
| ''dimension''
 +
|- style="vertical-align: top"
 +
| {{key|height}}
 +
| ''dimension''
 +
|- style="vertical-align: top"
 +
| {{key|bodyfont}}
 +
| 5pt ... 12pt small big
 +
What size to print the footnotes?
 +
|- style="vertical-align: top"
 +
| {{key|style}}
 +
| normal bold slanted boldslanted type cap small... command
 +
|- style="vertical-align: top"
 +
| {{key|distance}}
 +
| ''dimension''
 +
|- style="vertical-align: top"
 +
| {{key|columndistance}}
 +
| ''dimension''
 +
|- style="vertical-align: top"
 +
| {{key|margindistance}}
 +
| ''dimension''
 +
|- style="vertical-align: top"
 +
| {{key|n}}
 +
| ''number''
 +
|- style="vertical-align: top"
 +
| {{key|numbercommand}}
 +
| ''command that takes 1 argument''
 +
|- style="vertical-align: top"
 +
| {{key|textcommand}}
 +
| ''command that takes 1 argument''
 +
|- style="vertical-align: top"
 +
| {{key|split}}
 +
| tolerant strict verystrict number
 +
|- style="vertical-align: top"
 +
| {{key|textstyle}}
 +
| '''normal''' bold slanted boldslanted type cap small... command
 +
|- style="vertical-align: top"
 +
| {{key|textcolor}}
 +
| ''name''
 +
|- style="vertical-align: top"
 +
| {{key|interaction}}
 +
| '''yes''' no
 +
Should footnote marks be hyperlinks?
 +
|- style="vertical-align: top"
 +
| {{key|factor}}
 +
| ''number''
 +
|- style="vertical-align: top"
 +
| [...,...=...,...]
 +
| see {{cmd|framed}}
 +
|-
 +
|}
  
 
== Example ==
 
== Example ==
  
<pre class="example">
+
<context source=yes>
 +
\setuppapersize[A8, landscape]
 +
 
 
\defineconversion[starred][\starredconv]
 
\defineconversion[starred][\starredconv]
 
\def\starredconv#1{\ifcase#1\or*\or**\or***\fi}
 
\def\starredconv#1{\ifcase#1\or*\or**\or***\fi}
\setupfootnotes[conversion=starred]
+
\setupfootnotes
 +
  [conversion=starred,
 +
    color=blue,
 +
    frame=on]
  
 
\starttext
 
\starttext
   Charles IV\/\footnote{Best Czech king (14th cent.)
+
   Charles IV\footnote{Best Czech king (14th cent.)
     and the winner of best Czech person voting.}
+
     and the winner of a \quote{best Czech person} poll.}
  
 
   \it
 
   \it
   Charles IV\/\footnote{Best Czech king (14th cent.)
+
   Charles IV\footnote{Best Czech king (14th cent.)
     and the winner of Best Czech person voting.}
+
     and the winner of a \quote{best Czech person} poll.}
  
 
   \tt
 
   \tt
   Charles IV\/\footnote{Best Czech king (14th cent.)
+
   Charles IV\footnote{Best Czech king (14th cent.)
     and the winner of Best Czech person voting.}
+
     and the winner of a \quote{best Czech person} poll.}
 
\stoptext
 
\stoptext
 +
</context>
 +
 +
===Extra Space===
 +
 +
To add extra space before the footnote marks:
  
</pre>
+
<context source=yes>
 +
\setupfootnotes[
 +
  textstyle={\hskip.05em},
 +
]
  
 +
\starttext
 +
í\footnote{í}
 +
T\footnote{T}
 +
ľ\footnote{ľ}
 +
ě\footnote{ě}
 +
ď\footnote{ď}
 +
\stoptext
 +
</context>
  
 
== See also ==
 
== See also ==
<!-- something like [[cmd:goto|\goto]] -->
+
* {{cmd|footnote}}
 +
* {{cmd|setupfootnotedefinition}} to setup the individual footnotes
 +
 
 +
== Help from ConTeXt-Mailinglist/Forum ==
 +
All issues with:
 +
{{Forum|{{SUBPAGENAME}}}}
  
[[Category:Reference/en|setupfootnotes]]
+
[[Category:Command/Footnotes|setupfootnotes]]

Latest revision as of 13:14, 13 October 2019

\setupfootnotes

Syntax (autogenerated)

Syntax

\setupfootnotes[...,...=...,...]
conversion or numberconversion numbers characters Characters romannumerals Romannumerals
way bytext bysection
location page text columns firstcolumn lastcolumn high none
rule on off
rulecolor name
before command
after command
width dimension
height dimension
bodyfont 5pt ... 12pt small big
style normal bold slanted boldslanted type cap small... command
distance dimension
columndistance dimension
margindistance dimension
n number
numbercommand oneargument
textcommand oneargument
split tolerant strict verystrict number
textstyle normal bold slanted boldslanted type cap small... command
textcolor name
interaction yes no
factor number
[...,...=...,...] see \framed


Description

Setup the properties of the footnote blocks (which may contain multiple footnotes), and some properties of the note marks in that block.

Keys

Key Values
conversion numbers characters Characters romannumerals Romannumerals
way bytext bysection

Start numbering from 1 again at the start of every section?

location page text columns firstcolumn lastcolumn high none

Where to place the footnotes?

rule on off
rulecolor name
before command
after command
width dimension
height dimension
bodyfont 5pt ... 12pt small big

What size to print the footnotes?

style normal bold slanted boldslanted type cap small... command
distance dimension
columndistance dimension
margindistance dimension
n number
numbercommand command that takes 1 argument
textcommand command that takes 1 argument
split tolerant strict verystrict number
textstyle normal bold slanted boldslanted type cap small... command
textcolor name
interaction yes no

Should footnote marks be hyperlinks?

factor number
[...,...=...,...] see \framed

Example

\setuppapersize[A8, landscape]

\defineconversion[starred][\starredconv]
\def\starredconv#1{\ifcase#1\or*\or**\or***\fi}
\setupfootnotes
   [conversion=starred,
    color=blue,
    frame=on]

\starttext
  Charles IV\footnote{Best Czech king (14th cent.)
    and the winner of a \quote{best Czech person} poll.}

  \it
  Charles IV\footnote{Best Czech king (14th cent.)
    and the winner of a \quote{best Czech person} poll.}

  \tt
  Charles IV\footnote{Best Czech king (14th cent.)
    and the winner of a \quote{best Czech person} poll.}
\stoptext

Extra Space

To add extra space before the footnote marks:

\setupfootnotes[
  textstyle={\hskip.05em},
]

\starttext
í\footnote{í}
T\footnote{T}
ľ\footnote{ľ}
ě\footnote{ě}
ď\footnote{ď}
\stoptext

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: