Document (Nao)

Document Type

Namespace: Nao.Documents
Assembly: Nao.Documents.dll
Base Type: obj
All Interfaces: IEquatable<Document> , IStructuralEquatable , IComparable<Document> , IComparable , IStructuralComparable

The unified intermediate representation (the "middleware" format). Every concrete file format converts to and from this single model, so the converter only needs an A→`Document` reader and a `Document`→B writer for each format, and any A→B conversion is `read >> write`.

Record fields

Record Field	Description
`Body` Full Usage: `Body` Field type: `Body`	The content, either fluid or paginated. Field type: `Body`
`DefaultPage` Full Usage: `DefaultPage` Field type: `PageSetup option`	Page setup a paginated target should use when the source was fluid. Field type: `PageSetup option`
`Metadata` Full Usage: `Metadata` Field type: `DocumentMetadata`	Field type: `DocumentMetadata`
`Resources` Full Usage: `Resources` Field type: `Resource list`	Extracted media / binary assets, referenced by id from the body. Field type: `Resource list`
`Schema` Full Usage: `Schema` Field type: `string`	Schema/version marker so consumers can evolve the model safely. Field type: `string`

Static members

Static member	Description
`Document.CurrentSchema` Full Usage: `Document.CurrentSchema` Returns: `string`	Current schema identifier. Returns: `string`
`Document.Empty` Full Usage: `Document.Empty` Returns: `Document`	An empty fluid document. Returns: `Document`
`Document.OfBlocks(blocks)` Full Usage: `Document.OfBlocks(blocks)` Parameters: blocks : `Block list` Returns: `Document`	A fluid document from a list of blocks. blocks : `Block list` Returns: `Document`
`Document.OfPages(pages)` Full Usage: `Document.OfPages(pages)` Parameters: pages : `Page list` Returns: `Document`	A paginated document from a list of pages. pages : `Page list` Returns: `Document`