-
Notifications
You must be signed in to change notification settings - Fork 9
Providing Metadata
This page describes how sources should provide metadata for our crawling process
The preferred metadata attributes are based on existing metadata exchange specifications, especially LRMI and schema.org, where LRMI tries to integrate its attributes.
Like Google we recommend embedding structured data through JSON-LD (see here for Google-developer Guide). You can accomplish this easily with using a script-tag on your respective site (see below for an example).
We also recommend setting up a sitemap, if you haven't already done so. A sitemap will help crawlers to find the right pages to crawl. You can find information about how to set up a sitemap here.
Our system uses global identifiers for learningResourceType, audience and educational subject (referenced with about). Please check out http://w3id.org/openeduhub/vocabs/ for the respective vocabulary.
If you can supply this url-based identifiers as values in your metadata, this is the preferred way. However, if you're using a custom metadata scheme, please send us readable names (can be both de/en language) and our crawling process will automatically map them to our identifiers.
Dublin Core LRMI specifies how webpages can include additional metadata for learning objects. They can later be automatically crawled by other systems, including the crawlers from Open Edu Hub.
We recommend use of the following attributes ("!" marks a required element, "+" a strongly recommended one (generally: the more you supply, the better your resources will be found)).
For further information you might also want to have a look at the LRMI-Application-Profile "Allgemeines Metadatenprofil für BIldungsressourcen" currently being developed by the OER-Metadatengruppe.
-
@context(!) to link to the respective JSON-LD-context-document -
id(!) for URL/URI of learning resource (schema.org dereferencesidto@idsee: https://schema.org/docs/jsonldcontext.jsonld) -
type(!) for schema.org-type: should be at leastLearningResource, additional types can be added, e.g.Book,AudioObject,Courseetc. (see here for subtypes ofCreativeWork) (schema.org dereferencestypeto@typesee: https://schema.org/docs/jsonldcontext.jsonld) -
name(!) -
creator(+) -
description(+) -
about(-> references the educational subject)(+):- should refer to an established vocabulary (http://w3id.org/openeduhub/vocabs/discipline/). Reference to the vocabulary can be made like in the example. If you don't find your subject in there, either contact the vocabulary provider (open an issue at https://github.com/openeduhub/oeh-metadata-vocabs or just do
"about": "Mathematik"(though this is strongly discouraged)
- should refer to an established vocabulary (http://w3id.org/openeduhub/vocabs/discipline/). Reference to the vocabulary can be made like in the example. If you don't find your subject in there, either contact the vocabulary provider (open an issue at https://github.com/openeduhub/oeh-metadata-vocabs or just do
-
license(+) image-
thumbnailUrl(+) -
dateCreated(+) dateModifiedinLanguagepublisher-
learningResourceType(+):- same as in
about, a reference to an existing vocabulary is strongly recommended: http://w3id.org/openeduhub/vocabs/learningResourceType/
- same as in
-
audience(+):- same as in
about, a reference to an existing vocabulary is strongly recommended: http://w3id.org/openeduhub/vocabs/intendedEndUserRole/
- same as in
-
isBasedOnuse if you can provide it timeRequired-
educationalLevel:- same as in
about, a reference to an existing vocabulary is strongly recommended: http://w3id.org/openeduhub/vocabs/educationalLevel/
- same as in
-
oeh:educationalContext- same as in
about, a reference to an existing vocabulary is strongly recommended: http://w3id.org/openeduhub/vocabs/educationalContext/
- same as in
-
hasPartuse if you can link to other parts of the material typicalAgeRangeversion-
keywords(+)
Example for LRMI Metadata:
(Should be included in the <head> section of your HTML-Page, see here for example)
<script type="application/ld+json">
{
"@context": {
"id": "@id",
"type": "@type",
"@vocab": "http://schema.org/",
"oeh": "http://w3id.org/openeduhub/terms/"
},
"type": [
"LearningResource"
],
"id": "https://redaktion.openeduhub.net/edu-sharing/components/render/34efd4f9-737c-4071-8e52-e38f771b5433",
"identifier": "34efd4f9-737c-4071-8e52-e38f771b5433",
"name": "Chemie. Einige Gedanken",
"creator": [
{
"type": "Person",
"name": "Anja Müller"
},
{
"type": "Person",
"name": "Katharina Mahler"
}
],
"description": "Fragen zum Kenntnisstand, zum bisherigen Kontakt mit Chemie.",
"about": ["Biologie", "Chemie"],
"license": "https://creativecommons.org/licenses/by-sa/4.0/",
"thumbnailUrl": "https://redaktion.openeduhub.net/edu-sharing/preview?nodeId=34efd4f9-737c-4071-8e52-e38f771b5433&storeProtocol=workspace&storeId=SpacesStore&dontcache=1603109752629",
"dateCreated": "2020-07-15T19:14:36+02:00",
"dateModified": "2020-09-22T22:07:21+02:00",
"inLanguage": ["de"],
"publisher": [
{
"type": "Organization",
"name": "FWU Institut für Film und Bild in Wissenschaft und Unterricht gemeinnützige GmbH"
}
],
"learningResourceType": ["Experiment"],
"audience": ["Lehrer/in"],
"educationalLevel": ["9", "10"],
"oeh:educationalContext": ["Sekundarstufe 2"],
"typicalAgeRange": "10-14",
"version": "1.2",
"keywords": [
"Beruf"
]
}
</script>