{}OPF
DocsSchema referenceView source

Layout Preview Index

Shape of spec/previews/layouts/index.json, the manifest for the vendored slide-archetype preview gallery under spec/previews/layouts/. Each record names a preview id, its self-contained HTML file, and the file…

Schema $id

https://openpresentation.org/schema/opf-layout-preview-index/v1

Source

spec/schemas/layout-preview-index.schema.json

Field index

FieldTypeReqDefaultDescription
$schemaconstyes
versionstringyesIndex format version, as a string.
descriptionstringyesHuman-readable description of the preview gallery and its rendering conventions.
recordsarray<ref:PreviewRecord>yesOne entry per vendored preview HTML file.

$schema

Type: const · Required · Default:

$schema.json
{
  "$schema": "https://openpresentation.org/schema/opf-layout-preview-index/v1"
}

version

Type: string · Required · Default:

Index format version, as a string.

version.json
{
  "version": "1"
}

description

Type: string · Required · Default:

Human-readable description of the preview gallery and its rendering conventions.

description.json
{
  "description": "description-value"
}

records

Type: array<ref:PreviewRecord> · Required · Default:

One entry per vendored preview HTML file.

records.json
{
  "records": []
}