Examples Cookbook

ProtoML already ships runnable examples. This guide explains which workflow each one demonstrates.

Simple meeting protocol

Use a small document with @participants, @subjects, @tasks, and @meeting as the best starting point for weekly syncs and team notes.

This is the minimal pattern that already shows ProtoML's value: structured data at the top, readable narrative below, and references between them.

Shared tags across files

protoparser tags "examples/feature-suite/_workflow_tags.pml" statistics

Use this pattern when multiple meeting files should report against the same workflow vocabulary.

Content imports

The feature suite demonstrates both imported .pml and imported .html.

Choose this when standard sections, appendices, or maintained snippets should live outside the main file.

Macros

Macros are the right example path when repeated presentation blocks start appearing in many documents. Explore bundled macros first, then move to registry-based packs only when sharing really matters.

Analysis and statistics

protoparser analyze "examples/feature-suite/main_demo.pml" statistics
protoparser analyze "examples/feature-suite/main_demo.pml" graph
protoparser register "examples/feature-suite" statistics

These commands are what turn example documents into something you can inspect operationally, not just render visually.

Recommended example path

Start with examples/feature-suite/main_demo.pml
Render it to HTML
Run tag analysis on _workflow_tags.pml
Run analyze ... statistics
Explore bundled macros with --listMacros "{{macro_dir}}"
Explore the external macro registry example in examples/macro-registry-suite/