How Bioschemas uses the training profiles with GitHub pages and Jekyll

In this how-to tutorial, we will show you how Bioschemas uses Jekyll layouts to include training profiles on their markup

Return to community tutorials overview

1. Overview

This tutorial will show you how Bioschemas uses Jekyll layouts to add markup to its pages. In particular, we will focus on profiles for training materials and courses. If you are interested in a more comprenhensive tutorial (more a hands-on than a demo like this one) on how to add Bioschemas markup to GitHub pages, you should visit our tutorial “Adding markup to GitHub pages”.

2. Bioschemas profiles for training resources

Many training related resources will include pages describing tutorials or courses. As such, they are marked up using the follwoing three profiles:

TrainingMaterial: A profile describing training materials in life sciences, it can be used on its own (as it happens with the Bioschemas tutorials) or in combination with a CourseInstance.
Course: A profile describing a course from a generic point of view, i.e., the learning objectives of a course rather than where and when it is delivered.
CourseInstance: A profile describing a particular instance of a course, i.e., an edition of a course that is scheduled for specific dates and happening in a specific location (that of course can be online or on-site, virtual or real).

Note that the CourseInstance profile is used in tandem with the Course profile, i.e., a CourseInstance does not exist without a Course but a Course can exist without a CourseInstance (there are no current offerings of the course).

More information on how to select the right profile and how to combine them is provided on the tutorial “Choosing a profile”.

3. How Bioschemas adds markup to its web pages

The Bioschemas website is hosted as a GitHub pages site. It uses Jekyll layouts to structure and display the content. The Bioschemas deafult layout includes a HTML tag that will be added to the HEAD element of every page.

<!DOCTYPE html>
<html lang="en">
<html>
  {% include head.html %}
  <body>
    {% include header.html %}
    {% include navbar.html %}
    <div class="container min-vh-100">
      <main id="main" class="my-5">
        {{ content }}
      </main>
    </div>
    {% include footer.html %}
  </body>
</html>

The head.html file looks within the page content for a YAML element named bioschemas. When this is found, it is included as a JSON block within the rendered page. Note that you need to inspect the page source code to view this content but it is discoverable to structured data harvesters such as seach engine crawlers.

<script type="application/ld+json">
  {{ page.bioschemas | jsonify }}
</script>

3. Example profiles for Bioschemas resources

Note: We are using examples that correspond to pages as they were displayed on the date that this tutorial was created (2022.08.24). If you explore those pages, some changes in the Bioschemas markup could have been introduced in upates after that date.

Marking up with the `TrainingMaterial` profile

The YAML header on the tutorial about “Adding markup to GitHub pages” includes a bioschemas attribute with the following properties.

bioschemas:
  "@context": https://schema.org/
  "@type": LearningResource
  "http://purl.org/dc/terms/conformsTo":
  - "@type": CreativeWork
    "@id": "https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE"
  about:
    - "@id": https://schema.org
    - "@id": http://edamontology.org/topic_0089
  audience:
  - "@type": Audience
    name: (Markup provider, Markup consumer) WebMaster, people deploying GitHub pages
  name: "Adding Schema.org to a GitHub Pages site"
  author:
  - "@type": Person
    name: "Niall Beard"
    "@id": https://bioschemas.org/people/NiallBeard
    url: https://bioschemas.org/people/NiallBeard
  contributor:
  - "@type": Person
    name: "Alasdair Gray"
    "@id": https://bioschemas.org/people/AlasdairGray
    url: https://bioschemas.org/people/AlasdairGray
  dateModified: 2021-07-22
  description: "This guide will show you how to do add Schema.org markup to a GitHub Pages site."
  keywords: "schemaorg, TeSS, GitHub pages"
  license: CC-BY 4.0
  version: 2.0

The YAML is processed by Jekyll to embed the following JSON-LD within the web page.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
  "@context":"https://schema.org/",
  "@type":"LearningResource",
  "http://purl.org/dc/terms/conformsTo":{
    "@type":"CreativeWork",
    "@id":"https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE"
  },
  "about":[{"@id":"https://schema.org"},{"@id":"http://edamontology.org/topic_0089"}],
  "audience":[
    {
      "@type":"Audience",
      "name":"(Markup provider, Markup consumer) WebMaster, people deploying GitHub pages"
    }
  ],
  "name":"Adding Schema.org to a GitHub Pages site",
  "author":[
    {
      "@type":"Person",
      "name":"Niall Beard",
      "@id":"https://bioschemas.org/people/NiallBeard",
      "url":"https://bioschemas.org/people/NiallBeard"
    }
  ],
  "contributor":[
    {
      "@type":"Person",
      "name":"Alasdair Gray",
      "@id":"https://bioschemas.org/people/AlasdairGray",
      "url":"https://bioschemas.org/people/AlasdairGray"
    }
  ],
  "dateModified":"2021-07-22",
  "description":"This guide will show you how to do add Schema.org markup to a GitHub Pages site.",
  "keywords":"schemaorg, TeSS, GitHub pages",
  "license":"CC-BY 4.0",
    "version":2.0
  }

Marking up with the `Course` and `CourseInstance` profiles

The YAML header on the meeting page course offered at the conference SWAT4HCLS 2022 includes the following bioschemas data. In this case we have a Course with a specific CourseInstance, the one corresponding to its edition for the SWAT4HCLS 2022 conference.

bioschemas:
  "@context": https://schema.org/
  "@type": Course
  "http://purl.org/dc/terms/conformsTo":
  - "@type": CreativeWork
    "@id": "https://bioschemas.org/profiles/Course/0.9-DRAFT-2020_12_08"
  description: "Bioschemas Tutorial at SWAT4HCLS Leiden"
  keywords: "Bioschemas, SWAT4HCLS, Schema validation, Harvesting markup, Deploying markup"
  name: "Bioschemas - Deploying and Harvesting Markup"
  hasPart:
    - "@type": LearningResource
      "@id": "https://dx.doi.org/10.4126/FRL01-006432243"
      "http://purl.org/dc/terms/conformsTo":
        - "@type": CreativeWork
          "@id": "https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE"
      description: "Bioschemas Tutorial at SWAT4HCLS Leiden"
      keywords: "Bioschemas, SWAT4HCLS, Schema validation, Harvesting markup, Deploying markup"
      name: "Bioschemas - Deploying and Harvesting Markup"
  hasCourseInstance:
    - "@type": CourseInstance
      "http://purl.org/dc/terms/conformsTo":
        - "@type": CreativeWork
          "@id": "https://bioschemas.org/profiles/CourseInstance/0.8-DRAFT-2020_10_06"
      courseMode: "online"
      location: "Virtual, and Fletcher Wellness-Hotel, Leiden, The Netherlands"
      startDate: "2022-01-10"
      endDate: "2022-01-10"
      inLanguage: en
      url: "https://www.swat4ls.org/workshops/leiden2022/"
      instructor:
        - "@type": Person
          name: "Alban Gaignard"
          "@id": https://bioschemas.org/people/AlbanGaignard
          url: https://bioschemas.org/people/AlbanGaignard
        - "@type": Person
          name: "Leyla Jael Castro"
          "@id": https://bioschemas.org/people/LeylaGarcia
          url: https://bioschemas.org/people/LeylaGarcia  
        - "@type": Person
          name: "Alasdair Gray"
          "@id": https://bioschemas.org/people/AlasdairGray
          url: https://bioschemas.org/people/AlasdairGray 

The YAML is processed by Jekyll to embed the following JSON-LD within the web page.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "@context":"https://schema.org/",
  "@type":"Course",
  "http://purl.org/dc/terms/conformsTo":{
    "@type":"CreativeWork",
    "@id":"https://bioschemas.org/profiles/Course/0.9-DRAFT-2020_12_08"
  },
  "description":"Bioschemas Tutorial at SWAT4HCLS Leiden",
  "keywords":"Bioschemas, SWAT4HCLS, Schema validation, Harvesting markup, Deploying markup",
  "name":"Bioschemas - Deploying and Harvesting Markup",
  "hasPart":[
    {"@type":"LearningResource",
    "@id":"https://dx.doi.org/10.4126/FRL01-006432243",
    "http://purl.org/dc/terms/conformsTo":{
      "@type":"CreativeWork",
      "@id":"https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE"
    },
    "description":"Bioschemas Tutorial at SWAT4HCLS Leiden",
    "keywords":"Bioschemas, SWAT4HCLS, Schema validation, Harvesting markup, Deploying markup",
    "name":"Bioschemas - Deploying and Harvesting Markup"
    }
  ],
  "hasCourseInstance":[
    {
      "@type":"CourseInstance",
      "http://purl.org/dc/terms/conformsTo":{
        "@type":"CreativeWork",
        "@id":"https://bioschemas.org/profiles/CourseInstance/0.8-DRAFT-2020_10_06"
      },
      "courseMode":"online",
      "location":"Virtual, and Fletcher Wellness-Hotel, Leiden, The Netherlands",
      "startDate":"2022-01-10",
      "endDate":"2022-01-10",
      "inLanguage":"en",
      "url":"https://www.swat4ls.org/workshops/leiden2022/",
      "instructor":[
        {
          "@type":"Person",
          "name":"Alban Gaignard",
          "@id":"https://bioschemas.org/people/AlbanGaignard",
          "url":"https://bioschemas.org/people/AlbanGaignard"
        },{
          "@type":"Person",
          "name":"Leyla Jael Castro",
          "@id":"https://bioschemas.org/people/LeylaGarcia",
          "url":"https://bioschemas.org/people/LeylaGarcia"
        },{
          "@type":"Person",
          "name":"Alasdair Gray",
          "@id":"https://bioschemas.org/people/AlasdairGray",
          "url":"https://bioschemas.org/people/AlasdairGray"
        }
      ]
    }
  ]
}

Note that the same page includes markup for the three training related profiles: the Course and CourseInstance profiles correspond to the actual page for the course (Bioschemas course at SWAT4HCLS 2022) while the TrainingMaterial element points to an external location with its own @id corresponding to DOI:FRL01-006432243.

Keywords: Schema.org, markup, structured data, Bioschemas, Training, Course, Bioschemas Training Group

Topics:

Audience:

(Markup provider, Markup consumer) People interested in adding Bioschemas markup to their own training resource when hosted via GitHub pages

Authors:

License: CC-BY 4.0

Version: 1.1

Last Modified: 07 September 2022