ListItem: ListItem

In cboettig/schemar: Create Structured Data Using the Schema.org Vocabulary

Description

An list item, e.g. a step in a checklist or how-to description.

Usage

ListItem(id = NULL, previousItem = NULL, position = NULL,
  nextItem = NULL, item = NULL, url = NULL, sameAs = NULL,
  potentialAction = NULL, name = NULL, mainEntityOfPage = NULL,
  image = NULL, identifier = NULL, disambiguatingDescription = NULL,
  description = NULL, alternateName = NULL, additionalType = NULL)

Arguments

id	identifier for the object (URI)
previousItem	(ListItem type.) A link to the ListItem that preceeds the current one.
position	(Text or Integer or Text or Integer type.) The position of an item in a series or sequence of items.
nextItem	(ListItem type.) A link to the ListItem that follows the current one.
item	(Thing or Thing type.) An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists')’.
url	(URL type.) URL of the item.
sameAs	(URL type.) 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.
potentialAction	(Action type.) Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
name	(Text type.) The name of the item.
mainEntityOfPage	(URL or CreativeWork type.) 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.
image	(URL or ImageObject type.) An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
identifier	(URL or Text or PropertyValue type.) 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.
disambiguatingDescription	(Text type.) 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.
description	(Text type.) A description of the item.
alternateName	(Text type.) An alias for the item.
additionalType	(URL type.) 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.

Value

a list object corresponding to a schema:ListItem

cboettig/schemar documentation built on May 20, 2019, 4:27 p.m.