`rig.layout.section`

v0.31.0 · draft 5 fields 0 required

Fields

Field	Type		Meaning
`name`	string	optional	Optional. Section title; running-header variables may show it. Not the page's display name (`rig.meta.named`)
`numberingStyle`	enumarabic · roman · roman-upper · alpha · alpha-upper	optional	Optional. `arabic`, `roman`, `roman-upper`, `alpha`, `alpha-upper` (enum literals stay kebab-case). Absent = `arabic`
`startAt`	int	optional	Optional. First page number of the section. Absent = `1`
`prefix`	string	optional	Optional. Emitted before the number (`A-` → `A-1`, `A-2`)
`startSide`	enumany · recto · verso	optional	Optional. `any`, `recto`, `verso` - declared side the section opens on; a host may insert a blank page to honour it. Such a pad carries `rig.layout.applied_master` with no `master` - deliberately chrome-free. Absent = `any`

A numbering section start. Format when present.

Compose on a rig.layout.page that is not a master. The section runs from that page until the next page carrying its own rig.layout.section. Folio variables on stamped master items resolve against the innermost section: page number = startAt + pages since the section start, rendered in numberingStyle with prefix in front. Pages before the first section fall back to the host's plain sequence.

Front matter in roman then a body restarting at 1 is two sections: {numberingStyle: "roman"} on the first page, {startAt: 1} on the first body page.

JSON Schema

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.layout.section.schema.json",
  "title": "rig.layout.section",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "numberingStyle": {
      "type": "string",
      "enum": [
        "arabic",
        "roman",
        "roman-upper",
        "alpha",
        "alpha-upper"
      ]
    },
    "startAt": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "prefix": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "startSide": {
      "type": "string",
      "enum": [
        "any",
        "recto",
        "verso"
      ]
    }
  }
}