Footnotes

A region that gathers footnote text, as a per-page footer or an endnotes list.

A Footnotes region displays note content. In Layout scaffolding, it collects the notes whose markers appear on each page. In flowing content, it collects preceding notes that haven't been collected by an earlier endnotes list.

Fields

counterStyleType stringCounter style for the Layout's note numbers and inline markers. Defaults to the document's numbering style, or decimal. Set it on a Layout footer. Endnotes keep the numbers already assigned to their markers.

restartEachPageType booleanRestart page-footer note numbers from 1 on each page. Inline markers change to match. Defaults to false. Set it on a Layout footer. Endnotes retain their continuous numbers.

repeatHeadType booleanRepeat leading content in each page's footer. Defaults to true for a Layout footer. Set to false to show it only once. Endnotes always show leading content once, regardless of this setting.

Example

A footer region in the Layout, so footnotes gather at the foot of each page that carries one.

<Layout id="page" width={793.71} height={1122.52}>
	<Flow>
		...
	</Flow>
	<Footnotes />
</Layout>

<Layout id="page" :width="793.71" :height="1122.52">
	<Flow>
		...
	</Flow>
	<Footnotes />
</Layout>

<template data-type="layout" data-id="page" data-width="793.71px" data-height="1122.52px">
	<template data-type="flow">
		...
	</template>
	<template data-type="footnotes"></template>
</template>

Content

Children appear above the generated note list. In a page footer they repeat on every page that has notes. Set repeatHead to false to show them only once. In an endnotes list, children appear once.

Rendered structure

Format generates an <aside data-type="footnotes"> containing one <dl data-type="footnote-entries">. Each note is a pair: a <dt data-type="footnote-number"> and a <dd data-type="footnote-content">.

Endnotes add data-variant="inline" to the aside. A class or inline style on the Footnotes element is passed to the aside. See the DOM contract for all styling attributes.

Constraints

Placement determines the mode. Put the region in Layout scaffolding for page footers, or in flowing content for endnotes. Without an authored footer, Format adds one to each page that has uncollected notes.
Endnotes use existing numbers. counterStyle and restartEachPage are read from Layout footers. Setting them on an endnotes list has no effect, and repeatHead doesn't repeat its leading content.
Per-page restarting has document-wide scope. Enabling restartEachPage on any Layout footer restarts all page footers and uses the first Layout's footnote counter style. Use consistent settings across Layouts.

For footer placement, chapter endnotes, and styling examples, see the Footnotes and endnotes guide.

Was this page helpful?