lspace.ns.vocab.schema.speakable.scala Maven / Gradle / Ivy
The newest version!
package lspace.ns.vocab.schema
import lspace.ns.vocab.schema._
import lspace.Label.D._
import lspace.Label.P._
import lspace.structure.{Property => LProperty, PropertyDef}
object speakable extends PropertyDef(
iri = "http://schema.org/speakable",
iris = Set("http://schema.org/speakable"),
label = "speakable",
comment = """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.""",
`@extends` = List(),
`@range` = List(SpeakableSpecification.ontology, URL.ontology)
){
override lazy val properties: List[LProperty] = List()
trait Properties
}