What is SpeakableSpecification?
A SpeakableSpecification indicates (typically via [[xpath]] or [[cssSelector]]) sections of a document that are highlighted as particularly [[speakable]]. Instances of this type are expected to be used primarily as values of the [[speakable]] property.
Example JSON-LD skeleton
This minimal example only identifies a Schema.org type. It is not a complete entity, a Google rich-result test, or a claim about a real business.
{
"@context": "https://schema.org",
"@type": "SpeakableSpecification"
}
Full parent hierarchy
Each chain starts at a root type. Multiple paths are shown when Schema.org defines more than one parent. For very complex types, up to 256 paths are displayed; consult the official definition for the full graph.
- Thing → Intangible → SpeakableSpecification
Direct parents: Intangible
Child types (0)
No entries listed in the available snapshot.
Properties that accept SpeakableSpecification values (1)
| Property | On types | Description |
|---|---|---|
| speakable | Article or WebPage | 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, e.g. 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. |
Properties usable on SpeakableSpecification (15)
This list includes properties whose domainIncludes names SpeakableSpecification or one of its ancestors. DomainIncludes is advisory; it is not an exhaustive set of permitted properties.
| Property | Expected value types | Description |
|---|---|---|
| additionalType | Text, URL | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org <a href="https://schema.org/docs/styleguide.html">style guide</a>. |
| alternateName | Text | An alias for the item. |
| cssSelector | CssSelectorType | A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element". |
| description | Text, TextObject | A description of the item. |
| disambiguatingDescription | Text | A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. |
| identifier | PropertyValue, Text, URL | The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details. |
| image | ImageObject, URL | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
| mainEntityOfPage | CreativeWork, URL | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details. |
| name | Text | The name of the item. |
| owner | Organization, Person | A person or organization who owns this Thing. |
| potentialAction | Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
| sameAs | URL | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. |
| subjectOf | CreativeWork, Event | A CreativeWork or Event about this Thing. |
| url | URL | URL of the item. |
| xpath | XPathType | An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element". |
Schema.org vs Google
This type's presence in Schema.org is not a Google feature approval. Check our dated Google status snapshot and Google's official Rich Results Test separately.