Schemas / Layout
rig.layout.frame_chain
v0.31.0 · draft 3 fields 1 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
story |
entity | required | rig.story.flow being threaded |
frames |
array<entity> | optional | Optional. rig.layout.frame entities in flow order |
master |
entity | optional | Optional. rig.layout.master used when auto-adding pages |
Ordered rig.layout.frame entities a rig.story.flow flows through. Format when present.
When frames fill, a host may append pages from master and add frames. Absent chain = the flow's parent page (or a single frame the host invents from page margins). A page in frames is that fallback, not a substitute for authored frames.
Do not store overflow text here - that is fulfillment state. Previous/next pointers are this array, not fields on the frame.
JSON Schema
Resolves at https://rig.works/schemas/rig.layout.frame_chain.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.layout.frame_chain.schema.json",
"title": "rig.layout.frame_chain",
"type": "object",
"additionalProperties": false,
"properties": {
"story": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"frames": {
"type": "array",
"items": {
"$ref": "./_defs.schema.json#/$defs/entity"
}
},
"master": {
"$ref": "./_defs.schema.json#/$defs/entity"
}
},
"required": [
"story"
]
}