Build an endnotes/footnotes section

build-notes

The "build-notes" pragma is used to instruct the BLUE PROCESSOR to build an Endnotes or Footnotes back-matter section from manuscript notemarks.

Syntax

The syntax for the build-notes pragma consists of:

  • An exclamation point !
  • The keyword build-notes
  • A coalescer (optional), specified using a full-stop . followed by a notemark coalescer.
  • An format attribute, (endnotes, footnotes) to specify the format of the marker for the note.
  • A junctors attribute, (yes or no), to specify whether or not hyperlinks should be created from the built notes to the body-matter location where they refer.
!build-notes .coalescer *format=endnotes|footnotes *junctors=yes|no
build-notes pragma syntax

If a coalescer is specified, the builder will only include notemarks which specify that coalescer.

The default value for the junctors attribute is yes, which instructs the builder to create hyperlinks from the built notes to the body-matter location where they refer. But regardless of the junctors setting, each notemark occurance in the body-matter will always be hyperlinked to the corresponding entry in the endnotes/footnotes section built by the processor.

Examples

Here is what a build-notes pragma looks like within the body of a manuscript.

section {
This journal**.chap1 Gibson presented his journal
to the Missouri Historical Society in 1873.**
is published here for the first time.

A general order**.chap1 Order No. 13, Aug. 17, 1846.**
was read at the head of the company.

div {
h1 Chapter 1 Endnotes
!build-notes .chap1 *format=endnotes *junctors=yes
}
}

. . .

section {
In 1846 hostilities broke out on the Texas
frontier.**.chap2 The United States made no formal
declaration of war on Mexico**

A general order**.chap2 Order No. 13, Aug. 17, 1846.**
was read at the head of the company.

div {
h1 Chapter2 Footnotes
!build-notes .chap2 *format=footnotes *junctors=no
}
}
Sample build-notes pragma

And here is the output created by the builder:

<section>
<p>This journal<mark id=nt20 class='chap1'>
<a href='#nt24'>1</a></mark>
is published here for the first time.</p>

<p>A general order<mark id=nt21 class='chap1'>
<a href='#nt25'>2</a></mark>
was read at the head of the company.</p>

<div>
<h1>Chapter 1 Endnotes</h1>
<ol class='chap1'>
<li id=nt24 class='p'><sup><a href='#nt20'>1</a></sup>
<small>Gibson presented his journal
to the Missouri Historical Society in 1873.</small></li>
<li id=nt25 class='p'><sup><a href='#nt21'>2</a></sup>
<small>Order No. 13, Aug. 17, 1846.</small></li>
</ol>
</div>
</section>

. . .

<section>
<p>In 1846 hostilities broke out on the Texas
frontier.<mark id=nt22 class='chap2'>
<a href='#nt26'>*</a></mark></p>

<p>A general order<mark id=nt23 class='chap2'>
<a href='#nt27'>†</a></mark>
was read at the head of the company.</p>

<div>
<h1>Chapter 2 Footnotes</h1>
<ul class='chap2'>
<li id=nt26 class='p'><sup>*</sup>
<small>The United States made no formal
declaration of war on Mexico</small></li>
<li id=nt27 class='p'><sup>†</sup>
<small>Order No. 13, Aug. 17, 1846.</small></li>
</ul>
</div>
</section>
Sample build-notes output
0

syntax > pragmas > build-notesBuild an endnotes/footnotes section

🔗 🔎