The guides for v2.4.1

Start here

• Your first document

  The five-minute path from an empty project to a rendered PDF.

• Getting started

  Composing with the DSL or filling a template, a first render walked through, and how to choose between them.

• Capabilities

  Every feature at a glance, with its stability tier and the guide that covers it.

• Troubleshooting

  Symptom-first fixes: stray ? glyphs, content Word leaves out, a missing optional dependency.

Templates

• Templates overview

  All six shipped families, the data each one takes, and which guide to open next.

• Templates quickstart

  Five minutes: how the layered templates are built, and a working example that renders a CV.

• Business templates

  Invoices and proposals rendered from data, end to end.

• Authoring a preset

  A CV style of your own, composed from the shipped widgets without subclassing.

• Adding a template family

  A new kind of document, from its data model to its presets and tests.

Building a document

• Recipes

  Text, lists, tables, charts, images, barcodes, layout, headers and footers, links and bookmarks: where each one fits.

Output formats

• Backend capability matrix

  What PDF, PowerPoint and Word each support, capability by capability.

• PowerPoint backend

  graph-compose-render-pptx, in Beta: an editable deck from the same session that prints the PDF.

• Word backend

  graph-compose-render-docx: a semantic Word export, with partial coverage and no PDF parity.

Testing and production

• Testing your document

  Smoke tests, layout snapshots and visual diffs that keep a document from changing unnoticed.

• Production rendering

  Rendering on a server: streaming, concurrency and failure handling.

Versions and upgrades

• API stability

  The stability tier of each package, and what each tier promises.

• Migrating to 2.0

  The 1.x to 2.x module split and the API changes that came with it; the changelog holds the full list.

• Changelog

  The notable changes, release by release.

Changing GraphCompose itself

Not needed to write a document.

• Architecture overview

  The engine, the DSL, the templates and the backends, and how they fit together.

• Extension guide

  Add a semantic node, a builder setter, a render handler or a whole backend, without reaching into the engine.