document.layout is an optional block that tells renderers how to present the document. Everything here is informational — viewers may honour, partially honour, or ignore it.
Shape
ribbon
Repeating header / footer content.
| Field | Type | Required | Description |
|---|---|---|---|
cover | boolean | ✓ | Show on the cover page. |
show | boolean | ✓ | Visibility toggle. |
text | text | ✓ | Ribbon text. |
start | integer ≥0 | — | First page the ribbon appears on. Default 0. |
omit | integer[] unique | — | Pages to skip. |
meta | meta | — | Extension. |
status
Industry revision status.
| Field | Type | Required | Values |
|---|---|---|---|
color | enum | ✓ | white, blue, pink, yellow, green, goldenrod, buff, salmon, cherry. |
round | integer ≥1 | ✓ | Revision round. Default 1. |
updated | datetime | ✓ | ISO 8601. |
style
A reusable presentation-style fragment.
| Field | Type | Required | Description |
|---|---|---|---|
id | slug | ✓ | Referenced by element.styles[]. |
default | boolean | ✓ | Whether renderers should apply automatically. |
text | string (0–5000) | ✓ | Renderer-specific style payload. |
meta | meta | — | Extension. |
template
A longer reusable fragment, size-limited separately.
| Field | Type | Required |
|---|---|---|
id | slug | ✓ |
default | boolean | ✓ |
text | string (0–20,000) | ✓ |
meta | meta | — |