{}OPF
DocsObject referenceEdit on GitHub

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

Fields

FieldTypeReqDescription
idstringOptional tones catalog id to resolve before applying inline overrides.
namestringHuman-readable tone name shown in pickers.
summarystringOne-sentence positioning of the tone.
descriptionstringLonger prose describing the tone and the kinds of decks it suits.
voiceCuesarray<string>Short directives that shape AI generation toward this tone.
avoidarray<string>Anti-patterns that AI generation should not produce when this tone is active.
samplePhrasesarray<string>Short example phrases that exemplify this tone.
recommendedNarrativesarray<string>Soft cross-link: narrative-catalog ids this tone pairs well with.
tagsarray<string>Free-form labels for filtering and search.

id

Type: string · Optional · Default: · Pattern: ^[a-z][a-z0-9-]*$

Optional tones catalog id to resolve before applying inline overrides.

id.json
{
  "id": "formal"
}

name

Type: string · Optional · Default:

Human-readable tone name shown in pickers.

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

summary

Type: string · Optional · Default:

One-sentence positioning of the tone.

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

description

Type: string · Optional · Default:

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

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

voiceCues

Type: array<string> · Optional · Default:

Short directives that shape AI generation toward this tone.

voiceCues.json
{
  "voiceCues": []
}

avoid

Type: array<string> · Optional · Default:

Anti-patterns that AI generation should not produce when this tone is active.

avoid.json
{
  "avoid": []
}

samplePhrases

Type: array<string> · Optional · Default:

Short example phrases that exemplify this tone.

samplePhrases.json
{
  "samplePhrases": []
}

recommendedNarratives

Type: array<string> · Optional · Default:

Soft cross-link: narrative-catalog ids this tone pairs well with.

recommendedNarratives.json
{
  "recommendedNarratives": []
}

tags

Type: array<string> · Optional · Default:

Free-form labels for filtering and search.

tags.json
{
  "tags": []
}