SpecDefinition referenceView source

Tone

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

Metadata

Definition: #/$defs/Tone
Form: 2 inclusive forms (anyOf)
Source: spec/schemas/opf.schema.json

Field index

Field	Type	Req.	Description
id	ref:CatalogReference	—	Optional tones reference (a bare id or 'name:id') resolved before applying the 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 ids this tone pairs well with, for picker UIs. Never resolved, embedded or validated as references.
tags	array<string>	—	Free-form labels for filtering and search.

`id`

typeref:CatalogReferencerequirednodefault—

Optional tones reference (a bare id or 'name:id') resolved before applying the inline overrides.

id.json

{
  "id": "formal"
}

`name`

typestringrequirednodefault—

Human-readable tone name shown in pickers.

`summary`

typestringrequirednodefault—

One-sentence positioning of the tone.

`description`

typestringrequirednodefault—

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

`voiceCues`

typearray<string>requirednodefault—

Short directives that shape AI generation toward this tone.

`avoid`

typearray<string>requirednodefault—

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

`samplePhrases`

typearray<string>requirednodefault—

Short example phrases that exemplify this tone.

`recommendedNarratives`

typearray<string>requirednodefault—

Soft cross-link: narrative ids this tone pairs well with, for picker UIs. Never resolved, embedded or validated as references.

`tags`

typearray<string>requirednodefault—

Free-form labels for filtering and search.

anyOf 1 · `object`

Exact constraints for anyOf 1

anyOf 1 schema

{
  "required": [
    "id"
  ]
}

anyOf 2 · `object`

Exact constraints for anyOf 2

anyOf 2 schema

{
  "required": [
    "name"
  ]
}

Complete definition constraints

Schema constraints

{
  "type": "object",
  "description": "Inline tone metadata for the presentation. Use 'id' to reference a tones record (a bare id or 'name:id') and override selected fields, or use 'name' for a custom inline tone.",
  "anyOf": [
    {
      "required": [
        "id"
      ]
    },
    {
      "required": [
        "name"
      ]
    }
  ],
  "properties": {
    "id": {
      "$ref": "#/$defs/CatalogReference",
      "description": "Optional tones reference (a bare id or 'name:id') resolved before applying the inline overrides.",
      "examples": [
        "formal",
        "casual",
        "technical",
        "persuasive"
      ]
    },
    "name": {
      "type": "string",
      "description": "Human-readable tone name shown in pickers."
    },
    "summary": {
      "type": "string",
      "description": "One-sentence positioning of the tone."
    },
    "description": {
      "type": "string",
      "description": "Longer prose describing the tone and the kinds of decks it suits."
    },
    "voiceCues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Short directives that shape AI generation toward this tone."
    },
    "avoid": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Anti-patterns that AI generation should not produce when this tone is active."
    },
    "samplePhrases": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Short example phrases that exemplify this tone."
    },
    "recommendedNarratives": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Soft cross-link: narrative ids this tone pairs well with, for picker UIs. Never resolved, embedded or validated as references."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Free-form labels for filtering and search."
    }
  }
}