Skip to content

Commit

Permalink
Update train_content.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sonjafiliposka committed Feb 9, 2024
1 parent 4794a93 commit eb0c551
Showing 1 changed file with 29 additions and 75 deletions.
104 changes: 29 additions & 75 deletions resources/03 Put it into practice/train_content.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,95 +13,49 @@ Introduction

## Learning Objectives

- min one learning objective using the verbs from the Blooms taxonomy
- analyse the FAIR-by-Design templates for learning materials
- use the RDA metadata schema for learning resources
- discover the trainer and learner content that should be defined for each learning unit

## Target Audience

- who is this learning unit meant for
- instructional designers, trainers

## Duration

- time needed to learn the provided content
- 1 hr

## Prerequisites

- list any knowledge that is required so that the learning unit can be followed
- familiarity with the FAIR-by-Design methodology stages
- familiarity with MD

## Learning Tools

- list any tools that are necessary to be used to complete the learning unit
- examples include required software, access to resources, etc.
- browser, online tools (HedgeDoc, CFFINIT)

## Learning Content Topic
## Discovering the elements of FAIR-by-Design learning materials

Here goes the content of the learning unit divided into a number of subtopics and any additional headings as necessary.
1. Review the structure of the templates repo
2. Create your own syllabus
- copy/paste the content of the syllabus.md file from the templates repo to a new note in HedgeDoc
- provide human-readable metadata
- provide machine-readable metadata
3. Analyse the content of LU (see the ToT repo for examples)
- learning content
- lesson plan
- activity description
- assessment
4. Create your own citation file
- copy/paste the content of the syllabus.md file from the templates repo into CFFINIT
- define the content of citation.cff
- check to ensure correct format
4. Apply the QA checklist
- pay attention to mandatory vs optional elements
- check the level of FAIRness of a chosen set of learning materials

Use blank rows to divide between paragraphs.

References to external or internal content provided elsewhere should be linked with [hyperlinks](https://pages.github.com/).

### Sub-subtitle

Refer to a different learning unit using a relative link. For an example, see the [Syllabus](../index.md) file.

*Example italic text*

**Example bold text**

### Lists

Example numbered bullets:

1. numbered list one
2. two
3. three

Example unnumbered list.

- unnumbered list
- item two
- item three
- subitem
- use 4 spaces to create nested subitem

You can also create mixed lists:

- mixed list
1. now numbered subitem
2. subitem number two
- back to mixed list level 1 bullet

### Images

To add an image, first place the image in the /attachments folder and then use a relative link similar to above using a ! in front.
All images should be located in the attachments folder that is on the same level with the content file.

![alternative text for accessibility an image of a macaw parrot](attachments/macaw-g8f80c4f64_640.jpg)

Caption: Macaw Parrot
Image by [Karina Copa](https://pixabay.com/users/kayuli-781524) from [Pixabay](https://pixabay.com)


Don't forget attribution if the image was not created by you. If you are reusing images or text clear attribution should be provided as in the example above. Same applies in case of reusing text or other type of content. Be careful to follow the attribution rules as provided by the image source (in the example above it is Pixabay).

### Accessibility

Using headings and subheadings, lists and alternative text for images is extremely important so as to ensure accessibility of the content for people with impairments. Also, take care to choose the appropriate color pallette for images.

### Tables

Tables are a bit tricky in md, the easiest way to create them is to use a tool that will generate the md code that you can then just copy paste in your content file.
One such tool that can be used is the [Markdown Tables Generator](https://www.tablesgenerator.com/markdown_tables) available online. The provided example table has been generated using this tool.

| **Column 1 title** | **Column 2 title** |
|--------------------|---------------------|
| content 1 | content 4 |
| content 2 | content 5 |
| content 3 | content 6 content 7 |

### Related Learning Materials

Refer to exercises, quizzes, games or other types of learning materials where ever they should be included in the unit and provide links to this content.


## Summary
Expand All @@ -110,6 +64,6 @@ At the end provide a short summary of the main points of the learning unit (thes

## Suggested Reading

- provide a list of references for further reading that should help clarify the content of the learning unit and elevate the knowledge level
- [Markdown guide](https://www.markdownguide.org/), free and open-source reference guide that explains how to use Markdown.

- [FAIR-by-Design Learning Materials Methodology Training of Trainers on GitHub](https://github.com/FAIR-by-Design-Methodology/FAIR-by-Design_ToT)
- [FAIR-by-Design Learning Materials Methodology Training of Trainers GitBook](https://fair-by-design-methodology.github.io/FAIR-by-Design_ToT/latest/)
- [FAIR-by-Design Learning Materials Methodology Templates Repository](https://github.com/FAIR-by-Design-Methodology/templates)

0 comments on commit eb0c551

Please sign in to comment.