TrainingMaterial DRAFT Profile
Version: 0.8-DRAFT-2020_10_06 (06 October 2020)
A specification for describing training materials in life sciences.
If you spot any errors or omissions with this type, please file an issue in our GitHub.
Key to specification table
- Green properties/types are proposed by Bioschemas, or indicate proposed changes by Bioschemas to Schema.org
- Red properties/types exist in the core of Schema.org
- Blue properties/types exist in the pending area of Schema.org
- Black properties/types are reused from external vocabularies/ontologies
CD = Cardinality
Property | Expected Type | Description | CD | Controlled Vocabulary | Example |
---|---|---|---|---|---|
Marginality: Minimum. | |||||
@context | URL | Used to provide the context (namespaces) for the JSON-LD file. Not needed in other serialisations. |
ONE | ||
@type | Text | Schema.org/Bioschemas class for the resource declared using JSON-LD syntax. For other serialisations please use the appropriate mechanism. While it is permissible to provide multiple types, it is preferred to use a single type. |
MANY | Schema.org, Bioschemas | |
@id | IRI | Used to distinguish the resource being described in JSON-LD. For other serialisations use the appropriate approach. | ONE | ||
dct:conformsTo | IRI | Used to state the Bioschemas profile that the markup relates to. The versioned URL of the profile must be used. Note that we use a CURIE in the table here but the full URL for Dublin Core terms must be used in the markup (http://purl.org/dc/terms/conformsTo), see example. |
ONE | Bioschemas profile versioned URL | |
description |
Text |
Schema: A description of the item. |
ONE | ||
keywords |
Text |
Schema: Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
ONE | ||
name |
Text |
Schema: The name of the item. |
ONE | ||
Marginality: Recommended. | |||||
about |
Thing |
Schema: The subject matter of the content. Inverse property: subjectOf. Bioschemas: The subject of this Training Material. Use the DefinedTerm type to add a controlled vocabulary term to describe the topic (such as from the EDAM ontology) |
MANY | ||
abstract |
Text |
Schema: An abstract is a short description that summarizes a CreativeWork. |
ONE | ||
audience |
Audience |
Schema: An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience. Bioschemas: A succinct description of the intended target audience for your materials: e.g., graduates, postgraduates, clinicians. |
MANY | ||
author |
Organization Person |
Schema: The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. Bioschemas: Those involved in the preparation, creation and/or presentation of the published work, specifically writing the initial draft |
MANY | ||
educationalLevel |
DefinedTerm Text URL |
Schema: The level in terms of progression through an educational or training context. Examples of educational levels include ‘beginner’, ‘intermediate’ or ‘advanced’, and formal sets of level indicators. Bioschemas: The students level of ability in the topic being taught. Examples of skill levels include ‘beginner’, ‘intermediate’ or ‘advanced’. |
ONE |
|
|
identifier |
PropertyValue Text URL |
Schema: The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. Bioschemas: An identifier for this resource such as a DOI or compact URI |
MANY | ||
inLanguage |
Language Text |
Schema: The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also availableLanguage. Supersedes language. Bioschemas: Defaults to English if not specified. Please choose a value from IETF BCP 47 standard. You can add multiple languages if the Training Material offers different translations |
MANY | ||
learningResourceType |
Text |
Schema: The predominant type or kind characterizing the learning resource. For example, ‘presentation’, ‘handout’. Bioschemas: This may include things such as video lecture, e-Learning module, or tutorial. |
MANY | ||
license |
CreativeWork URL |
Schema: A license document that applies to this content, typically indicated by URL. Bioschemas: If there is a licence it must be added. |
MANY | ||
mentions |
Thing |
Schema: Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. Bioschemas: Datasets, tools, technologies, entities etc, which are referred to by this training material or actively used in this training material. |
MANY | ||
teaches |
DefinedTerm Text |
Schema: The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
MANY | It is recommended that you utilize terms from the Blooms taxonomy |
|
timeRequired |
Duration |
Schema: Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. ‘PT30M’, ‘PT1H25M’. Bioschemas: The estimated time it takes to work through this resource. Please specify in ISO 8601 duration format. |
ONE | ||
url |
URL |
Schema: URL of the item. Bioschemas: The preferred URL of the Training Material. You must provide this value if it is known. |
ONE | ||
Marginality: Optional. | |||||
accessibilitySummary |
Text |
Schema: A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as “short descriptions are present but long descriptions will be needed for non-visual users” or “short descriptions are present and no long descriptions are needed.” |
ONE | ||
contributor |
Organization Person |
Schema: A secondary contributor to the CreativeWork or Event. Bioschemas: Contributors are those that made non-authorship contributions e.g. critical review, commentary or revision |
MANY | ||
creativeWorkStatus |
DefinedTerm Text |
Schema: The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. Bioschemas: The status of a training material. If this is not filled in it will be regarded as Active. Options are ‘Active’, ‘Under development’, and ‘Archived’. |
ONE |
|
|
dateCreated |
Date DateTime |
Schema: The date on which the CreativeWork was created or the item was added to a DataFeed. |
ONE | ||
dateModified |
Date DateTime |
Schema: The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed. |
ONE | ||
datePublished |
Date DateTime |
Schema: Date of first broadcast/publication. |
ONE | ||
hasPart |
CreativeWork |
Schema: Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). Inverse property: isPartOf. Bioschemas: A sub-training material or externally referenced training material |
MANY | ||
isPartOf |
CreativeWork URL |
Schema: Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. Inverse property: hasPart. Bioschemas: The Course this Training Material was/will be used in. Or a training material this training material is a part of (for example, if this is a module in a book, isPartOf can describe the book). Inverse property: hasPart If this varies in CourseInstances, use the workFeatured property |
MANY | ||
recordedAt |
Event |
Schema: The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. Inverse property: recordedIn. Bioschemas: The course instance or event where this training material was or will be featured. Use isPartOf to refer to a Course, unless this training material is unique to a specific Course Instance. |
MANY | ||
version |
Number Text |
Schema: The version of the CreativeWork embodied by a specified resource. Bioschemas: If this training material is versioned, its strongly recommended you use this property to list the version being displayed |
ONE | ||
workTranslation |
CreativeWork |
Schema: A work that is a translation of the content of this work. e.g. 西遊記 has an English workTranslation “Journey to the West”,a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. Inverse property: translationOfWork. |
MANY |