typst.h File Reference

#include "sen/core/base/compiler_macros.h"
#include "sen/core/lang/stl_resolver.h"
#include <filesystem>
#include <map>
#include <memory>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	sen::gen::TypstOptions
	What the document contains and how it is put together. Every field defaults to the whole model and the standard sections, so a default-constructed value produces a complete document and a caller who wants that need know none of this. More...
class	sen::gen::TypstGenerator
	Renders a Sen data model as a Typst document, in the shape of an interface control document. Writes Typst source; producing a PDF is a separate step, as with PlantUML. More...

Namespaces
namespace	sen
namespace	sen::gen

---

Class Documentation

sen::gen::TypstOptions

struct sen::gen::TypstOptions

What the document contains and how it is put together. Every field defaults to the whole model and the standard sections, so a default-constructed value produces a complete document and a caller who wants that need know none of this.

Class Members
string	title {"Data model"}	Shown on the title page and in the running header.
vector< string >	includePackages	Packages to document. Empty means every package in the model.
vector< string >	excludePackages	Packages to leave out, applied after includePackages.
bool	overview {true}	The overview: the package table and the class hierarchy across all packages.
bool	hierarchy {true}	The class hierarchy within the overview. Emitted only where classes inherit.
bool	summaries {true}	The per-section table of every type with its description and page.
bool	index {true}	The alphabetical index of every type, at the back.
bool	usedBy {true}	The "used by" line on each type.
bool	flagLegend {true}	What the codes in the Flags column mean, before the first table that uses them.
bool	builtIns {true}	The table of the built-in types the model names, at the back.
path	frontMatter	Typst files the document includes at named points. The generator never reads them: it emits #include and the paths resolve when the document is compiled.
path	beforeReference
path	afterReference
path	style	Replaces the emitted style.typ. Every visual decision lives in that module, so a caller changing the look never edits generated output.