Frequently Asked Questions

Last updated on
23 April 2023

Problem/Solution

What problem is the Schema.org Blueprints module trying to solve?
The problem that the Schema.org Blueprints module is solving is that every organization, website, and application has different ways of structuring, defining, and documenting its content and data. The Schema.org Blueprints module solves this problem by building content models that are standardized, reusable, and easily shareable. The Schema.org Blueprints module uses the public Schema.org specification to create content types, fields/properties, and relationships that machines, developers, and search engines understand.

Schema.org

What is Schema.org?
Schema.org is a collaborative community activity with a mission to create, maintain, and promote schemas for structured data on the Internet, web pages, email messages, and beyond.
…
A shared vocabulary makes it easier for webmasters and developers to decide on a schema and get the maximum benefit for their efforts. It is in this spirit that the founders, together with the larger community, have come together - to provide a shared collection of schemas.
-- https://schema.org/

What is the purpose of schema.org?
"Schema.org is a joint effort, in the spirit of sitemaps.org, to improve the web by creating a structured data markup schema supported by major search engines. On-page markup helps search engines understand the information on web pages and provide richer search results. A shared markup vocabulary makes it easier for webmasters to decide on a markup schema and get the maximum benefit for their efforts. Search engines want to make it easier for people to find relevant information on the web. Markup can also enable new tools and applications that make use of the structure."
-- https://schema.org/docs/faq.html#0

Who is using Schema.org?
Google uses Schema.org's schemas to create enriched search results for organizations that include Schema.org data within their web pages. Organizations/sectors use Schema.org to share film reviews, restaurants, recipes, news, and more. You can use the Schema.org Validator or the Validate Schema Chrome extension to view any website's Schema.org data.

What is the difference between Schema.org and Google's Structured Data?
Schema.org is a standard for defining structured data for all things, while Google's structured data requirements use a subset of Schema.org's schemas recognized by only Google to provide enriched rich results to end users. Learn more about Google's Structured Data.

Schema.org-first

What is a Schema.org-first approach?
A Schema.org-first approach leverages Schema.org as the foundation for building content models using structured data, which is API-first, standardized, and universal.

What are the benefits of using a Schema.org-first approach?
A Schema.org-first approach ensures that all content models from conception are based on the public open standard provided by Schema.org. A Schema.org-first approach makes it easier to generate content models and APIs that are understandable and maintainable.

Who is using a Schema.org-first approach?
Some organizations and projects already examine Schema.org's types and properties when defining new content models and relationships. No one is currently taking a completely Schema.org-first approach, where their content models and relationships are generated based on the Schema.org specifications. It is more common for organizations to use Schema.org as an inspiration for their content models.

Why is Drupal the ideal CMS for a Schema.org-first approach?
Drupal provides an entity and field API that creates pristine data structures using a flexible and customizable content authoring experience. Drupal's Umami demo's content types are based on Schema.org content models. Drupal continues to lead the CMS market because of its freedom, flexibility, innovation, and lower costs (it is free).

Schema.org Blueprints

What is the Schema.org Blueprints module?
The Schema.org Blueprints module takes a Schema.org-first approach to building content models and structured data in Drupal. The Schema.org Blueprints module allows site builders to create and maintain content types, fields, and relationships based on the Schema.org specification.

What are the benefits of using the Schema.org Blueprints module?
The Schema.org Blueprints module makes it easier and faster for organizations to build their content and information architecture in Drupal using Schema.org as the foundation for their structured data.

  1. Standardization: Easier - Easy to understand with less thinking
    Leveraging Schema.org, an open and established standard, makes it easier for organizations to create a content and information architecture that is simple for API consumers and search engines to understand. Organizations and consumers can think less about their data structures and focus more on their content and user experiences.
  2. Simplification: Simpler - Simpler to build with fewer resources
    Having a standardized content, and information architecture removes the challenge of naming and relating things, making it easier to build rich content with fewer resources.
  3. Acceleration: Faster - Faster to implement with quicker development
    The Schema.org Blueprints module allows your organization's content and information architecture to be built in a few clicks. Out-of-the-box explanations for every schema type and property are provided with automated relationships.

Who should be using a Schema.org Blueprints module?
Anyone looking to future-proof their content models by adopting an open standard. Organizations who want to share content with other organizations and consumers. Websites looking to improve SEO by ensuring their content models can be exposed to search engines via Schema.org JSON-LD.

Why is this module called the Schema.org Blueprints module?
This module provides blueprints for standardized content models based on Schema.org. Blueprints, by their definition, are easy to alter and plan for the final product being constructed. Compared to distributions and starter kits which are prebuilt content models, you have to alter and reconfigure. The Schema.org Blueprints generates configuration compared to distributions and starter kits which ship with a predefined configuration.

Use-cases

How does the Schema.org Blueprints module work with headless and headful Drupal instances?
The Schema.org Blueprints module is designed to provide reliable and reusable content models. The provided content models apply to both headless and headful Drupal instances. Because headless Drupal instances expose their content models via APIs, the Schema.org Blueprints module can be more beneficial to headless/decoupled Drupal instances by providing well-documented and standardized APIs. At the same time, any website or application that is looking to future-proof its headful/traditional Drupal instance will benefit from having reliable and reusable content models that can be made available via APIs as requirements and features evolve.

When should I use or not use the Schema.org Blueprints?
The Schema.org Blueprints module can quickly become an organization's defacto tool for defining and maintaining its content models across multiple Drupal instances.

At the same time, some organizations and applications have predefined or legacy content models that need to be maintained. These organizations do not require any SEO benefits of exposing data via Schema.org JSON-LD.

Overview

What is the philosophy behind the Schema.org Blueprints module?

  • Standardization
    Standardization helps maximize compatibility, interoperability, repeatability, and quality.
  • Composition
    Composing an application using smaller components leads to better maintainability, stability, and support.
  • Configuration
    Provide reasonable default configuration while allowing everything to be customizable.
  • Automation
    Automating complex or time-consuming tasks saves time, energy, and money, leading to improvements in quality.

What are the primary goals of the Schema.org Blueprints module?
The primary goals of the Schema.org Blueprints module are to provide…

  • Perfect data structures using Schema.org
  • Pristine APIs via JSON:API
  • Great SEO through JSON-LD

Code

What APIs are supported by the Schema.org Blueprints module?
Currently, the Schema.org Blueprints module supports Drupal core's JSON:API by leveraging Schema.org's entity and property labels and descriptions to provide standardized and easy-to-understand APIs.

What hooks are provided by the Schema.org Blueprints module?
The Schema.org Blueprints module provides hooks to alter mappings, entity types, fields, and JSON-LD.

What are the available Drush commands for the Schema.org Blueprints module?
The Schema.org Blueprints module provides Drush commands to set up and tear down individual Schema.org types individually and groups/sets of related Schema.org types. For example, the drush schemadotorg:create-type user:Person would map Drupal's user entity type to a Schema.org Person. Another example is the drush schemadotorg:set-setup podcast command would build the entity types needed to create and manage a podcast series, seasons, and episodes.

Why does the Schema.org Blueprints module have so many sub-modules?
The Schema.org Blueprints module is broken down into smaller sub-modules to make it easier for developers to decide what functionality should be enabled. Leveraging smaller sub-modules makes it easier for developers to understand and contribute to discrete features or integrations.

How stable is the Schema.org Blueprints module's codebase?
Every aspect of the Schema.org Blueprints module includes test coverage. Developers working with development or alpha releases are encouraged to monitor the module's exportable configuration and make subtle changes as needed. Update hooks and upgrade paths will be provided between beta releases.

Headless

Is the Schema.org Blueprints module only intended for headless/decouple Drupal sites?
The Schema.org Blueprints module provides perfect data structures (Schema.org) with pristine APIs, which helps websites build and maintain decoupled front-ends. Any organization that foresees the need to share content with front-ends or third parties will benefit from having well-structured data.

What are other front-end frameworks supported by the Schema.org Blueprints module?
Currently, the Schema.org Blueprints module is experimenting with providing tools to support Next.js. Any front-end framework working with Drupal's APIs will benefit from perfect Schema.org data structures and pristine APIs using JSON:API.

Demo

What is the Schema.org Blueprints Demo module?
The Schema.org Blueprint Demo module provides an opinionated demo of the Schema.org Blueprints built on top of Drupal's standard profile with default content types, demo content, and translations.

Why does the demo include so many contributed modules?
The demo aims to provide the ideal content authoring and administration experience when building and managing generated Schema.org entity types and fields.

Why is the content authoring experience so crucial to the Schema.org Blueprints module?
An organization's content is only as good as its content authoring and administration tool. Drupal is increasingly being used as the backend content authoring tool and repository within a decoupled architecture.

Next.js

What is the Schema.org Blueprints Next.js module?
The Schema.org Blueprints Next.js module assists with integrating the Schema.org Blueprints module with Next.js. The Schema.org Blueprints Next.js demo provides a starting point for building a Next.js front-end for a Drupal site created using the Schema.org Blueprints module.

What is the future of the Schema.org Blueprints Next.js module?
The Schema.org Blueprints Next.js module and demo app could evolve to provide a better starting point for Next.js support. The Schema.org Blueprints Next.js module's code and concepts could be moved into the more popular Drupal Next.js module and starter kits.

Installation

How do I install the Schema.org Blueprints module?
The core Schema.org Blueprints module should be installed with some key submodules, including the UI and reports. Additional sub-modules should be enabled to improve support and integration with other contributed and core Drupal modules. Learn more about installing the Schema.org Blueprints module.

Every submodule includes a README.md file with an overview, configuration instructions, and notes. The Schema.org Blueprints module and submodules include reasonable default configuration.

How do I install the Schema.org Blueprints Demo module?
The Schema.org Blueprint Demo module's README.md file includes detailed instructions. The demo should only be installed on a new instance of Drupal. The demo's dependencies are downloaded and managed using a composer.libraries.json with the Composer merge plugin. The demo's modules and configuration are installed and set up using sub-modules, including the Schema.org Blueprint Demo Standard module, which provides a demo built on top of Drupal's Standard profile.

How do I install the Schema.org Blueprints Next.js module??
The Schema.org Blueprints Next.js assists with providing Next.js support for Schema.org entity types. There is also a demo of a Next.js application, which can be used as a starter kit or example.

Implementation

Can the Schema.org Blueprints module be used with an existing content model?
The Schema.org Blueprints module can be used to map an existing content model to Schema.org, or the module can be used to generate new or updated content models within an existing Drupal instance.

How should an existing Drupal site use the Schema.org Blueprints module?
Existing Drupal sites can either do a content model refactor within their current Drupal instance or create a new instance of Drupal using the Schema.org Blueprints module and do a Drupal to Drupal migration using Drupal core's migrate module.

How should a new or rebuilt Drupal site use the Schema.org Blueprints module?
The Schema.org Blueprints module includes Drush commands allowing developers to set up and tear down Schema.org types quickly. Developers working with content architects can decide on the desired Schema.org types and properties, and then iteratively and programmatically build and rebuild a Drupal instance's content models. Ideally, 80% of a Drupal instance’s content model can be constructed programmatically and exported into configuration. Once a content model is exported, additional improvements can be done manually using the Schema.org Blueprints module.

Contributing

How can I contribute code to the Schema.org Blueprints module?
The Schema.org Blueprints module is open source and hosted on Drupal.org. Everyone is welcome to contribute code, ideas, and suggestions.

How can I contribute content models to the Schema.org Blueprints module?
The ongoing goal of the Schema.org Blueprints module is to provide well-thought-out baseline content models for the most common Schema.org types, properties, and relationships. The best place to start understanding Schema.org types, properties, and relationships is to review the Schema.org website for definitions and examples. From there, generally, you have to search the web for Schema.org related articles and real-world examples.

Once you understand the Schema.org content models, you can create tickets in the Schema.org Blueprints issues queue to make suggestions. For Schema.org specific enhancements, you can create tickets in Schema.org's GitHub issue queue.

Similar modules/projects

What are some modules similar to the Schema.org Blueprints module?
Below are modules that support Schema.org's JSON-LD and generate content types based on Schema.org type and properties.

What are the differences between the Schema.org Metatag and the Schema.org Blueprints module?
The Schema.org Metatag attempts to map your custom content model to Schema.org's schemas. The Schema.org Blueprints module uses Schema.org's schemas to build and maintain a standardized and reusable content model.

Where does the Schema.org Blueprints module fit into Drupal's ecosystem of contributed distributions and recipes/starter kits?
The Schema.org Blueprints module allows site builders to configure and generate an exportable content model. Distributions and recipes/starter kits generally ship with predefined content models that are imported. For example, the Schema.org Blueprints module generates a BlogPosting entity that meets your organization's specific blogging use case. While a distribution or starter kit ships with their content model for blog posts, which is the same for all organizations.

Help improve this page

Page status: No known problems

You can: