A complete example roadbook that demonstrates meta blocks, stages, entries, and extensions. Use it as a template or test fixture: validate it against the published JSON Schema and adapt the structure for your event.
The `meta` block declares format, version, units, and event-level details. Keep these fields accurate: tools use them for validation, unit interpretation, and rendering.
meta.id — orb-demo, unique identifier for the document.meta.title — Human readable “Montseny i Guilleries”.meta.units — Distance in kilometres, headings in degrees, speed in km/h. Explicit units
avoid ambiguity when tools interpret the data.meta.extensions — Sample blocks (corbs.render, orb.analytics) illustrate how partner
tooling embeds previews and computed metrics.A stage contains an ordered trunk of instructions (entries). Each entry references a symbol ID, a cumulative distance, and optional fields such as heading, waypoint coordinates, or tags. Branches or alternatives reuse the same entry shape and can be named and rejoined.
distance values with ISO-8601 time_stage.roundabout.exit_2, junction.turn_left, etc.).road.current and road.next.[cyclists] and [photo] for downstream tooling.The skip_guilleries branch demonstrates how to deviate from the trunk and rejoin later,
reusing the same instruction structure. Branches can be referenced via alternatives
arrays on trunk instructions.
Each location supports coordinates, Plus Codes, and What3Words references. The demo mixes named POIs (e.g., Coll de Sant Marçal) with raw coordinates to show both options.
Use the published JSON Schema to check conformance before sharing. The schema is resolver-friendly (it includes a `$id`) and versioned snapshots are available for pinning builds. Validation catches type errors, out-of-range values, and unknown symbol IDs.
npx ajv validate \
-s https://openroadbook.com/schemas/orb.schema.json \
-d demo.orb.yaml --spec=draft2020
Substitute demo.orb.yaml with your own files to check conformance. Validation ensures
headings stay within 0–359, distances are non-negative, and symbols point to known registry IDs.
Copy the demo as a starting point when authoring new stages. Edit `meta` and `entries`, run schema validation, and publish the resulting file alongside any custom extensions or renderer settings.