page.corvus.document

corvus.page

Documentation

A collection of text formatted document blocks

main object

A collection of text formatted document blocks

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "A collection of text formatted document blocks",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "children": {
      "description": "The children of the document, turning this into a folder tree",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    },
    "content": {
      "description": "The block containing the content of the document",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "icon": {
      "description": "The icon of the document",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "title": {
      "description": "The title of the document",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
blockDisplay object

A block display

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "A block display",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "children": {
      "description": "The child block id to display vertically",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
blockFootnoteReference object

A footnote reference to a block

Properties

blockId string at-uri Required

The URI of the block that contains the footnote reference

View raw schema 
{
  "description": "A footnote reference to a block",
  "properties": {
    "blockId": {
      "description": "The URI of the block that contains the footnote reference",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
blockQuote object

A block quote block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "A block quote block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "facets": {
      "description": "The facets applied to the text",
      "ref": "page.corvus.core#set",
      "type": "ref"
    },
    "fontSize": {
      "description": "The font size of the text",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "fontWeight": {
      "description": "The font weight of the text",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "text": {
      "description": "The text content of the block quote",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
footnote object

A footnote block

Properties

blockId string at-uri Required

The AT-URI of this block record

from ref page.corvus.core#set Optional

The set of footnote references, one of #blockFootnoteReference, #sequenceFootnoteReference, #registerFootnoteReference or #orSetFootnoteReference

View raw schema 
{
  "description": "A footnote block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "content": {
      "description": "A block id of the footnote content",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "from": {
      "description": "The set of footnote references, one of #blockFootnoteReference, #sequenceFootnoteReference, #registerFootnoteReference or #orSetFootnoteReference",
      "ref": "page.corvus.core#set",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
heading object

A heading block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "A heading block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "level": {
      "description": "The level of the heading - defaults to 1",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "text": {
      "description": "The text content of the heading",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
horizontalRule object

A horizontal rule block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "A horizontal rule block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
inlineDisplay object

An inline display

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "An inline display",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "children": {
      "description": "The child block id to display inline",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
orSetFootnoteReference object

A footnote reference to an OR-set

Properties

blockId string at-uri Required

The URI of the block that contains the footnote reference

orSet string Required

The or set of the footnote reference

valueOp string Required

The operation id of the referenced value

View raw schema 
{
  "description": "A footnote reference to an OR-set",
  "properties": {
    "blockId": {
      "description": "The URI of the block that contains the footnote reference",
      "format": "at-uri",
      "type": "string"
    },
    "orSet": {
      "description": "The or set of the footnote reference",
      "type": "string"
    },
    "valueOp": {
      "description": "The operation id of the referenced value",
      "type": "string"
    }
  },
  "required": [
    "blockId",
    "orSet",
    "valueOp"
  ],
  "type": "object"
}
orderedList object

An ordered list block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "An ordered list block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "children": {
      "description": "The children of the list",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    },
    "listStyle": {
      "description": "The style of the list - defaults to 'decimal'",
      "ref": "page.corvus.core#register",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
prose object

A prose document block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "A prose document block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "facets": {
      "description": "The facets applied to the text",
      "ref": "page.corvus.core#set",
      "type": "ref"
    },
    "fontSize": {
      "description": "The font size of the text",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "fontWeight": {
      "description": "The font weight of the text",
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "text": {
      "description": "The text content of the paragraph",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
registerFootnoteReference object

A footnote reference to a register

Properties

blockId string at-uri Required

The URI of the block that contains the footnote reference

register string Required

The register of the footnote reference

valueOp string Required

The operation id of the referenced value

View raw schema 
{
  "description": "A footnote reference to a register",
  "properties": {
    "blockId": {
      "description": "The URI of the block that contains the footnote reference",
      "format": "at-uri",
      "type": "string"
    },
    "register": {
      "description": "The register of the footnote reference",
      "type": "string"
    },
    "valueOp": {
      "description": "The operation id of the referenced value",
      "type": "string"
    }
  },
  "required": [
    "blockId",
    "register",
    "valueOp"
  ],
  "type": "object"
}
sequenceFootnoteReference object

A footnote reference to a sequence

Properties

atomEnd string Required

The end atom id of the facet (inclusive) - formatted as `operationId.atomIdx`

atomStart string Required

The start atom id of the facet (inclusive) - formatted as `operationId.atomIdx`

blockId string at-uri Required

The URI of the block that contains the footnote reference

sequence string Required

The sequence of the footnote reference

View raw schema 
{
  "description": "A footnote reference to a sequence",
  "properties": {
    "atomEnd": {
      "description": "The end atom id of the facet (inclusive) - formatted as `operationId.atomIdx`",
      "type": "string"
    },
    "atomStart": {
      "description": "The start atom id of the facet (inclusive) - formatted as `operationId.atomIdx`",
      "type": "string"
    },
    "blockId": {
      "description": "The URI of the block that contains the footnote reference",
      "format": "at-uri",
      "type": "string"
    },
    "sequence": {
      "description": "The sequence of the footnote reference",
      "type": "string"
    }
  },
  "required": [
    "blockId",
    "sequence",
    "atomStart",
    "atomEnd"
  ],
  "type": "object"
}
tableOfContents object

A table of contents block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "A table of contents block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "maxDepth": {
      "description": "The maximum depth of the table of contents - defaults to 6",
      "ref": "page.corvus.core#register",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}
unorderedList object

An unordered list block

Properties

blockId string at-uri Required

The AT-URI of this block record

View raw schema 
{
  "description": "An unordered list block",
  "properties": {
    "blockId": {
      "description": "The AT-URI of this block record",
      "format": "at-uri",
      "type": "string"
    },
    "children": {
      "description": "The children of the list",
      "ref": "page.corvus.core#sequence",
      "type": "ref"
    },
    "listStyle": {
      "description": "The style of the list - defaults to 'bullet'",
      "ref": "page.corvus.core#register",
      "type": "ref"
    }
  },
  "required": [
    "blockId"
  ],
  "type": "object"
}

Lexicon Garden

@