DocsObject referenceView source

Purpose

Inline purpose metadata for the presentation. Use 'id' to reference a purposes catalog record and override selected fields, or use 'name' for a custom inline purpose.

Metadata

Definition: #/$defs/Purpose
Type: object | object
Source: spec/schemas/opf.schema.json

Field index

Field	Type	Req.	Description
id	string	—	Optional purposes catalog id to resolve before applying inline overrides.
name	string	—	Human-readable purpose name shown in pickers.
summary	string	—	One-sentence positioning of the purpose.
description	string	—	Longer prose describing when to use this purpose and how it should shape a deck.
outcome	string	—	Desired audience outcome after the presentation.
successCriteria	array<string>	—	Observable signals that the deck accomplished this purpose.
recommendedNarratives	array<string>	—	Soft cross-link: narrative-catalog ids that work well for this purpose.
recommendedTones	array<string>	—	Soft cross-link: tone-catalog ids that work well for this purpose.
tags	array<string>	—	Free-form labels for filtering and search.

`id`

typestringrequirednodefault—pattern^[a-z][a-z0-9-]*$

Optional purposes catalog id to resolve before applying inline overrides.

id.json

{
  "id": "inform"
}

`name`

typestringrequirednodefault—

Human-readable purpose name shown in pickers.

name.json

{
  "name": "name-value"
}

`summary`

typestringrequirednodefault—

One-sentence positioning of the purpose.

summary.json

{
  "summary": "summary-value"
}

`description`

typestringrequirednodefault—

Longer prose describing when to use this purpose and how it should shape a deck.

description.json

{
  "description": "description-value"
}

`outcome`

typestringrequirednodefault—

Desired audience outcome after the presentation.

outcome.json

{
  "outcome": "outcome-value"
}

`successCriteria`

typearray<string>requirednodefault—

Observable signals that the deck accomplished this purpose.

successCriteria.json

{
  "successCriteria": []
}

`recommendedNarratives`

typearray<string>requirednodefault—

Soft cross-link: narrative-catalog ids that work well for this purpose.

recommendedNarratives.json

{
  "recommendedNarratives": []
}

`recommendedTones`

typearray<string>requirednodefault—

Soft cross-link: tone-catalog ids that work well for this purpose.

recommendedTones.json

{
  "recommendedTones": []
}

`tags`

typearray<string>requirednodefault—

Free-form labels for filtering and search.

tags.json

{
  "tags": []
}