Overview
The document module supplies SCons builders for maintained TeX content. This guide describes version 1.1.0.
Main capabilities
- Build several PDF editions from shared sources.
- Keep content, output metadata and style selection separate.
- Generate review editions and structured books.
- Rebuild affected outputs when content or definitions change.
Builders
Choose the structure of each output
| Builder | Default target | Use |
|---|---|---|
Article() | paper.pdf | Papers, reports, and article-style documents |
Slides() | slides.pdf | Presentation slides, including standard and widescreen layouts |
Book() | book.pdf | Books with chapters, parts, front matter, appendices, and back matter |
Diary() | note.pdf | Date-organized notes read from a source directory |
Article, Slides, and Book accept the common arguments target, source, option, title, subtitle, proceedings, maketitle, author, institute, email, address, date, package, bib, and preamble.
Article and Slides enable maketitle=True by default. Supply a title, or set maketitle=False for title-free output. A title declared inside the content file is too late for the automatic title block. Book always generates its title page in version 1.1.0, so provide its title explicitly.
Quick example
from document import *
Slides('results.pdf', 'slides.tex',
title='Experiment results', option='16x9')Create slides.tex with your presentation content, then run scons to generate results.pdf. Start with the product quick start for a complete first document.
Requirements and further reading
Install the package's TeX dependencies and SCons, and activate Document Automation. Keep source content compatible with the selected output structure. Supplied publisher styles should be checked against current submission requirements.
The builder reference covers source forms, book structure, options, metadata and style names. It describes the current API; generated Program version selectors do not version this guide.