1. Component Guide
  2. Machine readable metadata
  3. Dataset schema with attachments
Machine readable metadata example

Dataset schema with attachments

How it looks (preview)

<script type="application/ld+json">
  {
  "@context": "http://schema.org",
  "@type": "Dataset",
  "mainEntityOfPage": {
    "@type": "WebPage",
    "@id": "https://www.gov.ukgovernment/statistical-data-sets/hogwarts-data"
  },
  "name": "All the data about Hogwarts",
  "datePublished": null,
  "dateModified": null,
  "text": null,
  "publisher": {
    "@type": "Organization",
    "name": "GOV.UK",
    "url": "https://www.gov.uk",
    "logo": {
      "@type": "ImageObject",
      "url": "https://components.publishing.service.gov.uk/assets/govuk_publishing_components/govuk-logo-e5962881254c9adb48f94d2f627d3bb67f258a6cbccc969e80abb7bbe4622976.png"
    }
  },
  "image": [
    "https://components.publishing.service.gov.uk/assets/govuk_publishing_components/govuk-schema-placeholder-1x1-5ceffac04f7f6d4f421bd1d36dbb723ef48c15426d7f77f90be80a83af3c747e.png",
    "https://components.publishing.service.gov.uk/assets/govuk_publishing_components/govuk-schema-placeholder-4x3-fcfe16abb1a015848e50d2ea797666a9eaf5158dca38ddfb1e52dc8c0543ab74.png",
    "https://components.publishing.service.gov.uk/assets/govuk_publishing_components/govuk-schema-placeholder-16x9-fcf616879a7b37970df4d2117de962e08f7d057674ef1af6063dcdd529424eee.png"
  ],
  "distribution": [
    {
      "name": "List of headmasters",
      "contentUrl": "https://assets.publishing.service.gov.uk/hogwarts-data/headmasters.csv",
      "encodingFormat": "text/csv"
    },
    {
      "name": "Houses of Hogwarts",
      "url": "https://www.gov.uk/government/statistical-data-sets/hogwarts-data/houses"
    },
    {
      "name": "Dungeon cleaning shedule",
      "url": "https://hogwarts.gov.uk/datasets/dungeon-cleaning-schedule"
    }
  ]
}
</script>

<link rel="canonical" href="https://www.gov.ukgovernment/statistical-data-sets/hogwarts-data" />

<meta property="og:site_name" content="GOV.UK" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://www.gov.ukgovernment/statistical-data-sets/hogwarts-data" />
<meta property="og:title" content="All the data about Hogwarts" />
<meta property="og:description" content="" />

  <meta name="twitter:card" content="summary" />

How to call this example

<%= render "govuk_publishing_components/components/machine_readable_metadata", {
  content_item: {
    title: "All the data about Hogwarts",
    base_path: "government/statistical-data-sets/hogwarts-data",
    details: {
      attachments: [
        {
          attachment_type: "file",
          url: "https://assets.publishing.service.gov.uk/hogwarts-data/headmasters.csv",
          title: "List of headmasters",
          content_type: "text/csv",
          id: "headmasters.csv"
        },
        {
          attachment_type: "html",
          url: "https://www.gov.uk/government/statistical-data-sets/hogwarts-data/houses",
          title: "Houses of Hogwarts",
          id: "houses"
        },
        {
          attachment_type: "external",
          url: "https://hogwarts.gov.uk/datasets/dungeon-cleaning-schedule",
          title: "Dungeon cleaning shedule",
          id: "dungeon-cleaning-schedule"
        }
      ]
    }
  },
  schema: "dataset"
} %>