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
Type: object
Source: spec/schemas/layout-preview-index.schema.json
Fields: 4 · 4 required

Field index

Field	Type	Req.	Default	Description
$schema	const	yes	—
version	string	yes	—	Index format version, as a string.
description	string	yes	—	Human-readable description of the preview gallery and its rendering conventions.
records	array<ref:PreviewRecord>	yes	—	One entry per vendored preview HTML file.

`$schema`

typeconstrequiredyesdefault—

$schema.json

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

`version`

typestringrequiredyesdefault—

Index format version, as a string.

version.json

{
  "version": "1"
}

`description`

typestringrequiredyesdefault—

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

description.json

{
  "description": "description-value"
}

`records`

typearray<ref:PreviewRecord>requiredyesdefault—

One entry per vendored preview HTML file.

records.json

{
  "records": []
}