speakable

Defined in the pending.schema.org extension.
Canonical URL: http://schema.org/speakable

Thing > Property > speakable

Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.

The speakable property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:

1.) id-value URL references - uses id-value of an element in the page being annotated. The simplest use of speakable has (potentially relative) URL values, referencing identified sections of the document concerned.

2.) CSS Selectors - addresses content in the annotated page, eg. via class attribute. Use the cssSelector property.

3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the xpath property.

For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For this we define a supporting type, SpeakableSpecification which is defined to be a possible value of the speakable property.

Usage: Fewer than 10 domains

[more...]

Leave public feedback on this term 💬
Check for open issues.
'speakable' is mentioned in extension layer: pending

Values expected to be one of these types
`SpeakableSpecification` `URL`

Used on these types
`WebPage`

Source

https://github.com/schemaorg/schemaorg/issues/1389

Examples

Example 1

Without Markup Microdata RDFa JSON-LD

An example of 'speakable' markup (JSON-LD only, initially).

TODO

TODO

{
 "@context": "http://schema.org/",
 "@type": "WebPage",
 "name": "Jane Doe's homepage",
 "speakable":
 {
  "@type": "SpeakableSpecification",
  "cssSelector": ["headline", "summary"]
  },
 "url": "http://www.janedoe.com"
 }
 TYPES: speakable
 PRE-MARKUP:
 An example of 'speakable' markup (JSON-LD only, initially).
 MICRODATA:
 TODO
 RDFA:
 TODO
 JSON:
 {
  "@context": "http://schema.org/",
  "@type": "WebPage",
  "name": "Jane Doe's homepage",
  "speakable": [ "#myhead1", "#thesummary"],
  "url": "http://www.janedoe.com"
  }

Example 2

Without Markup Microdata RDFa JSON-LD

An example of 'speakable' markup (JSON-LD only, initially).

TODO

TODO

{
 "@context": "http://schema.org/",
 "@type": "WebPage",
 "name": "Jane Doe's homepage",
 "speakable":
 {
  "@type": "SpeakableSpecification",
  "cssSelector": ["headline", "summary"]
  },
 "url": "http://www.janedoe.com"
 }
 TYPES: speakable
 PRE-MARKUP:
 An example of 'speakable' markup (JSON-LD only, initially).
 MICRODATA:
 TODO
 RDFA:
 TODO
 JSON:
 {
  "@context": "http://schema.org/",
  "@type": "WebPage",
  "name": "Jane Doe's homepage",
  "speakable": [ "#myhead1", "#thesummary"],
  "url": "http://www.janedoe.com"
  }

Schema Version 3.2