Properties inherited from @schema/3DModel | Expected Type | Description |
---|---|---|
@schema/isResizable | Whether the 3DModel allows resizing. For example, room layout applications often do not allow 3DModel elements to be resized to reflect reality. |
Properties inherited from @schema/MediaObject | Expected Type | Description |
---|---|---|
@schema/associatedArticle | A NewsArticle associated with the Media Object. | |
@schema/bitrate | The bitrate of the media object. | |
@schema/contentSize | File size in (mega/kilo) bytes. | |
@schema/contentUrl | Actual bytes of the media object, for example the image file or video file. | |
@schema/duration | The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. | |
@schema/embedUrl | A URL pointing to a player for a specific video. In general, this is the information in the | |
@schema/encodesCreativeWork | The CreativeWork encoded by this media object. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/endTime | or | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/height | or | The height of the item. |
@schema/ineligibleRegion | , or | The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also [[eligibleRegion]]. |
@schema/playerType | Player type required—for example, Flash or Silverlight. | |
@schema/productionCompany | The production company or studio responsible for the item e.g. series, video game, episode etc. | |
@schema/regionsAllowed | The regions where the media is allowed. If not specified, then it's assumed to be allowed everywhere. Specify the countries in ISO 3166 format. | |
@schema/requiresSubscription | or | Indicates if use of the media require a subscription (either paid or free). Allowed values are |
@schema/startTime | or | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/uploadDate | Date when this media object was uploaded to this site. | |
@schema/width | or | The width of the item. |
Properties inherited from @schema/CreativeWork | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/abstract | An abstract is a short description that summarizes a [[CreativeWork]]. | |
@schema/accessMode | The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. | |
@schema/accessModeSufficient | A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual. | |
@schema/accessibilityAPI | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). | |
@schema/accessibilityControl | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). | |
@schema/accessibilityFeature | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). | |
@schema/accessibilityHazard | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). | |
@schema/accessibilitySummary | A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." | |
@schema/accountablePerson | Specifies the Person that is legally accountable for the CreativeWork. | |
@schema/acquireLicensePage | or | Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/alternativeHeadline | A secondary title of the CreativeWork. | |
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/associatedMedia | A media object that encodes this CreativeWork. This property is a synonym for encoding. | |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/audio | , or | An embedded audio object. |
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/award | An award won by or for this item. | |
@schema/awards | Awards won by or for this item. | |
@schema/character | Fictional person connected with a creative work. | |
@schema/citation | or | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
@schema/comment | Comments, typically from users. | |
@schema/commentCount | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. | |
@schema/conditionsOfAccess | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | |
@schema/contentLocation | The location depicted or described in the content. For example, the location in a photograph or painting. | |
@schema/contentRating | or | Official rating of a piece of content—for example,'MPAA PG-13'. |
@schema/contentReferenceTime | The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. | |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/copyrightHolder | or | The party holding the legal copyright to the CreativeWork. |
@schema/copyrightNotice | Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. | |
@schema/copyrightYear | The year during which the claimed copyright for the CreativeWork was first asserted. | |
@schema/correction | , or | Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
@schema/creativeWorkStatus | or | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
@schema/creator | or | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
@schema/creditText | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | |
@schema/dateCreated | or | The date on which the CreativeWork was created or the item was added to a DataFeed. |
@schema/dateModified | or | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
@schema/datePublished | or | Date of first broadcast/publication. |
@schema/discussionUrl | A link to the page containing the comments of the CreativeWork. | |
@schema/editEIDR | or | An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
@schema/editor | Specifies the Person who edited the CreativeWork. | |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/encoding | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/encodings | A media object that encodes this CreativeWork. | |
@schema/exampleOfWork | A creative work that this work is an example/instance/realization/derivation of. | |
@schema/expires | Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. | |
@schema/fileFormat | or | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/hasPart | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). | |
@schema/headline | Headline of the article. | |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/interactionStatistic | The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. | |
@schema/interactivityType | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. | |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/isBasedOn | , or | A resource from which this work is derived or from which it is a modification or adaption. |
@schema/isBasedOnUrl | , or | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
@schema/isFamilyFriendly | Indicates whether this content is family friendly. | |
@schema/isPartOf | or | Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
@schema/keywords | , or | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/license | or | A license document that applies to this content, typically indicated by URL. |
@schema/locationCreated | The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. | |
@schema/mainEntity | Indicates the primary entity described in some page or other CreativeWork. | |
@schema/maintainer | or | A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
@schema/material | , or | A material that something is made from, e.g. leather, wool, cotton, paper. |
@schema/materialExtent | or | The quantity of the materials being described or an expression of the physical space they occupy. |
@schema/mentions | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/pattern | or | A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. |
@schema/position | or | The position of an item in a series or sequence of items. |
@schema/producer | or | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/publication | A publication event associated with the item. | |
@schema/publisher | or | The publisher of the creative work. |
@schema/publisherImprint | The publishing division which published the comic. | |
@schema/publishingPrinciples | or | The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
@schema/recordedAt | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. | |
@schema/releasedEvent | The place and time the release was issued, expressed as a PublicationEvent. | |
@schema/review | A review of the item. | |
@schema/reviews | Review of the item. | |
@schema/schemaVersion | or | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. |
@schema/sdDatePublished | Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] | |
@schema/sdLicense | or | A license document that applies to this structured data, typically indicated by URL. |
@schema/sdPublisher | or | Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit. |
@schema/size | , , or | A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. |
@schema/sourceOrganization | The Organization on whose behalf the creator was working. | |
@schema/spatial | The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. | |
@schema/spatialCoverage | The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
@schema/temporal | or | The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
@schema/temporalCoverage | , or | The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
@schema/text | The textual content of this CreativeWork. | |
@schema/thumbnailUrl | A thumbnail image relevant to the Thing. | |
@schema/timeRequired | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. | |
@schema/translationOfWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” | |
@schema/translator | or | Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
@schema/typicalAgeRange | The typical expected age range, e.g. '7-9', '11-'. | |
@schema/usageInfo | or | The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
@schema/version | or | The version of the CreativeWork embodied by a specified resource. |
@schema/video | or | An embedded video object. |
@schema/workExample | Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook. | |
@schema/workTranslation | A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/BroadcastChannel | Expected Type | Description |
---|---|---|
@schema/broadcastChannelId | The unique address by which the BroadcastService can be identified in a provider lineup. In US, this is typically a number. | |
@schema/broadcastFrequency | or | The frequency used for over-the-air broadcasts. Numeric values or simple ranges e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM". |
@schema/broadcastServiceTier | The type of service required to have access to the channel (e.g. Standard or Premium). | |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/inBroadcastLineup | The CableOrSatelliteService offering the channel. | |
@schema/providesBroadcastService | The BroadcastService offered on this channel. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/APIReference | Expected Type | Description |
---|---|---|
@schema/assembly | Library file name e.g., mscorlib.dll, system.web.dll. | |
@schema/assemblyVersion | Associated product/technology version. e.g., .NET Framework 4.5. | |
@schema/executableLibraryName | Library file name e.g., mscorlib.dll, system.web.dll. | |
@schema/programmingModel | Indicates whether API is managed or unmanaged. | |
@schema/targetPlatform | Type of app development: phone, Metro style, desktop, XBox, etc. |
Properties inherited from @schema/TechArticle | Expected Type | Description |
---|---|---|
@schema/dependencies | Prerequisites needed to fulfill steps in article. | |
@schema/proficiencyLevel | Proficiency needed for this content; expected values: 'Beginner', 'Expert'. |
Properties inherited from @schema/Article | Expected Type | Description |
---|---|---|
@schema/articleBody | The actual body of the article. | |
@schema/articleSection | Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc. | |
@schema/backstory | or | For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc. |
@schema/pageEnd | or | The page on which the work ends; for example "138" or "xvi". |
@schema/pageStart | or | The page on which the work starts; for example "135" or "xiii". |
@schema/pagination | Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". | |
@schema/speakable | or | 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. |
@schema/wordCount | The number of words in the text of the Article. |
Properties inherited from @schema/CreativeWork | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/abstract | An abstract is a short description that summarizes a [[CreativeWork]]. | |
@schema/accessMode | The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. | |
@schema/accessModeSufficient | A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual. | |
@schema/accessibilityAPI | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). | |
@schema/accessibilityControl | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). | |
@schema/accessibilityFeature | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). | |
@schema/accessibilityHazard | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). | |
@schema/accessibilitySummary | A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." | |
@schema/accountablePerson | Specifies the Person that is legally accountable for the CreativeWork. | |
@schema/acquireLicensePage | or | Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/alternativeHeadline | A secondary title of the CreativeWork. | |
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/associatedMedia | A media object that encodes this CreativeWork. This property is a synonym for encoding. | |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/audio | , or | An embedded audio object. |
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/award | An award won by or for this item. | |
@schema/awards | Awards won by or for this item. | |
@schema/character | Fictional person connected with a creative work. | |
@schema/citation | or | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
@schema/comment | Comments, typically from users. | |
@schema/commentCount | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. | |
@schema/conditionsOfAccess | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | |
@schema/contentLocation | The location depicted or described in the content. For example, the location in a photograph or painting. | |
@schema/contentRating | or | Official rating of a piece of content—for example,'MPAA PG-13'. |
@schema/contentReferenceTime | The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. | |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/copyrightHolder | or | The party holding the legal copyright to the CreativeWork. |
@schema/copyrightNotice | Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. | |
@schema/copyrightYear | The year during which the claimed copyright for the CreativeWork was first asserted. | |
@schema/correction | , or | Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
@schema/creativeWorkStatus | or | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
@schema/creator | or | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
@schema/creditText | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | |
@schema/dateCreated | or | The date on which the CreativeWork was created or the item was added to a DataFeed. |
@schema/dateModified | or | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
@schema/datePublished | or | Date of first broadcast/publication. |
@schema/discussionUrl | A link to the page containing the comments of the CreativeWork. | |
@schema/editEIDR | or | An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
@schema/editor | Specifies the Person who edited the CreativeWork. | |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/encoding | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/encodings | A media object that encodes this CreativeWork. | |
@schema/exampleOfWork | A creative work that this work is an example/instance/realization/derivation of. | |
@schema/expires | Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. | |
@schema/fileFormat | or | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/hasPart | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). | |
@schema/headline | Headline of the article. | |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/interactionStatistic | The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. | |
@schema/interactivityType | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. | |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/isBasedOn | , or | A resource from which this work is derived or from which it is a modification or adaption. |
@schema/isBasedOnUrl | , or | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
@schema/isFamilyFriendly | Indicates whether this content is family friendly. | |
@schema/isPartOf | or | Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
@schema/keywords | , or | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/license | or | A license document that applies to this content, typically indicated by URL. |
@schema/locationCreated | The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. | |
@schema/mainEntity | Indicates the primary entity described in some page or other CreativeWork. | |
@schema/maintainer | or | A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
@schema/material | , or | A material that something is made from, e.g. leather, wool, cotton, paper. |
@schema/materialExtent | or | The quantity of the materials being described or an expression of the physical space they occupy. |
@schema/mentions | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/pattern | or | A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. |
@schema/position | or | The position of an item in a series or sequence of items. |
@schema/producer | or | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/publication | A publication event associated with the item. | |
@schema/publisher | or | The publisher of the creative work. |
@schema/publisherImprint | The publishing division which published the comic. | |
@schema/publishingPrinciples | or | The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
@schema/recordedAt | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. | |
@schema/releasedEvent | The place and time the release was issued, expressed as a PublicationEvent. | |
@schema/review | A review of the item. | |
@schema/reviews | Review of the item. | |
@schema/schemaVersion | or | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. |
@schema/sdDatePublished | Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] | |
@schema/sdLicense | or | A license document that applies to this structured data, typically indicated by URL. |
@schema/sdPublisher | or | Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit. |
@schema/size | , , or | A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. |
@schema/sourceOrganization | The Organization on whose behalf the creator was working. | |
@schema/spatial | The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. | |
@schema/spatialCoverage | The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
@schema/temporal | or | The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
@schema/temporalCoverage | , or | The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
@schema/text | The textual content of this CreativeWork. | |
@schema/thumbnailUrl | A thumbnail image relevant to the Thing. | |
@schema/timeRequired | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. | |
@schema/translationOfWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” | |
@schema/translator | or | Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
@schema/typicalAgeRange | The typical expected age range, e.g. '7-9', '11-'. | |
@schema/usageInfo | or | The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
@schema/version | or | The version of the CreativeWork embodied by a specified resource. |
@schema/video | or | An embedded video object. |
@schema/workExample | Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook. | |
@schema/workTranslation | A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/WebPage | Expected Type | Description |
---|---|---|
@schema/breadcrumb | or | A set of links that can help a user understand and navigate a website hierarchy. |
@schema/lastReviewed | Date on which the content on this web page was last reviewed for accuracy and/or completeness. | |
@schema/mainContentOfPage | Indicates if this web page element is the main subject of the page. | |
@schema/primaryImageOfPage | Indicates the main image on the page. | |
@schema/relatedLink | A link related to this web page, for example to other related web pages. | |
@schema/reviewedBy | or | People or organizations that have reviewed the content on this web page for accuracy and/or completeness. |
@schema/significantLink | One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most. | |
@schema/significantLinks | The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most. | |
@schema/speakable | or | 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. |
@schema/specialty | One of the domain specialities to which this web page's content applies. |
Properties inherited from @schema/CreativeWork | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/abstract | An abstract is a short description that summarizes a [[CreativeWork]]. | |
@schema/accessMode | The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. | |
@schema/accessModeSufficient | A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual. | |
@schema/accessibilityAPI | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). | |
@schema/accessibilityControl | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). | |
@schema/accessibilityFeature | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). | |
@schema/accessibilityHazard | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). | |
@schema/accessibilitySummary | A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." | |
@schema/accountablePerson | Specifies the Person that is legally accountable for the CreativeWork. | |
@schema/acquireLicensePage | or | Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/alternativeHeadline | A secondary title of the CreativeWork. | |
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/associatedMedia | A media object that encodes this CreativeWork. This property is a synonym for encoding. | |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/audio | , or | An embedded audio object. |
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/award | An award won by or for this item. | |
@schema/awards | Awards won by or for this item. | |
@schema/character | Fictional person connected with a creative work. | |
@schema/citation | or | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
@schema/comment | Comments, typically from users. | |
@schema/commentCount | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. | |
@schema/conditionsOfAccess | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | |
@schema/contentLocation | The location depicted or described in the content. For example, the location in a photograph or painting. | |
@schema/contentRating | or | Official rating of a piece of content—for example,'MPAA PG-13'. |
@schema/contentReferenceTime | The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. | |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/copyrightHolder | or | The party holding the legal copyright to the CreativeWork. |
@schema/copyrightNotice | Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. | |
@schema/copyrightYear | The year during which the claimed copyright for the CreativeWork was first asserted. | |
@schema/correction | , or | Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
@schema/creativeWorkStatus | or | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
@schema/creator | or | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
@schema/creditText | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | |
@schema/dateCreated | or | The date on which the CreativeWork was created or the item was added to a DataFeed. |
@schema/dateModified | or | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
@schema/datePublished | or | Date of first broadcast/publication. |
@schema/discussionUrl | A link to the page containing the comments of the CreativeWork. | |
@schema/editEIDR | or | An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
@schema/editor | Specifies the Person who edited the CreativeWork. | |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/encoding | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/encodings | A media object that encodes this CreativeWork. | |
@schema/exampleOfWork | A creative work that this work is an example/instance/realization/derivation of. | |
@schema/expires | Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. | |
@schema/fileFormat | or | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/hasPart | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). | |
@schema/headline | Headline of the article. | |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/interactionStatistic | The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. | |
@schema/interactivityType | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. | |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/isBasedOn | , or | A resource from which this work is derived or from which it is a modification or adaption. |
@schema/isBasedOnUrl | , or | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
@schema/isFamilyFriendly | Indicates whether this content is family friendly. | |
@schema/isPartOf | or | Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
@schema/keywords | , or | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/license | or | A license document that applies to this content, typically indicated by URL. |
@schema/locationCreated | The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. | |
@schema/mainEntity | Indicates the primary entity described in some page or other CreativeWork. | |
@schema/maintainer | or | A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
@schema/material | , or | A material that something is made from, e.g. leather, wool, cotton, paper. |
@schema/materialExtent | or | The quantity of the materials being described or an expression of the physical space they occupy. |
@schema/mentions | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/pattern | or | A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. |
@schema/position | or | The position of an item in a series or sequence of items. |
@schema/producer | or | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/publication | A publication event associated with the item. | |
@schema/publisher | or | The publisher of the creative work. |
@schema/publisherImprint | The publishing division which published the comic. | |
@schema/publishingPrinciples | or | The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
@schema/recordedAt | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. | |
@schema/releasedEvent | The place and time the release was issued, expressed as a PublicationEvent. | |
@schema/review | A review of the item. | |
@schema/reviews | Review of the item. | |
@schema/schemaVersion | or | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. |
@schema/sdDatePublished | Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] | |
@schema/sdLicense | or | A license document that applies to this structured data, typically indicated by URL. |
@schema/sdPublisher | or | Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit. |
@schema/size | , , or | A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. |
@schema/sourceOrganization | The Organization on whose behalf the creator was working. | |
@schema/spatial | The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. | |
@schema/spatialCoverage | The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
@schema/temporal | or | The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
@schema/temporalCoverage | , or | The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
@schema/text | The textual content of this CreativeWork. | |
@schema/thumbnailUrl | A thumbnail image relevant to the Thing. | |
@schema/timeRequired | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. | |
@schema/translationOfWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” | |
@schema/translator | or | Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
@schema/typicalAgeRange | The typical expected age range, e.g. '7-9', '11-'. | |
@schema/usageInfo | or | The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
@schema/version | or | The version of the CreativeWork embodied by a specified resource. |
@schema/video | or | An embedded video object. |
@schema/workExample | Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook. | |
@schema/workTranslation | A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/Action | Expected Type | Description |
---|---|---|
@schema/actionStatus | Indicates the current disposition of the Action. | |
@schema/agent | or | The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book. |
@schema/endTime | or | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/error | For failed actions, more information on the cause of the failure. | |
@schema/instrument | The object that helped the agent perform the action. e.g. John wrote a book with a pen. | |
@schema/location | , , or | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
@schema/object | The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book. | |
@schema/participant | or | Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve. |
@schema/result | The result produced in the action. e.g. John wrote a book. | |
@schema/startTime | or | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/target | Indicates a target EntryPoint for an Action. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/Action | Expected Type | Description |
---|---|---|
@schema/actionStatus | Indicates the current disposition of the Action. | |
@schema/agent | or | The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book. |
@schema/endTime | or | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/error | For failed actions, more information on the cause of the failure. | |
@schema/instrument | The object that helped the agent perform the action. e.g. John wrote a book with a pen. | |
@schema/location | , , or | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
@schema/object | The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book. | |
@schema/participant | or | Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve. |
@schema/result | The result produced in the action. e.g. John wrote a book. | |
@schema/startTime | or | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/target | Indicates a target EntryPoint for an Action. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/AggregateRating | Expected Type | Description |
---|---|---|
@schema/itemReviewed | The item that is being reviewed/rated. | |
@schema/ratingCount | The count of total number of ratings. | |
@schema/reviewCount | The count of total number of reviews. |
Properties inherited from @schema/Rating | Expected Type | Description |
---|---|---|
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/bestRating | or | The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed. |
@schema/ratingExplanation | A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using [[ClaimReview]]. | |
@schema/ratingValue | or | The rating for the content.\n\nUsage guidelines:\n\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
@schema/reviewAspect | This Review or Rating is relevant to this part or facet of the itemReviewed. | |
@schema/worstRating | or | The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/ArchiveComponent | Expected Type | Description |
---|---|---|
@schema/holdingArchive | [[ArchiveOrganization]] that holds, keeps or maintains the [[ArchiveComponent]]. | |
@schema/itemLocation | , or | Current location of the item. |
Properties inherited from @schema/CreativeWork | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/abstract | An abstract is a short description that summarizes a [[CreativeWork]]. | |
@schema/accessMode | The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. | |
@schema/accessModeSufficient | A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual. | |
@schema/accessibilityAPI | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). | |
@schema/accessibilityControl | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). | |
@schema/accessibilityFeature | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). | |
@schema/accessibilityHazard | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). | |
@schema/accessibilitySummary | A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." | |
@schema/accountablePerson | Specifies the Person that is legally accountable for the CreativeWork. | |
@schema/acquireLicensePage | or | Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/alternativeHeadline | A secondary title of the CreativeWork. | |
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/associatedMedia | A media object that encodes this CreativeWork. This property is a synonym for encoding. | |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/audio | , or | An embedded audio object. |
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/award | An award won by or for this item. | |
@schema/awards | Awards won by or for this item. | |
@schema/character | Fictional person connected with a creative work. | |
@schema/citation | or | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
@schema/comment | Comments, typically from users. | |
@schema/commentCount | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. | |
@schema/conditionsOfAccess | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | |
@schema/contentLocation | The location depicted or described in the content. For example, the location in a photograph or painting. | |
@schema/contentRating | or | Official rating of a piece of content—for example,'MPAA PG-13'. |
@schema/contentReferenceTime | The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. | |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/copyrightHolder | or | The party holding the legal copyright to the CreativeWork. |
@schema/copyrightNotice | Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. | |
@schema/copyrightYear | The year during which the claimed copyright for the CreativeWork was first asserted. | |
@schema/correction | , or | Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
@schema/creativeWorkStatus | or | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
@schema/creator | or | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
@schema/creditText | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | |
@schema/dateCreated | or | The date on which the CreativeWork was created or the item was added to a DataFeed. |
@schema/dateModified | or | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
@schema/datePublished | or | Date of first broadcast/publication. |
@schema/discussionUrl | A link to the page containing the comments of the CreativeWork. | |
@schema/editEIDR | or | An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
@schema/editor | Specifies the Person who edited the CreativeWork. | |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/encoding | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/encodings | A media object that encodes this CreativeWork. | |
@schema/exampleOfWork | A creative work that this work is an example/instance/realization/derivation of. | |
@schema/expires | Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. | |
@schema/fileFormat | or | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/hasPart | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). | |
@schema/headline | Headline of the article. | |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/interactionStatistic | The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. | |
@schema/interactivityType | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. | |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/isBasedOn | , or | A resource from which this work is derived or from which it is a modification or adaption. |
@schema/isBasedOnUrl | , or | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
@schema/isFamilyFriendly | Indicates whether this content is family friendly. | |
@schema/isPartOf | or | Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
@schema/keywords | , or | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/license | or | A license document that applies to this content, typically indicated by URL. |
@schema/locationCreated | The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. | |
@schema/mainEntity | Indicates the primary entity described in some page or other CreativeWork. | |
@schema/maintainer | or | A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
@schema/material | , or | A material that something is made from, e.g. leather, wool, cotton, paper. |
@schema/materialExtent | or | The quantity of the materials being described or an expression of the physical space they occupy. |
@schema/mentions | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/pattern | or | A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. |
@schema/position | or | The position of an item in a series or sequence of items. |
@schema/producer | or | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/publication | A publication event associated with the item. | |
@schema/publisher | or | The publisher of the creative work. |
@schema/publisherImprint | The publishing division which published the comic. | |
@schema/publishingPrinciples | or | The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
@schema/recordedAt | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. | |
@schema/releasedEvent | The place and time the release was issued, expressed as a PublicationEvent. | |
@schema/review | A review of the item. | |
@schema/reviews | Review of the item. | |
@schema/schemaVersion | or | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. |
@schema/sdDatePublished | Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] | |
@schema/sdLicense | or | A license document that applies to this structured data, typically indicated by URL. |
@schema/sdPublisher | or | Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit. |
@schema/size | , , or | A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. |
@schema/sourceOrganization | The Organization on whose behalf the creator was working. | |
@schema/spatial | The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. | |
@schema/spatialCoverage | The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
@schema/temporal | or | The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
@schema/temporalCoverage | , or | The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
@schema/text | The textual content of this CreativeWork. | |
@schema/thumbnailUrl | A thumbnail image relevant to the Thing. | |
@schema/timeRequired | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. | |
@schema/translationOfWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” | |
@schema/translator | or | Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
@schema/typicalAgeRange | The typical expected age range, e.g. '7-9', '11-'. | |
@schema/usageInfo | or | The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
@schema/version | or | The version of the CreativeWork embodied by a specified resource. |
@schema/video | or | An embedded video object. |
@schema/workExample | Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook. | |
@schema/workTranslation | A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/AuthorizeAction | Expected Type | Description |
---|---|---|
@schema/recipient | , , or | A sub property of participant. The participant who is at the receiving end of the action. |
Properties inherited from @schema/Action | Expected Type | Description |
---|---|---|
@schema/actionStatus | Indicates the current disposition of the Action. | |
@schema/agent | or | The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book. |
@schema/endTime | or | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/error | For failed actions, more information on the cause of the failure. | |
@schema/instrument | The object that helped the agent perform the action. e.g. John wrote a book with a pen. | |
@schema/location | , , or | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
@schema/object | The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book. | |
@schema/participant | or | Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve. |
@schema/result | The result produced in the action. e.g. John wrote a book. | |
@schema/startTime | or | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/target | Indicates a target EntryPoint for an Action. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/Action | Expected Type | Description |
---|---|---|
@schema/actionStatus | Indicates the current disposition of the Action. | |
@schema/agent | or | The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book. |
@schema/endTime | or | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/error | For failed actions, more information on the cause of the failure. | |
@schema/instrument | The object that helped the agent perform the action. e.g. John wrote a book with a pen. | |
@schema/location | , , or | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
@schema/object | The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book. | |
@schema/participant | or | Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve. |
@schema/result | The result produced in the action. e.g. John wrote a book. | |
@schema/startTime | or | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/target | Indicates a target EntryPoint for an Action. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/SocialMediaPosting | Expected Type | Description |
---|---|---|
@schema/sharedContent | A CreativeWork such as an image, video, or audio clip shared as part of this posting. |
Properties inherited from @schema/Article | Expected Type | Description |
---|---|---|
@schema/articleBody | The actual body of the article. | |
@schema/articleSection | Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc. | |
@schema/backstory | or | For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc. |
@schema/pageEnd | or | The page on which the work ends; for example "138" or "xvi". |
@schema/pageStart | or | The page on which the work starts; for example "135" or "xiii". |
@schema/pagination | Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". | |
@schema/speakable | or | 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. |
@schema/wordCount | The number of words in the text of the Article. |
Properties inherited from @schema/CreativeWork | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/abstract | An abstract is a short description that summarizes a [[CreativeWork]]. | |
@schema/accessMode | The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. | |
@schema/accessModeSufficient | A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual. | |
@schema/accessibilityAPI | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). | |
@schema/accessibilityControl | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). | |
@schema/accessibilityFeature | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). | |
@schema/accessibilityHazard | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). | |
@schema/accessibilitySummary | A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." | |
@schema/accountablePerson | Specifies the Person that is legally accountable for the CreativeWork. | |
@schema/acquireLicensePage | or | Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/alternativeHeadline | A secondary title of the CreativeWork. | |
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/associatedMedia | A media object that encodes this CreativeWork. This property is a synonym for encoding. | |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/audio | , or | An embedded audio object. |
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/award | An award won by or for this item. | |
@schema/awards | Awards won by or for this item. | |
@schema/character | Fictional person connected with a creative work. | |
@schema/citation | or | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
@schema/comment | Comments, typically from users. | |
@schema/commentCount | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. | |
@schema/conditionsOfAccess | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | |
@schema/contentLocation | The location depicted or described in the content. For example, the location in a photograph or painting. | |
@schema/contentRating | or | Official rating of a piece of content—for example,'MPAA PG-13'. |
@schema/contentReferenceTime | The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. | |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/copyrightHolder | or | The party holding the legal copyright to the CreativeWork. |
@schema/copyrightNotice | Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. | |
@schema/copyrightYear | The year during which the claimed copyright for the CreativeWork was first asserted. | |
@schema/correction | , or | Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
@schema/creativeWorkStatus | or | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
@schema/creator | or | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
@schema/creditText | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | |
@schema/dateCreated | or | The date on which the CreativeWork was created or the item was added to a DataFeed. |
@schema/dateModified | or | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
@schema/datePublished | or | Date of first broadcast/publication. |
@schema/discussionUrl | A link to the page containing the comments of the CreativeWork. | |
@schema/editEIDR | or | An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
@schema/editor | Specifies the Person who edited the CreativeWork. | |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/encoding | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/encodings | A media object that encodes this CreativeWork. | |
@schema/exampleOfWork | A creative work that this work is an example/instance/realization/derivation of. | |
@schema/expires | Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. | |
@schema/fileFormat | or | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/hasPart | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). | |
@schema/headline | Headline of the article. | |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/interactionStatistic | The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. | |
@schema/interactivityType | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. | |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/isBasedOn | , or | A resource from which this work is derived or from which it is a modification or adaption. |
@schema/isBasedOnUrl | , or | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
@schema/isFamilyFriendly | Indicates whether this content is family friendly. | |
@schema/isPartOf | or | Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
@schema/keywords | , or | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/license | or | A license document that applies to this content, typically indicated by URL. |
@schema/locationCreated | The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. | |
@schema/mainEntity | Indicates the primary entity described in some page or other CreativeWork. | |
@schema/maintainer | or | A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
@schema/material | , or | A material that something is made from, e.g. leather, wool, cotton, paper. |
@schema/materialExtent | or | The quantity of the materials being described or an expression of the physical space they occupy. |
@schema/mentions | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/pattern | or | A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. |
@schema/position | or | The position of an item in a series or sequence of items. |
@schema/producer | or | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/publication | A publication event associated with the item. | |
@schema/publisher | or | The publisher of the creative work. |
@schema/publisherImprint | The publishing division which published the comic. | |
@schema/publishingPrinciples | or | The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
@schema/recordedAt | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. | |
@schema/releasedEvent | The place and time the release was issued, expressed as a PublicationEvent. | |
@schema/review | A review of the item. | |
@schema/reviews | Review of the item. | |
@schema/schemaVersion | or | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. |
@schema/sdDatePublished | Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] | |
@schema/sdLicense | or | A license document that applies to this structured data, typically indicated by URL. |
@schema/sdPublisher | or | Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit. |
@schema/size | , , or | A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. |
@schema/sourceOrganization | The Organization on whose behalf the creator was working. | |
@schema/spatial | The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. | |
@schema/spatialCoverage | The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
@schema/temporal | or | The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
@schema/temporalCoverage | , or | The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
@schema/text | The textual content of this CreativeWork. | |
@schema/thumbnailUrl | A thumbnail image relevant to the Thing. | |
@schema/timeRequired | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. | |
@schema/translationOfWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” | |
@schema/translator | or | Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
@schema/typicalAgeRange | The typical expected age range, e.g. '7-9', '11-'. | |
@schema/usageInfo | or | The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
@schema/version | or | The version of the CreativeWork embodied by a specified resource. |
@schema/video | or | An embedded video object. |
@schema/workExample | Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook. | |
@schema/workTranslation | A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/Class | Expected Type | Description |
---|---|---|
@schema/supersededBy | , or | Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/ItemList | Expected Type | Description |
---|---|---|
@schema/itemListElement | , or | For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.\n\nText values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.\n\nNote: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases. |
@schema/itemListOrder | or | Type of ordering (e.g. Ascending, Descending, Unordered). |
@schema/numberOfItems | The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/BroadcastEvent | Expected Type | Description |
---|---|---|
@schema/broadcastOfEvent | The event being broadcast such as a sporting event or awards ceremony. | |
@schema/isLiveBroadcast | True if the broadcast is of a live event. | |
@schema/subtitleLanguage | or | Languages in which subtitles/captions are available, in IETF BCP 47 standard format. |
@schema/videoFormat | The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.). |
Properties inherited from @schema/PublicationEvent | Expected Type | Description |
---|---|---|
@schema/free | A flag to signal that the item, event, or place is accessible for free. | |
@schema/publishedBy | or | An agent associated with the publication event. |
@schema/publishedOn | A broadcast service associated with the publication event. |
Properties inherited from @schema/Event | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/actor | An actor, e.g. in tv, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip. | |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/attendee | or | A person or organization attending the event. |
@schema/attendees | or | A person attending the event. |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/composer | or | The person or organization who wrote a composition, or who is the composer of a work performed at some event. |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/director | A director of e.g. tv, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip. | |
@schema/doorTime | or | The time admission will commence. |
@schema/duration | The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. | |
@schema/endDate | or | The end date and time of the item (in ISO 8601 date format). |
@schema/eventAttendanceMode | The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix. | |
@schema/eventSchedule | Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons. | |
@schema/eventStatus | An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled. | |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/location | , , or | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
@schema/maximumAttendeeCapacity | The total number of individuals that may attend an event or venue. | |
@schema/maximumPhysicalAttendeeCapacity | The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]). | |
@schema/maximumVirtualAttendeeCapacity | The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]). | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/organizer | or | An organizer of an Event. |
@schema/performer | or | A performer at the event—for example, a presenter, musician, musical group or actor. |
@schema/performers | or | The main performer or performers of the event—for example, a presenter, musician, or actor. |
@schema/previousStartDate | Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated. | |
@schema/recordedIn | The CreativeWork that captured all or part of this Event. | |
@schema/remainingAttendeeCapacity | The number of attendee places for an event that remain unallocated. | |
@schema/review | A review of the item. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/startDate | or | The start date and time of the item (in ISO 8601 date format). |
@schema/subEvent | An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference. | |
@schema/subEvents | Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference. | |
@schema/superEvent | An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent. | |
@schema/translator | or | Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
@schema/typicalAgeRange | The typical expected age range, e.g. '7-9', '11-'. | |
@schema/workFeatured | A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent). | |
@schema/workPerformed | A work performed in some event, for example a play performed in a TheaterEvent. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/ChooseAction | Expected Type | Description |
---|---|---|
@schema/actionOption | or | A sub property of object. The options subject to this action. |
@schema/option | or | A sub property of object. The options subject to this action. |
Properties inherited from @schema/Action | Expected Type | Description |
---|---|---|
@schema/actionStatus | Indicates the current disposition of the Action. | |
@schema/agent | or | The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book. |
@schema/endTime | or | The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/error | For failed actions, more information on the cause of the failure. | |
@schema/instrument | The object that helped the agent perform the action. e.g. John wrote a book with a pen. | |
@schema/location | , , or | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
@schema/object | The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book. | |
@schema/participant | or | Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve. |
@schema/result | The result produced in the action. e.g. John wrote a book. | |
@schema/startTime | or | The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
@schema/target | Indicates a target EntryPoint for an Action. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/DataFeed | Expected Type | Description |
---|---|---|
@schema/dataFeedElement | , or | An item within in a data feed. Data feeds may have many elements. |
Properties inherited from @schema/Dataset | Expected Type | Description |
---|---|---|
@schema/catalog | A data catalog which contains this dataset. | |
@schema/datasetTimeInterval | The range of temporal applicability of a dataset, e.g. for a 2011 census dataset, the year 2011 (in ISO 8601 time interval format). | |
@schema/distribution | A downloadable form of this dataset, at a specific location, in a specific format. | |
@schema/includedDataCatalog | A data catalog which contains this dataset (this property was previously 'catalog', preferred name is now 'includedInDataCatalog'). | |
@schema/includedInDataCatalog | A data catalog which contains this dataset. | |
@schema/issn | The International Standard Serial Number (ISSN) that identifies this serial publication. You can repeat this property to identify different formats of, or the linking ISSN (ISSN-L) for, this serial publication. | |
@schema/measurementTechnique | or | A technique or technology used in a [[Dataset]] (or [[DataDownload]], [[DataCatalog]]), corresponding to the method used for measuring the corresponding variable(s) (described using [[variableMeasured]]). This is oriented towards scientific and scholarly dataset publication but may have broader applicability; it is not intended as a full representation of measurement, but rather as a high level summary for dataset discovery. For example, if [[variableMeasured]] is: molecule concentration, [[measurementTechnique]] could be: "mass spectrometry" or "nmr spectroscopy" or "colorimetry" or "immunofluorescence". If the [[variableMeasured]] is "depression rating", the [[measurementTechnique]] could be "Zung Scale" or "HAM-D" or "Beck Depression Inventory". If there are several [[variableMeasured]] properties recorded for some given data object, use a [[PropertyValue]] for each [[variableMeasured]] and attach the corresponding [[measurementTechnique]]. |
@schema/variableMeasured | or | The variableMeasured property can indicate (repeated as necessary) the variables that are measured in some dataset, either described as text or as pairs of identifier and description using PropertyValue. |
Properties inherited from @schema/CreativeWork | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/abstract | An abstract is a short description that summarizes a [[CreativeWork]]. | |
@schema/accessMode | The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. | |
@schema/accessModeSufficient | A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual. | |
@schema/accessibilityAPI | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). | |
@schema/accessibilityControl | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). | |
@schema/accessibilityFeature | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). | |
@schema/accessibilityHazard | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). | |
@schema/accessibilitySummary | A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." | |
@schema/accountablePerson | Specifies the Person that is legally accountable for the CreativeWork. | |
@schema/acquireLicensePage | or | Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/alternativeHeadline | A secondary title of the CreativeWork. | |
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/associatedMedia | A media object that encodes this CreativeWork. This property is a synonym for encoding. | |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/audio | , or | An embedded audio object. |
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/award | An award won by or for this item. | |
@schema/awards | Awards won by or for this item. | |
@schema/character | Fictional person connected with a creative work. | |
@schema/citation | or | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
@schema/comment | Comments, typically from users. | |
@schema/commentCount | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. | |
@schema/conditionsOfAccess | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | |
@schema/contentLocation | The location depicted or described in the content. For example, the location in a photograph or painting. | |
@schema/contentRating | or | Official rating of a piece of content—for example,'MPAA PG-13'. |
@schema/contentReferenceTime | The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. | |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/copyrightHolder | or | The party holding the legal copyright to the CreativeWork. |
@schema/copyrightNotice | Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. | |
@schema/copyrightYear | The year during which the claimed copyright for the CreativeWork was first asserted. | |
@schema/correction | , or | Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
@schema/creativeWorkStatus | or | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
@schema/creator | or | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
@schema/creditText | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | |
@schema/dateCreated | or | The date on which the CreativeWork was created or the item was added to a DataFeed. |
@schema/dateModified | or | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
@schema/datePublished | or | Date of first broadcast/publication. |
@schema/discussionUrl | A link to the page containing the comments of the CreativeWork. | |
@schema/editEIDR | or | An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
@schema/editor | Specifies the Person who edited the CreativeWork. | |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/encoding | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/encodings | A media object that encodes this CreativeWork. | |
@schema/exampleOfWork | A creative work that this work is an example/instance/realization/derivation of. | |
@schema/expires | Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. | |
@schema/fileFormat | or | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/hasPart | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). | |
@schema/headline | Headline of the article. | |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/interactionStatistic | The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. | |
@schema/interactivityType | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. | |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/isBasedOn | , or | A resource from which this work is derived or from which it is a modification or adaption. |
@schema/isBasedOnUrl | , or | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
@schema/isFamilyFriendly | Indicates whether this content is family friendly. | |
@schema/isPartOf | or | Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
@schema/keywords | , or | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/license | or | A license document that applies to this content, typically indicated by URL. |
@schema/locationCreated | The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. | |
@schema/mainEntity | Indicates the primary entity described in some page or other CreativeWork. | |
@schema/maintainer | or | A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
@schema/material | , or | A material that something is made from, e.g. leather, wool, cotton, paper. |
@schema/materialExtent | or | The quantity of the materials being described or an expression of the physical space they occupy. |
@schema/mentions | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/pattern | or | A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. |
@schema/position | or | The position of an item in a series or sequence of items. |
@schema/producer | or | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/publication | A publication event associated with the item. | |
@schema/publisher | or | The publisher of the creative work. |
@schema/publisherImprint | The publishing division which published the comic. | |
@schema/publishingPrinciples | or | The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
@schema/recordedAt | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. | |
@schema/releasedEvent | The place and time the release was issued, expressed as a PublicationEvent. | |
@schema/review | A review of the item. | |
@schema/reviews | Review of the item. | |
@schema/schemaVersion | or | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. |
@schema/sdDatePublished | Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] | |
@schema/sdLicense | or | A license document that applies to this structured data, typically indicated by URL. |
@schema/sdPublisher | or | Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit. |
@schema/size | , , or | A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. |
@schema/sourceOrganization | The Organization on whose behalf the creator was working. | |
@schema/spatial | The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. | |
@schema/spatialCoverage | The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
@schema/temporal | or | The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
@schema/temporalCoverage | , or | The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
@schema/text | The textual content of this CreativeWork. | |
@schema/thumbnailUrl | A thumbnail image relevant to the Thing. | |
@schema/timeRequired | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. | |
@schema/translationOfWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” | |
@schema/translator | or | Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
@schema/typicalAgeRange | The typical expected age range, e.g. '7-9', '11-'. | |
@schema/usageInfo | or | The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options. This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
@schema/version | or | The version of the CreativeWork embodied by a specified resource. |
@schema/video | or | An embedded video object. |
@schema/workExample | Example/instance/realization/derivation of the concept of this creative work. eg. The paperback edition, first edition, or eBook. | |
@schema/workTranslation | A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
Properties inherited from @schema/Thing | Expected Type | Description |
---|---|---|
@schema/additionalType | 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. | |
@schema/alternateName | An alias for the item. | |
@schema/description | A description of the item. | |
@schema/disambiguatingDescription | 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. | |
@schema/identifier | , or | 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. |
@schema/image | or | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
@schema/mainEntityOfPage | or | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
@schema/name | The name of the item. | |
@schema/potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
@schema/sameAs | 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. | |
@schema/subjectOf | or | A CreativeWork or Event about this Thing. |
@schema/url | URL of the item. |
Properties inherited from @schema/Course | Expected Type | Description |
---|---|---|
@schema/courseCode | The identifier for the [[Course]] used by the course [[provider]] (e.g. CS101 or 6.001). | |
@schema/coursePrerequisites | , or | Requirements for taking the Course. May be completion of another [[Course]] or a textual description like "permission of instructor". Requirements may be a pre-requisite competency, referenced using [[AlignmentObject]]. |
@schema/educationalCredentialAwarded | , or | A description of the qualification, award, certificate, diploma or other educational credential awarded as a consequence of successful completion of this course or program. |
@schema/hasCourseInstance | An offering of the course at a specific time and place or through specific media or mode of study or to a specific section of students. | |
@schema/numberOfCredits | or | The number of credits or units awarded by a Course or required to complete an EducationalOccupationalProgram. |
@schema/occupationalCredentialAwarded | , or | A description of the qualification, award, certificate, diploma or other occupational credential awarded as a consequence of successful completion of this course or program. |
Properties inherited from @schema/LearningResource | Expected Type | Description |
---|---|---|
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/competencyRequired | , or | Knowledge, skill, ability or personal attribute that must be demonstrated by a person or other entity in order to do something such as earn an Educational Occupational Credential or understand a LearningResource. |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
Properties inherited from @schema/CreativeWork | Expected Type | Description |
---|---|---|
@schema/about | The subject matter of the content. | |
@schema/abstract | An abstract is a short description that summarizes a [[CreativeWork]]. | |
@schema/accessMode | The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. | |
@schema/accessModeSufficient | A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Expected values include: auditory, tactile, textual, visual. | |
@schema/accessibilityAPI | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). | |
@schema/accessibilityControl | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). | |
@schema/accessibilityFeature | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). | |
@schema/accessibilityHazard | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). | |
@schema/accessibilitySummary | A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." | |
@schema/accountablePerson | Specifies the Person that is legally accountable for the CreativeWork. | |
@schema/acquireLicensePage | or | Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
@schema/aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
@schema/alternativeHeadline | A secondary title of the CreativeWork. | |
@schema/assesses | or | The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
@schema/associatedMedia | A media object that encodes this CreativeWork. This property is a synonym for encoding. | |
@schema/audience | An intended audience, i.e. a group for whom something was created. | |
@schema/audio | , or | An embedded audio object. |
@schema/author | or | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
@schema/award | An award won by or for this item. | |
@schema/awards | Awards won by or for this item. | |
@schema/character | Fictional person connected with a creative work. | |
@schema/citation | or | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
@schema/comment | Comments, typically from users. | |
@schema/commentCount | The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. | |
@schema/conditionsOfAccess | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". | |
@schema/contentLocation | The location depicted or described in the content. For example, the location in a photograph or painting. | |
@schema/contentRating | or | Official rating of a piece of content—for example,'MPAA PG-13'. |
@schema/contentReferenceTime | The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. | |
@schema/contributor | or | A secondary contributor to the CreativeWork or Event. |
@schema/copyrightHolder | or | The party holding the legal copyright to the CreativeWork. |
@schema/copyrightNotice | Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. | |
@schema/copyrightYear | The year during which the claimed copyright for the CreativeWork was first asserted. | |
@schema/correction | , or | Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
@schema/creativeWorkStatus | or | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
@schema/creator | or | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
@schema/creditText | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | |
@schema/dateCreated | or | The date on which the CreativeWork was created or the item was added to a DataFeed. |
@schema/dateModified | or | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
@schema/datePublished | or | Date of first broadcast/publication. |
@schema/discussionUrl | A link to the page containing the comments of the CreativeWork. | |
@schema/editEIDR | or | An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television. For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J", has several edits e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3". Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
@schema/editor | Specifies the Person who edited the CreativeWork. | |
@schema/educationalAlignment | An alignment to an established educational framework. This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. | |
@schema/educationalLevel | , or | The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
@schema/educationalUse | or | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
@schema/encoding | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. | |
@schema/encodingFormat | or | Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
@schema/encodings | A media object that encodes this CreativeWork. | |
@schema/exampleOfWork | A creative work that this work is an example/instance/realization/derivation of. | |
@schema/expires | Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. | |
@schema/fileFormat | or | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
@schema/funder | or | A person or organization that supports (sponsors) something through some kind of financial contribution. |
@schema/genre | or | Genre of the creative work, broadcast channel or group. |
@schema/hasPart | Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). | |
@schema/headline | Headline of the article. | |
@schema/inLanguage | or | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
@schema/interactionStatistic | The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. | |
@schema/interactivityType | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. | |
@schema/isAccessibleForFree | A flag to signal that the item, event, or place is accessible for free. | |
@schema/isBasedOn | , or | A resource from which this work is derived or from which it is a modification or adaption. |
@schema/isBasedOnUrl | , or | A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
@schema/isFamilyFriendly | Indicates whether this content is family friendly. | |
@schema/isPartOf | or | Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
@schema/keywords | , or | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
@schema/learningResourceType | or | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
@schema/license | or | A license document that applies to this content, typically indicated by URL. |
@schema/locationCreated | The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. | |
@schema/mainEntity | Indicates the primary entity described in some page or other CreativeWork. | |
@schema/maintainer | or | A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
@schema/material | , or | A material that something is made from, e.g. leather, wool, cotton, paper. |
@schema/materialExtent | or | The quantity of the materials being described or an expression of the physical space they occupy. |
@schema/mentions | Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. | |
@schema/offers | or | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
@schema/pattern | or | A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. |
@schema/position | or | The position of an item in a series or sequence of items. |
@schema/producer | or | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
@schema/provider | or | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
@schema/publication | A publication event associated with the item. | |
@schema/publisher | or | The publisher of the creative work. |
@schema/publisherImprint | The publishing division which published the comic. | |
@schema/publishingPrinciples | or | The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
@schema/recordedAt | The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. | |
@schema/releasedEvent | The place and time the release was issued, expressed as a PublicationEvent. | |
@schema/review | A review of the item. | |
@schema/reviews | Review of the item. | |
@schema/schemaVersion | or | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to
indicate the use of a specific schema.org release, e.g. |
@schema/sdDatePublished | Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] | |
@schema/sdLicense | or | A license document that applies to this structured data, typically indicated by URL. |
@schema/sdPublisher | or | Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The [[sdPublisher]] property helps make such practices more explicit. |
@schema/size | , , or | A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. |
@schema/sourceOrganization | The Organization on whose behalf the creator was working. | |
@schema/spatial | The "spatial" property can be used in cases when more specific properties (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. | |
@schema/spatialCoverage | The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. | |
@schema/sponsor | or | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
@schema/teaches | or | The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
@schema/temporal | or | The "temporal" property can be used in cases where more specific properties (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
@schema/temporalCoverage | , or | The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content e.g. ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945". Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
@schema/text | The textual content of this CreativeWork. | |
@schema/thumbnailUrl | A thumbnail image relevant to the Thing. | |
@schema/timeRequired | Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. | |
@schema/translationOfWork | The work that this work has been translated from. e.g. 物种起源 is a translationOf “On the Origin of Species” | |
@schema/translator | or |