Schemas / Layout

rig.layout.master

v1.0.0 · stable maturity: stable 1 field 0 required

Fields

FieldTypeMeaning
side enumleft · right · single optional Optional. left, right, or single. Absent = single

Marks a rig.layout.page entity as a master page. Format when present.

Document pages apply a master via rig.layout.applied_master. Facing books typically keep a left and a right master; singles use side single.

Master content (headers, folios, frames) parents to the master page the same way as any page. Instantiation onto document pages is fulfillment.

Chrome text frames

A master child that carries both a rig.story.flow and a box is page chrome (folio, running header): hosts stamp it onto every page that applies the master, resolving {{page}} / {{pageCount}} / {{title}} / {{section}} tokens in the paragraph text per page. The flow's rig.layout.paragraph_style owns the type - size, alignment within the frame, paint, and alignToBaselineGrid - so chrome is document data, not host configuration. Each paragraph sets a single line; chrome does not wrap or overflow.

JSON Schema

Resolves at https://rig.works/schemas/rig.layout.master.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.layout.master.schema.json",
  "title": "rig.layout.master",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "side": {
      "type": "string",
      "enum": [
        "left",
        "right",
        "single"
      ]
    }
  },
  "x-rig-maturity": "stable"
}

Seen in

story-frames.json