Schema output documentation

Jump to bottom

Joost de Valk edited this page Apr 2, 2019 · 2 revisions

This will be moved to developer.yoast.com ASAP.

Homepage

Depending on whether the site represents a Person or a Company:

Organization
- @type: Organization
- @id: <homepage_url>#organization
- name: <site name>
- url: <homepage_url>
- sameAs: Array of social + WikiPedia URLs
- logo
  - @type: imageObject
  - @id: <homepage_url>#logo
  - url: <logo image URL>
  - caption: <site name>
- image - references logo
  - @id: <homepage_url>#logo
Person
- @type: Person
- @id: <homepage_url>#person
- name: <site name>
- description: <User bio>
- sameAs: Array of social + WikiPedia URLs
- image
  - @type: imageObject
  - @id: <homepage_url>#personlogo
  - url: <gravatar URL>
  - caption: <user display name>
Website
- @type: Website
- @id: <homepage_url>#website,
- url: <homepage_url>,
- name: <site name>,
- publisher - references Organization
  - @id: <homepage_url>#organization
- potentialAction
  - @type: SearchAction
  - target: <homepage_url>?s={search_term_string}
  - query-input: required name=search_term_string
WebPage
- @type: WebPage
- @id: <canonical>#webpage
- url: <canonical>
- inLanguage: <site language>
- name: <page title>
- description: <page description>
- isPartOf - references WebSite @id: <homepage_url>/#website
- image - when we have a featured image.
  - @type: ImageObject
  - @id: <canonical>#primaryimage
  - url: <image_url>
  - caption: <image caption>
- primaryImageOfPage - references image above @id: <canonical>#primaryimage

In case frontpage is a page, not an archive, treat like a single page.

Single page

WebPage, add these attributes:
- datePublished: <publication date>
- dateModified: <modification date>
- breadcrumb references BreadcrumbList
BreadcrumbList

Single posts

Like Single page.

Article:
- @id: <canonical>#article
- isPartOf - references WebPage
- mainEntityOfPage - references WebPage
- author - references Author
- publisher - references the Organization or Person the website represents.
- headline - page title (not SEO title).
- datePublished
- dateModified
- commentCount
- image references the #primaryimage if available.
- keywords - a comma separated list of post tags.
- sections - a comma separated list of the post's categories.
Author: only shows up when the website represents an Organization or the author is not the Person the website represents.
- @type: Person
- url: points to the author's posts archive.
- Just like Person on Homepage.

Taxonomy & date archives

Like Single page.

WebPage
- @type becomes CollectionPage

Post type archives

Like Single page.

WebPage
- @type becomes CollectionPage

Author archives

Like Single page.

WebPage
- @type becomes ProfilePage
Person
- @type: Person
- @id: <canonical>#person
- mainEntityOfPage: <canonical>#webpage
- name: <person display name>
- description: <User bio>
- sameAs: Array of social + WikiPedia URLs
- image
  - @type: imageObject
  - @id: <homepage_url>#personlogo
  - url: <gravatar URL>
  - caption: <user display name>

Search result pages

Like Single page.

WebPage:
- @type becomes SearchResultsPage

404 or other error pages

Remove WebPage.