SpeakableSpecification - Что такое SpeakableSpecification?
Узнайте, как использовать SpeakableSpecification для выделения ключевых участков вашего контента!
SpeakableSpecification - Тип Schema.org
Описание: SpeakableSpecification указывает (обычно с помощью xpath или cssSelector) разделы документа, которые выделены как особенно подлежащие озвучиванию. Ожидается, что экземпляры этого типа будут использоваться преимущественно в качестве значений свойства speakable.
SpeakableSpecification - это тип данных Schema.org, который указывает (обычно с помощью xpath или cssSelector) участки документа, которые выделены как особенно подходящие для произношения. Экземпляры этого типа ожидаются в основном использоваться в качестве значения свойства speakable.
Совет: Используйте SpeakableSpecification для пометки ключевых секций вашего контента, которые могут быть озвучены, чтобы повысить доступность и удобство использования вашего сайта.
Свойство | Ожидаемый тип | Описание |
---|---|---|
Properties from SpeakableSpecification | ||
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". |
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". |
Properties from Thing | ||
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 style guide. |
alternateName |
Text | Псевдоним для элемента. |
description |
Text или TextObject | Описание элемента. |
disambiguatingDescription |
Text | Подсвойство описания. Краткое описание элемента, используемое для различения от других, схожих элементов. Для того чтобы описание было полезным для разрешения неоднозначности, может потребоваться информация из других свойств (в частности, name). |
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 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 for details. Обратное свойство: mainEntity |
name |
Text | Название элемента. |
potentialAction |
Action | Указывает на потенциальное действие, описывающее идеализированное действие, в котором этот объект мог бы выполнять роль 'объекта'. |
sameAs |
URL | URL страницы для ссылки, однозначно указывающей на идентичность объекта. Например, URL страницы объекта на Википедии, записи в Wikidata или официального веб-сайта. |
subjectOf |
CreativeWork или Event | Свойство Schema.org - subjectOf: A CreativeWork or Event about this Thing. Обратное свойство: about |
url |
URL | URL объекта. |
Instances of
SpeakableSpecification may appear as a value for the following properties
Свойство | On Types | Описание |
---|---|---|
speakable | Article или 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 thiswe 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
Example 1
Copied
Example notes or example HTML without markup.
An example of 'speakable' markup (JSON-LD only, initially).
Example encoded as JSON-LD in a HTML script tag.
{ "@context": "https://schema.org/", "@type": "WebPage", "name": "Jane Doe's homepage", "speakable": { "@type": "SpeakableSpecification", "cssSelector": ["headline", "summary"] }, "url": "http://www.janedoe.com" }
Structured representation of the JSON-LD example.
Example 2
Copied
Example notes or example HTML without markup.
An example of speakable markup in Microdata in HTML head section.
Example encoded as Microdata embedded in HTML.
<!DOCTYPE html> <html> <head rel="home" href="/" itemid="" itemscope itemtype="https://schema.org/SpeakableSpecification"> <title>Example showing complex structures in HTML head</title> <meta itemprop="cssSelector" content=".title" /> <meta itemprop="xpath" content="/html/body/h3" /> </head> <body> <h1 class="title">Complex Microdata in HTML head</h1> <p>...</p> </body> </html>