174
edits
Changes
Jump to navigation
Jump to search
m
< [[Structurals]] {{todo| [[References]] >This page needs to be reorganized: progression from simple to more complex use is a bit circular..}}
==Footnote Numbering==You can setup the exact behaviour of footnotes with {{cmd|setupnotation|[footnote]}} (MkII: {{cmd|setupfootnotes}}).(The command page for the MkIV version is still missing, refer to the old version; translate location to alternative and conversion to numberconversion.)
You can setup the exact behaviour of footnotes as usual with <cmd>setupfootnotes</cmd>. For example, to use footnotes with standard footnote symbols (which ConTeXt has defined as the conversion "set 2"), with the footnote counter resetting on each page, one would use the following:
Beware, in MkIV In MkII this becamewas:
<{{cmd>|setupfootnotedefinition</cmd><code>|[before=\MyFontCommand]</code>}}.
This behavior Currently, footnotes are set so that the left end of the text of the footnote is controlled by aligned with the left edge of the text, and the <code>location</code> key in footnote number hangs out into the <code>\setupnotedefinition</code> commandmargin. Here are some examples:Is it possible to change this? (For instance, suppose I would like the number aligned to the text-edge, and then a fixed-width space, and then the text?)
→Footnotes in Floats: - comment align key
==First View==
==Basic Footnotes==
For basic footnotes, simply use <{{cmd>|footnote</cmd><tt>|[reference]{footnote text}</tt>}}.The reference is optional, and can be used to refer to the same footnote again. Footnotes can be referenced with the usual <{{cmd>|in</cmd> }} and <{{cmd>|at</cmd> }} macros (see [[References]]), or the note itself can be reproduced with <{{cmd>|note</cmd><tt>|[reference]</tt>}}. For example:
<texcode>
This\footnote[footA]({Or that, if you prefer.} is a sentence with a footnote\footnote{Actually,
two footnotes; this one and \in{footnote}[footA] on \at{page}[footA], denoted by \note[footA].}.
</texcode>
\starttext
\strut\vfill % A hack to shorten the page.
This\footnote[footA]({Or that, if you prefer.} is a sentence with a footnote\footnote{Actually,
two footnotes; this one and \in{footnote}[footA] on \at{page}[footA], denoted by \note[footA].}.
\stoptext
<texcode>
This\footnote({Or that\footnote{Or possibly even the other.}, if you prefer.} is a sentence
with a footnote.
</texcode>
\starttext
\strut\vfill % A hack to shorten the page.
This\footnote({Or that\footnote{Or possibly even the other.}, if you prefer.} is a sentence
with a footnote.
\stoptext
</context>
==Footnote Numbering==
<texcode>
\setupfootnotessetupnotation[footnote][way=bypage, conversionnumberconversion=set 2]
</texcode>
<texcode>
\setupnote[footnote]setupfootnotes[way=bypage, numberconversionconversion=set 2]
</texcode>
<context>
\setupfootnotessetupnotation[footnote][way=bypage, conversionnumberconversion=set 2]
\starttext
\strut\vfill % A hack to shorten the page.
This\footnote[footA]({Or that, if you prefer.} is a sentence with a footnote\footnote{Actually,
two footnotes; this one and \in{footnote}[footA] on \at{page}[footA], denoted by \note[footA].}.
\stoptext
==Alternate Footnote Locations==
The <{{cmd>|setupfootnotes</cmd> }} (MkII) command offers some options for the placement of footnotes; for instance, the <code>location=columns</code> option places the footnotes in a single column (of a multicolumn page) rather than across the whole page. The <code>location=text</code> option places the footnotes in text at a location specified by <{{cmd>|placefootnotes</cmd>}}; this can be easily used to create endnotes, or even to place footnotes after each paragraph or subsection.
<texcode>
\setupfootnotes[location=text]% MkII
This\footnote[footA]{Or that, if you prefer.} is a sentence with a footnote\footnote{Actually,
two footnotes; this one and footnote \note[footA].}.
\stoptext
</context>
=== Footnotes at the end of each chapter ===
Another elegant (MkIV) example places all footnotes in a subject (unnumbered section) at the end of each chapter. It is intelligent and will not create an empty subject when there are no footnotes to be placed. At no extra cost, the subject title "Footnote" will be singular or plural depending if there is only one or several footnotes to be placed:
<texcode>
\startsetups[chapter:after]
\ifcase\rawcountervalue[footnote]\relax
\or
\startsubject[title=Footnote]
\placefootnotes
\stopsubject
\else
\startsubject[title=Footnotes]
\placefootnotes
\stopsubject
\fi
\stopsetups
\setupnotes[location=none]
\setupnotation[way=bychapter]
\setuphead[chapter][aftersection=\setups{chapter:after}]
\starttext
\startchapter[title={Chapter One}]
This one\footnote{is placed}. And\footnote{this one is too}.
\stopchapter
\chapter[title={Chapter Two}]
But this one\footnote{is not flushed}.
\startchapter[title={Chapter Three}]
Unless \type{\stopchapter} was invoked.
\stopchapter
\startchapter[title={Chapter Three}]
On a chapter with\footnote{footnote}.
\stopchapter
\stoptext
</texcode>
===Footnotes in the margin===
First we switch off footnote placement, then we place them manually into the margin.
<texcode>
\setupnote[footnote][location=none]
\setupnotation[footnote][
align=flushleft,
location=serried,
width=broad,
]
\setuptexttexts[margin][]
[{\framed[%
align={right,bottom},
frame=off,
height=\textheight,
width=\rightmarginwidth
]{\placenotes[footnote]}}]
</texcode>
===... but not at the bottom===
Hraban wanted numbered margin notes, starting in on the same line as the referenced text (like a combination of {{cmd|inmargin}} and {{cmd|footnote}}). Wolfgang answered:
The only way I found to achieve this is by flushing the notes at the end of each footnote
entry which can be done with the next key. The positioning of each margin text is tricky
because {{cmd|placenotes}} adds skips at the begin of the block (which can be reduced with
{{cmd|placelocalnotes}}) but a inline version of the command (e.g. <tt>\placeinlinenotes</tt>) which
flushes the notes without vertical skips and a rule at the begin would help.
<texcode>
\define\PlaceFootnote
{\inrightmargin{\vtop{\placelocalnotes[footnote][before=,after=]}}}
\setupnote
[footnote]
[location=text,
bodyfont=,
next=\PlaceFootnote]
\setupnotation
[footnote]
[alternative=serried]
\setuplayout
[width=12cm,
rightmargindistance=0.5cm,
rightmargin=5cm]
\starttext
\dorecurse{6}{\input ward\expanded{\footnote{This is a footnote \recurselevel}} }
\stoptext
</texcode>
==Footnote Formatting==
You can change the font used in the footnotes with
Footnotes can be placed in multiple columns, using the <ttcode>n=<i>number</i></ttcode> option in <of {{cmd|setupnotes}} or {{cmd|setupnote}} (MkII: {{cmd>|setupfootnotes</cmd>}}).
<texcode>
\setupfootnotes[n=3]% MkII
This\footnote[footA](Or that\footnote{Or the other.}, if you prefer.} is a sentence
with a footnote\footnote{Actually, two footnotes; this one and \in{footnote}[footA]
\starttext
\strut\vfill % A hack to shorten the page.
This\footnote[footA]({Or that\footnote{Or the other.}, if you prefer.} is a sentence
with a footnote\footnote{Actually, two footnotes; this one and \in{footnote}[footA]
on \at{page}[footA], denoted by \note[footA].}.
{{todo|This is ugly, and points up some ConTeXt bugs that need to be fixed.}}
===Footnotes in pagraph form===
When enabling footnotes (actually notes and linenotes) in pagraph form, there is some risk in having no right separation between body and the notes. This can be partially avoided using <code>width=broad</code> ([http://www.ntg.nl/pipermail/ntg-context/2013/073650.html Hans dixit]).
<texcode>
\setupnote
[footnote]
[paragraph=yes]
\setupnotation
[footnote]
[alternative=serried,
width=broad,
distance=.5em,
display=no]
\starttext
\dorecurse{500}{text text text\footnote{note} }
\stoptext
</texcode>
==Footnotes in Floats==
[[Floating Objects|Floats]] cannot include normal footnotes, because they are likely to float to another page from the page on which they were defined, thus getting the footnotes out of order. Thus, to include footnotes in a float, one must use local footnotes. This table, which uses the <{{cmd>|placelegend</cmd> }} command to create a place for the footnotes, illustrates the process:
<texcode>
[width=\hsize,
frame=off,
%align=right,
%height=fit,
top=\hbox\bgroup,
\starttext
\startlocalfootnotes%[n=0]
\placetable
{Caption}
\stoptext
</context>
==Footnotes in a box==
Note that it is necessary to add the command {{cmd|automigrateinserts}} (for example before {{cmd|link=no|starttext}})
in order to correctly handle the placement of footnotes within a box such as {{cmd|framed}} or {{cmd|placeongrid}}...
==Placing Footnotes Manually==
In some cases, ConTeXt's footnoting system may not be able to do exactly what you want. For instance, you may want to place a footnote in a table so that the footnote appears with the rest of the footnotes on the page, or you may want to create a footnote to a footnote to a footnote. Many of these cases can be handled by using the <{{cmd>|footnotetext</cmd> }} command (which creates a footnote without placing the corresponding symbol in the text) and the <{{cmd>|note</cmd> }} command (which places the footnote symbol in the text, but does not create a footnote).
For example, to create a footnote to a footnote to a footnote, all but the first footnotes are created with <{{cmd>|footnotetext</cmd> }} commands, which are placed in the main text -- – thereby ensuring that the footnotes are numbered and appear in the correct order. Then, these footnotes are referenced by <{{cmd>|note</cmd> }} commands within the relevant footnotes. In this example, the lines are broken for clarity; note the <ttcode>%</ttcode> at the end of each line to prevent spurious spaces in the text.
<texcode>
This%
\footnote({Or that\note[footB], if you prefer.}%
\footnotetext[footB]{Or possibly even the other\note[footC].}%
\footnotetext[footC]{It could be something entirely different.}
<context>
\starttext
\strut\vfill
This%
\footnote({Or that\note[footB], if you prefer.}%
\footnotetext[footB]{Or possibly even the other\note[footC].}%
\footnotetext[footC]{It could be something entirely different.}
is a sentence with nested footnotes.
\stoptext
</context>
== Suppressing Footnotes Entirely ==
The boolean {{cmd|link=no|notesenabled}} controls whether footnotes are processed at all.
If set to ''false'', invocations of {{cmd|footnote}} will be ignored.
After it is set to ''true'' again ConTeXt will pick up the footnote counters at their
previous state, so numbering will continuous.
<context source="yes" mode="mkiv">
\setuppapersize [A7]
\starttext
\dorecurse {2} { foo \footnote {bar} baz \par }
\notesenabledfalse
\dorecurse {3} { foo \footnote {bar} baz \par }
\notesenabledtrue
\dorecurse {2} { foo \footnote {bar} baz \par }
\stoptext
</context>
== Color of Footnote Links that Refer to the Same Page ==
If you have set footnotes to be interactive and have noticed that your footnote links become red, it is because they are linked to content on the same page on which they appear. This means they are governed by the \{{cmd|setupinteraction }}’s attribute of '<code>contrastcolor'</code>, rather than '<code>color'</code>.
To fix the redness (or change it to a different color), try:
\setupinteraction[state=start,color=black,contrastcolor=black]
</texcode>
== Changing footnote interlinespace ==
If you want to change the interlinespace of footnotes without impacting the rest of the document, try:
<texcode>
\startsetups[footnote:interlinespace]
\setupinterlinespace[line=2.8ex]
\stopsetups
\setupnote[footnote][setups=footnote:interlinespace]
</texcode>
== Special Needs ==
There are numerous ways to display and format footnotes. The following section gathers solutions to some special tasks asked on the mailing list.
=== Hyphenation ===
* Is there a way to turn off hyphenation for the main body of my text, but enable it for the footnotes?
</texcode>
===Mark Placement===* Currently, footnotes are set so that the left end of the text of the footnote is aligned with How can I change the left edge placement of the text, and the footnote number hangs out into the margin. Is it possible to change this? (For instance, suppose I would like the number aligned to the text-edge, and then a fixed-width space, and then the textmark?)
This behavior is controlled by the <code>location</code> key of {{cmd|setupnotation}}. Here are some examples: Note number is typeset in an area with a width of 1cm1 cm, aligned at the left of the text area:
<context source="yes" text="produces">
\showframe
\setupnotedefinitionsetupnotation[footnote][location=left,width=1cm]
\setupnote[footnote][location=page,numbercommand=]
Suppose that one wants a width of 1.5em5 em. Then
<texcode>
\setupnote[footnote][margindistance=0em,command=\myfootnotecommand]
\setupnotedefinitionsetupnotation[footnote][location=left,hang=1]
\def\myfootnotecommand#1{\hbox to 1.5em{#1.}}
</texcode>
===Line Spacing===
* Can I change the line spacing of a footnote independently of that of the main text?
The way to do this is not obvious, but this is the code you need to use:
<texcode>
\def\setnotebodyfont
{\switchtobodyfont[your desired font size]\setupinterlinespace[your desired spacing]}
</texcode>
===Placement in Bidirectional Documents===
* Can the footnote rule be placed on the right-hand side?
This is possible via setting the <code>rule</code> key of {{cmd|setupnote}} and {{cmd|definenote}}. In right-to-left documents it is usually desirable to have right-to-left footnotes, where right-aligned footnote rules make more sense aesthetically. Set <code>rule=right</code> to achieve this. Prior to 01-04-2016 Beta, this would have turned off the footnote rule completely: one needed to use <code>rule={on,right}</code>.
In a BiDi document the direction of the surrounding text where the {{cmd|footnote}} is invoked determines the direction of the footnote block to come later. Therefore, some footnotes may be right-to-left whereas others can be left-to-right. Note that the text of the footnote does not play a role here. The style designer decides whether left or right footnote rules make more sense. However, there is a third option: setting <code>rule=paragraph</code> looks at the first paragraph in the footnote block and let that determine the position of the footnote rule. In other words, if the footnote block of the page starts with an RTL text we end up with a right-aligned footnote rule and a left-aligned rule is typeset otherwise. (The first line/paragraph of the footnote block on a page need not correspond to the start of a footnote; it can rather be the leftover from a long footnote that started on some previous page.)
For more fancy footnote rules, you can use <code>rulecommand=\MyRuleCommand</code>. Look at the definition of <code>\normalnoterule</code> in strc-not.mkvi for a starting point.
[[Category:Basics]]
