Contents
  1. Downloads
  2. Preface
  3. Part I Writing
  4. 1 Quickstart
  5. 2 Writing in Markdown
  6. 3 Authoring in Hiccup
  7. Part II Configuration and Theming
  8. 4 Configuring the Book
  9. 5 Theming and Editions
  10. 6 Commands
  11. Part III Producing and Publishing
  12. 7 Producing a Book
  13. Structure lives in book.edn
  14. 8 Editions
  15. 9 Distributing Your Book
  16. 10 How It Works
  17. A Error Catalog
  18. B Clojure for Authors
  19. C A Chapter Written in Code
  20. A table the book writes for itself
  21. Documentation that cannot drift
  22. Down to a single formatting object
  23. When to reach for code
  24. Glossary
  25. List of Figures
  26. List of Tables
  27. List of Listings
  28. Bibliography
  29. Index
  30. Search

Glossary

Key terms used throughout this manual, each with a pointer to the chapter that treats it in full. The index that follows locates every occurrence; this page is for finding the right concept first.

Admonition
A called-out note, tip, or warning set off from the running text. See Chapter 2.
Appendix
A lettered section after the body chapters. See Chapter 7.
Attribute
A named value declared once in book.edn and referenced from any chapter. See Chapter 2.
Author Hiccup
The shared data vocabulary both front ends produce: markup written as plain vectors, maps, and strings. See Chapter 3.
Canon margins
Page margins derived from the trim in the classical 2:3:4:6 proportion. See Chapter 5.
Conditional content
A block kept or dropped per edition or per declared attribute. See Chapter 2.
Cross-reference
A link to an id that renders as a page number on paper and a hyperlink on screen. See Chapter 7.
Data table
A table whose rows come from a CSV, TSV, or EDN file rather than the manuscript. See Chapter 2.
Determinism
The guarantee that the same manuscript and theme produce identical output, byte for byte where the format allows. See Chapter 10.
Directive
A Markdown block extension written as :::name with an EDN attribute map. See Chapter 2.
Edition
One deliverable form of the book: screen PDF, print PDF, PDF/X, site, or EPUB. See Chapter 8.
Escape hatch
A per-format opening below the portable vocabulary: raw FO for paged output, raw HTML for the web, and their styling counterparts in the theme. See Chapter 3.
Float
A numbered figure, table, or listing that cross-references and collects into a generated list. See Chapter 7.
Folio
The page number in a page's running furniture. See Chapter 7.
Front end
A chapter input format: Markdown read as data, or a Clojure file evaluated to author Hiccup. See Chapter 2.
Front matter
Named sections before the body, numbered in roman. See Chapter 7.
Island
A small optional script compiled on demand for one site affordance; every page works without it. See Chapter 5.
Manuscript
The book's source as data: book.edn plus the chapter files it names. See Chapter 4.
Matter
A front or back section outside the numbered chapter run, such as a preface or this glossary. See Chapter 7.
PDF/X
A press-submission PDF profile: embedded fonts, an ICC output intent, and no interactive features. See Chapter 8.
Part
A roman-numbered group of chapters with its own divider page. See Chapter 7.
Recto
A right-hand page; chapters can be made to open on one. See Chapter 7.
Running head
The line atop a page naming the current chapter or section, set in letterspaced capitals. See Chapter 7.
Slug
The book's directory name under the build output, set by book.edn. See Chapter 4.
Smart punctuation
The build-time pass that turns typewriter quotes, dashes, and ellipses into their typographic forms. See Chapter 2.
Theme token
One named design decision in theme.edn, compiled into FO properties and CSS alike. See Chapter 5.
Trim
The page size of the paged editions, named in the theme. See Chapter 5.
Validation
The opt-in pass that evaluates marked code blocks and fails the build when one breaks. Each block is dispatched by language through the evaluator registry, where new language evaluators are registered. See Chapter 2.
Verso
A left-hand page; an inserted blank verso stays completely empty. See Chapter 7.