-
-
Notifications
You must be signed in to change notification settings - Fork 173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added schema.org JSON-LD to lesson #226
base: main
Are you sure you want to change the base?
Changes from all commits
521fa60
b13ce0d
0e21629
40f1dfa
29d8bda
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Overall title for pages. | ||
title: "Lesson Title" | ||
|
||
# Metadata | ||
# Here you can add metadata to describe your lesson | ||
# so that people and search engines can understand what it's about. | ||
# Please try to use fields from the Schema.org CreativeWork type - https://schema.org/CreativeWork | ||
description: "This is the template description. Keep me brief (2-3 sentences)" | ||
keywords: # see: https://schema.org/keywords | ||
- GitHub | ||
- Forking | ||
- Collaborative | ||
audience: # see: https://schema.org/audience | ||
- PostDoc students | ||
- Early Career Researchers | ||
license: "https://creativecommons.org/licenses/by/3.0/" # see: schema.org/license | ||
author: # see: https://schema.org/author | ||
- Homer Simpson | ||
- Ned Flanders | ||
contributor: # see: https://schema.org/contributor | ||
- Barney Gumball | ||
- Dr Nick Riviera | ||
timeRequired: "1 hour" # see: https://schema.org/timeRequired | ||
learningResourceType: "lesson plan" # see: https://schema.org/learningResourceType | ||
citation: "How to cite a Training Material, John Smith et al, 2015" # see: https://schema.org/citation |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
<!-- Schema.org annotations in JSON-LD for a CreativeWork type. | ||
Variables should be declared in the .md file | ||
For full list of available attributes see https://schema.org/CreativeWork --> | ||
<script type="application/ld+json"> | ||
{ | ||
"@context": "http://schema.org/", | ||
"@type": "creativeWork", | ||
"genre": "trainingMaterial", | ||
"name": "{{site.data.lesson.title}}", | ||
"description": "{{site.data.lesson.description}}", | ||
"keywords": "{{site.data.lesson.keywords}}", | ||
"audience": [ | ||
{% for audience in site.data.lesson.audience %}{ | ||
"@type": "Audience", | ||
"name": "{{audience}}" | ||
}{% if forloop.last %}{%else%},{%endif%} | ||
{% endfor %} | ||
], | ||
"license": "{{site.data.lesson.licence}}", | ||
"author": [ | ||
{% for author in site.data.lesson.author %}{ | ||
"@type": "Person", | ||
"name": "{{author}}" | ||
}{% if forloop.last %}{%else%},{%endif%} | ||
{% endfor %} | ||
], | ||
"contributor": [ | ||
{% for contributor in site.data.lesson.contributor %}{ | ||
"@type": "Person", | ||
"name": "{{contributor}}" | ||
}{% if forloop.last %}{%else%},{%endif%} | ||
{% endfor %} | ||
], | ||
"timeRequired": "{{site.data.lesson.timeRequired}}", | ||
"learningResourceType": "{{site.data.lesson.learningResourceType}}", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How is it different from There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Genre" is replaced by "About" now. LerningResourcesType, that can be video lecture, e-learning module, handout etc. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no, it's an open list. More info here: https://schema.org/learningResourceType There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, it's an open list for now. I have been tempted to create a vocab but making and maintaining an exhaustive list would be an overhead to big for its benefit right now. |
||
"citation": "{{site.data.lesson.citation}}", | ||
"dateCreated" : "{{ "now" | date: "%Y-%m-%d" }}" | ||
} | ||
</script> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Author and contributor are vague terms as lessons are being developed by the community. There is an initial author and then there is an army of contributors. Giving proper credits is important, but it should probably happen on a separate page
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The distinction between author and contributor:
Author: Preparation, creation and/or presentation of the published work, specifically writing the initial draft;
Contributor: a critical review, commentary or revision;
We need this information in metadata. We may reuse it to display on the separate page.