Sha256: add0947613992a04505062ea4415f2e21c5ffca52540aa9f03b89847e9e9fe13

Contents?: true

Size: 1.81 KB

Versions: 8

Compression:

Stored size: 1.81 KB

Contents

name: Machine readable metadata
description: Generates schema.org JSON-LD for use by search engines
body: |
  This component doesn't output anything visible. It generates "structured data"
  in JSON-LD format, with [schema.org](http://schema.org) schemas.
accessibility_criteria: |
  The HTML should not be visible.
display_html: true
examples:
  default:
    data:
      content_item:
        title: "A title"
        base_path: "/foo"
        details: {}
      schema: :article

  with_description:
    data:
      content_item:
        title: "A title"
        base_path: "/foo"
        details: {}
      schema: :article
      description: "Some manually set description of the page"

  with_canonical_url:
    data:
      content_item:
        title: "A title"
        base_path: "/foo"
        details: {}
      schema: :article
      canonical_url: "https://www.gov.uk/foreign-travel-advice/andorra/health"
  with_body:
    data:
      content_item:
        title: "A title"
        base_path: "/foo"
        details: {}
      schema: :article
      body: "Some other body"
  person_schema:
    data:
      content_item:
        title: "A. Person"
        base_path: "/foo"
        details: {}
      schema: :person
  organisation_schema:
    data:
      content_item:
        title: "Ministry of Organisation"
        base_path: "/foo"
        details: {}
      schema: :organisation
  organisation_schema_with_related_orgs:
    data:
      content_item:
        title: "Magical Artefacts Agency"
        base_path: "/foo"
        details: {}
        links:
          ordered_parent_organisations:
            - title: "Ministry of Magic"
              base_path: "/ministry-of-magic"
          ordered_child_organisations:
            - title: "Dodgy Wands Commission"
              base_path: "/dodgy-wands-commission"
      schema: :organisation

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
govuk_publishing_components-11.1.0 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
govuk_publishing_components-11.0.0 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
govuk_publishing_components-10.2.0 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
govuk_publishing_components-10.1.0 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
govuk_publishing_components-10.0.0 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
govuk_publishing_components-9.28.0 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
govuk_publishing_components-9.27.0 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
govuk_publishing_components-9.26.1 app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml