Module

Document

Editorial and paginated visual layout, page sections, figures, notes and pagination.

Raw schema: /schema/1.0/modules/document.schema.json

section

type: object · required: id

PropertyTypeRequiredConstraints
id id yes —
title string no minLength 1
nodeRefs array<id> no —
columns integer no min 1
columnGap dimension no —
breakBefore "auto" | "page" | "column" | "odd" | "even" no —
keepTogether boolean no —

note

type: object · required: id, text, kind

PropertyTypeRequiredConstraints
id id yes —
anchorRef id no —
text string yes minLength 1
kind "footnote" | "endnote" | "caption" yes —
nodeRef id no —

page

type: object · required: id, sceneRef

PropertyTypeRequiredConstraints
id id yes —
sceneRef id yes —
size object no —
margin insets no —
bleed size no —
headerRef id no —
footerRef id no —
sections array<section> no —
notes array<note> no —
number integer no min 1
extensions extensions no —

document

type: object · required: id, pages

PropertyTypeRequiredConstraints
id id yes —
title string no minLength 1
pages array<page> yes minItems 1
pagination object no —
binding "left" | "right" | "top" | "none" no —
widows integer no min 1
orphans integer no min 1
extensions extensions no —