Build a table of contents
build-list
The "build-list" pragma is used to instruct the BLUE PROCESSOR to build a Table of Contents or List of Figures from manuscript listmarks.
Syntax
The syntax for the build-list
pragma consists of:
- An exclamation point !
- The keyword build-list
- A
coalescer
(optional), specified using a full-stop . followed by a listmark coalescer. - An
order
attribute, (sequential
,alpha
,numeric
) to identify how the list entries should be ordered. - A
junctors
attribute, (yes
orno
), to specify whether or not hyperlinks should be created from the section headers in the body-matter back to the entries in the built Table of Contents.
If a coalescer is specified, the builder will only include listmarks which specify that coalescer.
The default value for the junctors
attribute is yes
, which instructs the builder to create backlinks from the section headers in the body-matter back to the entries in the built Table of Contents. But regardless of the junctors
setting, each listmark occurance in the front-matter will always be hyperlinked to the corresponding header section in the body-matter of the final document.
Examples
Here is what a build-list
pragma looks like within the body of a manuscript.
And here is the output created by the builder: