SpeakableSpecification
Defined in the pending.schema.org extension.Canonical URL: http://schema.org/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.
Usage: Fewer than 10 domains
| Property | Expected Type | Description |
|---|---|---|
| Properties from SpeakableSpecification | ||
cssSelector
|
Text | A CSS selector. |
xpath
|
Text | An XPath. |
| Properties from Thing | ||
additionalType
|
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. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
alternateName
|
Text | An alias for the item. |
description
|
Text | 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 or Text or 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 for more details. |
image
|
ImageObject or URL | An image of the item. This can be a URL or a fully described ImageObject. |
mainEntityOfPage
|
CreativeWork or URL | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property: mainEntity. |
name
|
Text | The name of the item. |
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. |
url
|
URL | URL of the item. |
Instances of SpeakableSpecification may appear as values for the following properties
| Property | On Types | Description |
|---|---|---|
speakable
|
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, 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. |
Source
https://github.com/schemaorg/schemaorg/issues/1389
Examples
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"
}
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