GitHub Twitter

TrainingMaterial DRAFT Profile

Version: 0.6-draft (06 June 2019)

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

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.





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.


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:

A short, succinct description of the resource.


ONE
View ≪abstract≫ example
audience Audience
Schema:

An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.


Bioschemas:

The type of audience intended for your course. A succinct description of the attendees. e.g. PhD Students, Post-docs, 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
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, but not actively used.

See ‘uses’ for resources that are being used.

MANY
View ≪mentions≫ example
skillLevel Text
Schema:

The students level of ability in the topic being taught. Examples of skill levels include ‘beginner’, ‘intermediate’ or ‘advanced’.


ONE
  • Beginner
  • Intermediate
  • Advanced
View ≪skillLevel≫ 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. ‘P30M’, ‘P1H25M’.


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.


ONE
View ≪url≫ example
uses Thing
Schema:

List resources utilized by this resource such as datasets, tools, technologies, or other entities.


Bioschemas:

Datasets, tools, technologies, entities etc, which will be utilized in this training material.

MANY
View ≪uses≫ 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
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
Schema:

Date of first broadcast/publication.


ONE
View ≪datePublished≫ example
featuredInEvent Event
Course
Schema:

The course instance or event where this training material was or will be featured. Inverse of workFeatured.


Bioschemas:

The course instance or event where this training material was or will be featured. Inverse of workFeatured.

Use isPartOf to refer to a Course, unless this training material is unique to a specific Course Instance.

MANY
View ≪featuredInEvent≫ example
hasPart CreativeWork
Trip
Schema:

Event


Bioschemas:

A sub-training material or externally referenced training material

MANY
View ≪hasPart≫ example
isPartOf CreativeWork
Schema:

Indicates a CreativeWork that this CreativeWork is (in some sense) 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 featuredIn property

MANY
View ≪isPartOf≫ example
learningOutcome Text
Schema:

Statements that describe what knowledge and skills a student will acquire from completing this training.


MANY

It is recommended you utilize terms from Blooms taxonomy

View ≪learningOutcome≫ example
status Text
Schema:

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.


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 ≪status≫ 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

Top ▲