Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Samples

Canonical V1 Envelope

The canonical V1 envelope example shows the current document hierarchy, document-wide <data>, identified frames, and default per-frame SVG output.

The cross-frame page-link example demonstrates local page stubs, to <frame ID> / from <frame ID> labels, and multi-page render commands. Detailed anchor rules live in the Arrow Reference.

Frame Metadata Tags

The frame metadata example shows built-in id/title/content-version tags, custom entries, top/bottom placement, and page links that route around metadata reservations. Detailed metadata rules live in the Frame Reference.

Hybrid Enterprise Architecture

This sample combines the larger network-routing showcase with canonical V1 page metadata. Its frame declares a stable id, visible title, and content version, so the built-in metadata band reserves its edge strip while the existing route/traffic lanes, line jumps, junctions, and manual bends continue to use the shared routing pipeline.

Source: docs/src/examples/samples/complex-hybrid-architecture.xal

xaligo render docs/src/examples/samples/complex-hybrid-architecture.xal \
  --format svg \
  --mode network \
  -o output/complex-hybrid-architecture.svg

Structural Diff

This pair demonstrates a title update, an element moved between groups, a removed legacy store, an added cache, and changed connections. The comparison uses parsed .xal structure rather than text lines.

Removed and previous values

Added and current values

Sources:

xaligo diff \
  docs/src/examples/samples/diff-before.xal \
  docs/src/examples/samples/diff-after.xal \
  -o docs/src/images/diff-sample

The command reports +2 -2 ~3: two added branches, two removed branches, and three modified or moved elements. The old SVG uses pale red and the new SVG uses pale green; unchanged elements retain their normal styling.

Isoflow Export

Use the same .xal source to generate an Isoflow-compatible model:

xaligo render docs/src/examples/samples/complex-hybrid-architecture.xal \
  --format isoflow \
  --mode network \
  -o output/complex-hybrid-architecture.isoflow.json

Route and Traffic Separation

Use kind="route" for structural paths without arrowheads, then add kind="traffic" connections over the same endpoints for directional flows. Traffic lines are drawn beside the matching route lane when possible.

Source: docs/src/examples/samples/route-traffic.xal

xaligo render docs/src/examples/samples/route-traffic.xal \
  --format svg \
  --mode network \
  -o output/route-traffic.svg

Generated AWS Hierarchy

Generate a starter AWS hierarchy and render it:

xaligo generate xal --clouds 1 --accounts 1 --regions 2 --azs 2 \
  --az-layout staggered --subnets 2 --spacing both --start top \
  --paper A4 --orientation landscape -o output/infra.xal

xaligo render output/infra.xal \
  --format excalidraw \
  -o output/infra.excalidraw \
  --services docs/src/examples/samples/services.csv