GitHub Twitter

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.


Contributors

The following people have been involved in the creation of this specification document. They are all members of the Training group.

Group Leader(s)
Other team members

Schema.org hierarchy

This Profile fits into the schema.org hierarchy as follows:

Thing > CreativeWork > LearningResource

Description

The Life Science Training Materials specification provides a way to describe bioscience training material on the World Wide Web. It defines a set of metadata and vocabularies, built on top of existing technologies and standards, that can be used to represent events in Web pages and applications. The goal of the specification is to make it easier to discover, exchange and integrate life science training material information across the Internet.

Summary of Changes

Changes since previous draft 0.7 of the TrainingMaterials profile:
  • Changes learningOutcomes (non existant property) to teaches
  • Changes featuredInEvent (non existant property) to recordedIn
  • Removes uses (non existant property, used for works used by this TtrainingMaterial) and reuses mentions for this purpose(before it was used only for other works referenced by this TrainingMaterial
  • Changes skillLevel (non existant property) to educationalLevel
  • Changes status (non existant property) to creativeWorkStatus
  • Changes tranlastedInto (non existant property) to workTranslation
  • Changes parent type to LearningResource, it was before CreativeWork, LearningResource extends it and is more appropriate
  • Changes prepared by L. Garcia

Latest profiles

Latest release: none

Latest draft: 0.8-DRAFT-2020_10_06

Previous profiles

Previous version: 0.7-DRAFT-2019_11_08


Group Use Cases Cross Walk Task & Issues Examples Live Deploys
Training

You can read the release version of this specification here.




Key to specification table

Schema.org properties where the Expected Types have been changed, or new (i.e., Bioschemas created) properties/types are green.

Schema.org properties/types are red.

Pending Schema.org properties/types are blue.

External (i.e., from 3rd party ontology) properties/types are black.


CD = Cardinality


View all examples
Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
description Text
Schema:

A description of the item.


ONE
View ≪description≫ example
keywords Text
Schema:

Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.


ONE
View ≪keywords≫ example
name Text
Schema:

The name of the item.


ONE
View ≪name≫ example
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

EDAM Topic Ontology

View ≪about≫ example
abstract Text
Schema:

An abstract is a short description that summarizes a CreativeWork.


ONE
View ≪abstract≫ example
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
View ≪audience≫ example
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
View ≪author≫ example
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
  • Beginner
  • Intermediate
  • Advanced
View ≪educationalLevel≫ example
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
View ≪identifier≫ example
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

IETF BCP 47 standard

View ≪inLanguage≫ example
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
View ≪learningResourceType≫ example
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
View ≪license≫ example
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
View ≪mentions≫ example
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

View ≪teaches≫ example
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

ISO 8601 duration format.

View ≪timeRequired≫ example
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
View ≪url≫ example
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
View ≪accessibilitySummary≫ example
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
View ≪contributor≫ example
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
  • Active
  • Under development
  • Archived
View ≪creativeWorkStatus≫ example
dateCreated Date
DateTime
Schema:

The date on which the CreativeWork was created or the item was added to a DataFeed.


ONE
View ≪dateCreated≫ example
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
View ≪dateModified≫ example
datePublished Date
DateTime
Schema:

Date of first broadcast/publication.


ONE
View ≪datePublished≫ example
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
View ≪hasPart≫ example
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
View ≪isPartOf≫ example
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
View ≪recordedAt≫ example
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
View ≪version≫ example
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
View ≪workTranslation≫ example

Top ▲