Skip to content
Snippets Groups Projects
README.md 3.66 KiB
Newer Older
Table of contents
-----------------
Jacob Rockowitz's avatar
Jacob Rockowitz committed

* Introduction
* Requirements
* Installation
* Configuration
Jacob Rockowitz's avatar
Jacob Rockowitz committed


Jacob Rockowitz's avatar
Jacob Rockowitz committed
------------

Jacob Rockowitz's avatar
Jacob Rockowitz committed
> The **Schema.org Blueprints module** provides perfect data structures (Schema.org),
Jacob Rockowitz's avatar
Jacob Rockowitz committed
> pristine APIs (JSON:API), and great SEO (JSON-LD).

Jacob Rockowitz's avatar
Jacob Rockowitz committed
The [Schema.org Blueprints](https://www.drupal.org/project/schemadotorg) module
uses [Schema.org](https://schema.org) as the blueprint for a Drupal website's
content architecture and structured data.
Jacob Rockowitz's avatar
Jacob Rockowitz committed

Jacob Rockowitz's avatar
Jacob Rockowitz committed
The best way to get started using the Schema.org Blueprints module is to read
about [Schema.org](https://schema.org) and browse the available
[schemas](https://schema.org/docs/schemas.html).
Jacob Rockowitz's avatar
Jacob Rockowitz committed

Jacob Rockowitz's avatar
Jacob Rockowitz committed
Once you understand Schema.org, please watch a
[short overview](https://youtu.be/XkZP6QjJkWs) or
[full demo](https://youtu.be/_kk97O1SEw0) of the Schema.org Blueprints module.
Jacob Rockowitz's avatar
Jacob Rockowitz committed

Jacob Rockowitz's avatar
Jacob Rockowitz committed
Additional documentation

- [docs/DECISIONS.md](https://git.drupalcode.org/project/schemadotorg/-/blob/1.0.x/docs/DECISIONS.md)
Jacob Rockowitz's avatar
Jacob Rockowitz committed
- [docs/ROADMAP.md](https://git.drupalcode.org/project/schemadotorg/-/blob/1.0.x/docs/ROADMAP.md)
- [docs/MODULES.md](https://git.drupalcode.org/project/schemadotorg/-/blob/1.0.x/docs/MODULES.md)
- [docs/DRUSH.md](https://git.drupalcode.org/project/schemadotorg/-/blob/1.0.x/docs/DRUSH.md)
- [docs/DEVELOPMENT.md](https://git.drupalcode.org/project/schemadotorg/-/blob/1.0.x/docs/DEVELOPMENT.md)

Jacob Rockowitz's avatar
Jacob Rockowitz committed

Jacob Rockowitz's avatar
Jacob Rockowitz committed
Features
--------

- Installs Schema.org CSV into Drupal
- Exposes Schema.org types and properties to Drupal modules
- Defines Schema.org mapping and mapping type entities
- Allow Schema.org types, properties, and names to be configured
- Build entity types and fields from Schema.org types and properties
Jacob Rockowitz's avatar
Jacob Rockowitz committed
- Ensure that Schema.org naming conventions work with Drupal's internal
Jacob Rockowitz's avatar
Jacob Rockowitz committed
  naming conventions
- Provides Drush commands to create and delete Schema.org mappings


Jacob Rockowitz's avatar
Jacob Rockowitz committed
------------

Jacob Rockowitz's avatar
Jacob Rockowitz committed
This module requires the Field, Text, and Options modules included with
Jacob Rockowitz's avatar
Jacob Rockowitz committed
Drupal core.


Jacob Rockowitz's avatar
Jacob Rockowitz committed
------------

Jacob Rockowitz's avatar
Jacob Rockowitz committed
Install the Schema.org Blueprints module as you would normally
[install a contributed Drupal module](https://www.drupal.org/node/1897420).
Jacob Rockowitz's avatar
Jacob Rockowitz committed

jrockowitz's avatar
jrockowitz committed
Use the included composer.libraries.json file to quickly install ALL 
sub-module dependencies.

As your Schema.org Blueprints project evolves, you may want to copy and adjust
the dependencies from the composer.libraries.json file into your project's
root composer.json.

Below is an example of what must be added to your projects composer.json file
to include Schema.org Blueprints dependencies. Adjust it to match the location 
of your contrib modules directory.


```
{
    "minimum-stability": "dev",
    "require": {
        "schemadotorg/schemadotorg/": "~1.0",
        "wikimedia/composer-merge-plugin": "^2.0"
    },
    "config": {
        "allow-plugins": {
            "cweagans/composer-patches": true,
            "wikimedia/composer-merge-plugin": true
        },
    },
    "extra": {
        "merge-plugin": {
            "include": [
                "web/modules/contrib/schemadotorg/composer.libraries.json",
            ],
            "merge-extra": true,
            "merge-extra-deep": true
        }
    }
}
```
Jacob Rockowitz's avatar
Jacob Rockowitz committed

Jacob Rockowitz's avatar
Jacob Rockowitz committed
-------------

jrockowitz's avatar
jrockowitz committed
- Configure 'Schema.org Blueprints' administer permission.  
  (/admin/people/permissions/module/schemadotorg)
jrockowitz's avatar
jrockowitz committed
- Review Schema.org types configuration.  
Jacob Rockowitz's avatar
Jacob Rockowitz committed
  (/admin/config/search/schemadotorg/settings/types)
jrockowitz's avatar
jrockowitz committed
- Review Schema.org properties configuration.  
Jacob Rockowitz's avatar
Jacob Rockowitz committed
  (/admin/config/search/schemadotorg/settings/properties)
jrockowitz's avatar
jrockowitz committed
- Review Schema.org naming conventions configuration.  
Jacob Rockowitz's avatar
Jacob Rockowitz committed
  (/admin/config/search/schemadotorg/settings/names)
jrockowitz's avatar
jrockowitz committed
- Review Schema.org mappings.  
Jacob Rockowitz's avatar
Jacob Rockowitz committed
  (/admin/config/search/schemadotorg)
jrockowitz's avatar
jrockowitz committed
- Review Schema.org mapping types.  
Jacob Rockowitz's avatar
Jacob Rockowitz committed
  (/admin/config/search/schemadotorg/types)