Skip to content

Design implementation for changing schema page/post type #15055

@uxkai

Description

@uxkai

Product owner: @thijsdevalk
UX designer: @uxkai

What are we going to build?

Post/page editor
We need to add a tab called “Schema” to our metabox and our sidebar.

Allow WebPage and Article editing

  • On Page types, we should allow the user to alter the WebPage type.
  • On Post types (including custom posts), we should allow the user to alter the WebPage type and the Article type.
  • On custom post types, the default Article value should be ‘None’
  • When a user selects ‘None’, then the node in question should not be output.

The valid options should be sourced from https://schema.org/WebPage and https://schema.org/Article respectively (in addition to the default options).

Search appearance settings
In our Search Appearance > Content Types options, we should add similar controls which allow the user to set/override the default type for that post type.

Similarly to the in-post controls, Page types should only allow setting the WebPage, and Post types should also allow setting the Article type.

Which options can people choose from?

The options for WebPage:

  • Default for Posts* (Item Page) -> when for example Item Page is set as default on the settings pages
  • Web Page
  • Item Page
  • About Page
  • FAQ Page
  • QA Page
  • Profile Page
  • Contact Page
  • Medical Web Page
  • Collection Page
  • Checkout Page
  • Real Estate Listing
  • Search Results Page
  • – None –

The options for Article:

  • Default for Posts* (Article) -> when for example Article is set as default on the settings pages
  • Article
  • Social Media Posting
  • News Article
  • Advertiser Content Article
  • Satirical Article
  • Scholarly Article
  • Tech Article
  • Report
  • – None –

*= or Pages, or other post types. It depends on the post type you're working with.

What problem does it solve?

Right now, users are not able to control any aspect of the schema output within our settings, whether that’s in the settings section, or within the post editor.

Designs

Functional prototype

(This FontAwesome icon is used in the metabox tab.)

Design files

https://www.sketch.com/s/26aa4d89-ec08-4eed-97db-2f60d2db32cb


Wording considerations

  • In the type selection dropdowns, we should use the human-readable names (as above) of each schema article/page type.
  • In the Page/post editor, we should append (Default) to the default option for the post type in question (as inherited from the Search Appearance settings), and, pre-select this value in the selection interface.

Texts

Post/page editor
We need a small amount of generic copy to introduce the tab/section, before / independent of the changing page/post capabilities. This should remain relevant as/when we add more features to this section (to maintain continuity and to minimize localisation overheads). Provisionally, that copy is:

Yoast SEO automatically describes your pages using schema.org (?)
This helps search engines to understand your website and your content. You can change some of your settings for this page below.

The help link should point to https://yoast.com/structured-data-schema-ultimate-guide/ (until/unless we have something more specific).

Then, we need some copy specifically for the page/post setting changer. Provisionally, that copy is:

What type of page or content is this? (?)
You can change the default type for %post type plural% in your [%Search appearance settings URL%](Search Appearance settings).

  • The help link will point to a pending KB article, which @jono-alderson aims to write soon.
  • *Note the use of 'page or content' means we don't have to manage the different scenarios (pages vs posts, and page+article controls vs just page controls)

Search Appearance settings

Choose how your [pages|post_type_plural] should be described by default in your site's schema.org markup. You can change these settings for individual [pages|post_type_plural]. (?)

  • The question mark icon will point to a pending KB article, which @jono-alderson aims to write soon.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions