DocsObject referenceView source

Tone

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

Metadata

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

Field index

Field	Type	Req.	Description
id	string	—	Optional tones catalog id to resolve before applying inline overrides.
name	string	—	Human-readable tone name shown in pickers.
summary	string	—	One-sentence positioning of the tone.
description	string	—	Longer prose describing the tone and the kinds of decks it suits.
voiceCues	array<string>	—	Short directives that shape AI generation toward this tone.
avoid	array<string>	—	Anti-patterns that AI generation should not produce when this tone is active.
samplePhrases	array<string>	—	Short example phrases that exemplify this tone.
recommendedNarratives	array<string>	—	Soft cross-link: narrative-catalog ids this tone pairs well with.
tags	array<string>	—	Free-form labels for filtering and search.

`id`

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

Optional tones catalog id to resolve before applying inline overrides.

id.json

{
  "id": "formal"
}

`name`

typestringrequirednodefault—

Human-readable tone name shown in pickers.

name.json

{
  "name": "name-value"
}

`summary`

typestringrequirednodefault—

One-sentence positioning of the tone.

summary.json

{
  "summary": "summary-value"
}

`description`

typestringrequirednodefault—

Longer prose describing the tone and the kinds of decks it suits.

description.json

{
  "description": "description-value"
}