Providing embedded metadata

List view

Most websites which provide data relevant to NFDI4Culture already feature a paginated list view to get an overview of the available content as well as individual resource pages. The list view is the simplest place to add CGIF-compatible markup as it usually features all content that can be included in the knowledge graph. In addition, the CGIF crawler only needs to page through all list views to get the data instead of also requesting every individual resource page (saves bandwidth and CPU load for the harvested sites).

The following code is used inside the <head></head> of a website's HTML.

<script type="application/ld-json">
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#",
    "schema": "http://schema.org/"
  },
  "@id": "https://corpusvitrearum.de/cvma-digital/bildarchiv.html",
  "@language": "de",
  "@type": [ "schema:Dataset", "schema:DataFeed", "hydra:Collection" ],
  "schema:name": "Bildarchiv des Corpus Vitrearum Deutschland",
  "schema:dateModified": {
    "@type": "schema:Date",
    "@value": "2023-03-25"
  },
  "schema:includedInDataCatalog": {
    "@id": "https://corpusvitrearum.de",
    "@type": "schema:DataCatalog",
    "schema:name": "Corpus Vitrearum Deutschland",
    "schema:publisher": {
      "@id": "https://nfdi4culture.de/id/E1834",
      "@type": "schema:Organization"
    }
  },
  "schema:dataFeedElement": [
    {
      "@type": "schema:DataFeedItem",
      "schema:item": {
        "@id": "https://corpusvitrearum.de/id/F3436",
        "@type": "schema:ImageObject",
        "schema:name": "Heilige Sippe",
        "schema:license": {
          "@id": "https://creativecommons.org/publicdomain/zero/1.0/",
          "@type": "schema:URL"
        },
        "schema:temporalCoverage": {
          "@type": "schema:DateTime",
          "@value": "1495-01-01T00:00:00/1504-12-31T23:59:59"
        },
        "schema:keywords": [
          {
            "@id": "http://vocab.getty.edu/page/aat/300263722",
            "@type": "schema:DefinedTerm",
            "schema:inDefinedTermSet": {
              "@id": "http://vocab.getty.edu/page/aat/",
              "@type": "schema:DefinedTermSet"
            }
          },
          {
            "@id": "https://iconclass.org/73A22",
            "@type": "schema:DefinedTerm",
            "schema:inDefinedTermSet": {
              "@id": "https://iconclass.org/",
              "@type": "schema:DefinedTermSet"
            }
          },
          {
            "@id": "http://sws.geonames.org/11127701",
            "@type": "schema:DefinedTerm",
            "schema:inDefinedTermSet": {
              "@id": "https://geonames.org/",
              "@type": "schema:DefinedTermSet"
            }
          }
        ],
        "schema:image": {
          "@id": "https://corpusvitrearum.de/typo3temp/cvma/_processed_/pics/original/3436.jpg",
          "@type": "schema:URL"
        }
      }
    },
    { FURTHER ITEMS HERE }
  ],
  "hydra:totalItems": 7960,
  "hydra:view": {
    "@id": "https://corpusvitrearum.de/cvma-digital/bildarchiv.html?tx_cvma_archive%5B%40widget_0%5D%5BcurrentPage%5D=1&cHash=9c912833b01a3783ec31222221a4aeea",
    "@type": "hydra:PartialCollectionView",
    "hydra:first": {
      "@id": "https://corpusvitrearum.de/cvma-digital/bildarchiv.html",
      "@type": "hydra:PartialCollectionView"
    },
    "hydra:last": {
      "@id": "https://corpusvitrearum.de/cvma-digital/bildarchiv.html?tx_cvma_archive%5B%40widget_0%5D%5BcurrentPage%5D=160&cHash=aabb095374beb49c8931b44efffc1255",
      "@type": "hydra:PartialCollectionView"
    },
    "hydra:next": {
      "@id": "https://corpusvitrearum.de/cvma-digital/bildarchiv.html?tx_cvma_archive%5B%40widget_0%5D%5BcurrentPage%5D=2&cHash=7fd29a057f3c2ce869774e79471a49ee",
      "@type": "hydra:PartialCollectionView"
    },
    "hydra:previous": {
      "@id": "https://corpusvitrearum.de/cvma-digital/bildarchiv.html?tx_cvma_archive%5B%40widget_0%5D%5BcurrentPage%5D=&cHash=5fbdea3da9613d748d2e52fbf7c92aa3",
      "@type": "hydra:PartialCollectionView"
    }
  }
}
</script>

Resource view

If you strive to make your data as machine-readable as possible or if your website does not have a list view, it is recommended to mark up individual resource pages and identify them as part of the data set. The example(s) below assume images as the type of resource, but you are free to indicate any other resource type your website provides.

The following code is used inside the <head></head> of a website's HTML.

<script type="application/ld-json">
{
  "@context": {
    "schema": "http://schema.org/"
  },
  "@id": "https://corpusvitrearum.de/id/F3436",
  "@language": "de",
  "@type": "schema:ImageObject",
  "schema:name": "Heilige Sippe",
  "schema:license": {
    "@id": "https://creativecommons.org/publicdomain/zero/1.0/",
    "@type": "schema:URL"
  },
  "schema:temporalCoverage": {
    "@type": "schema:DateTime",
    "@value": "1495-01-01T00:00:00/1504-12-31T23:59:59"
  },
  "schema:keywords": [
    {
      "@id": "http://vocab.getty.edu/page/aat/300263722",
      "@type": "schema:DefinedTerm",
      "schema:inDefinedTermSet": {
        "@id": "http://vocab.getty.edu/page/aat/",
        "@type": "schema:DefinedTermSet"
      }
    },
    {
      "@id": "https://iconclass.org/73A22",
      "@type": "schema:DefinedTerm",
      "schema:inDefinedTermSet": {
        "@id": "https://iconclass.org/",
        "@type": "schema:DefinedTermSet"
      }
    },
    {
      "@id": "http://sws.geonames.org/11127701",
      "@type": "schema:DefinedTerm",
      "schema:inDefinedTermSet": {
        "@id": "https://geonames.org/",
        "@type": "schema:DefinedTermSet"
      }
    }
  ],
  "schema:image": {
    "@id": "https://corpusvitrearum.de/typo3temp/cvma/_processed_/pics/original/3436.jpg",
    "@type": "schema:URL"
  },
  "schema:isPartOf": {
    "@id": "https://corpusvitrearum.de/cvma-digital/bildarchiv.html",
    "@type": [ "schema:Dataset", "schema:DataFeed" ],
    "schema:includedInDataCatalog": {
      "@id": "https://corpusvitrearum.de",
      "@type": "schema:DataCatalog",
      "schema:name": "Corpus Vitrearum Deutschland",
      "schema:publisher": {
        "@id": "https://nfdi4culture.de/id/E1834",
        "@type": "schema:Organization"
      }
    }
  }
}
</script>