4. Training material formats and interoperability

Learning Outcomes

assess the degree of re-usability of training material
explain the concepts of re-usability, interoperability and extendibility for training material
develop presentation with narratives for each slides using Liascript

In this chapter we will touch on:

different types of training materials and its re-usability
different types of training materials and its interoperability
creating presentations with Liascript, a Markdown dialect or Google slides

4.1 Presentation

Here you can find the presentation for this session.

4.2 Formats for training material

Welcome, everyone! Today, we’re going to embark on an interactive journey to explore the diverse landscape of training materials in life sciences. Our activity is designed to not only identify the various formats available but also to reflect on our personal preferences and the rationale behind them.

Here is the activity: We’ll examine different types of training materials, ranging from slides and videos to datasets and software. For each category, we’ll determine the possible formats they could take. Then, we’ll dive deeper to discuss which formats we predominantly use and, most importantly, why we prefer those over others. This exercise will not only enhance our understanding of the material formats but also provide insights into our teaching methodologies. It’s a chance to share experiences, learn from each other, and possibly discover new ways to engage our audience. Let’s get started! Please open the ‘Answer’ tab as a guide for this reflection exercies. As we proceed, I encourage you to think critically about the ‘why’ — it’s the key to understanding our choices and improving our approach to training.

Discussion

How many training materials formats can you list? Identify possible formats for each type of material. Which format(s) do you mostly adopt? Why?

Answer as Table 1

Material type	Possible format(s)	Format(s) you mostly use	Why?
slides
video
dataset
repository
exercises
VM/Container
tutorial/hands-on
software
webpage

Compare your discussion results

Let’s take a moment to reflect on our recent discussions and how they align with the insights from the “10 simple rules” paper. Our conversation has highlighted the various formats we use to disseminate knowledge in life sciences, each with its own set of advantages and challenges. As we continue with our training, let’s consider how these formats serve our objectives and the ways in which we can leverage their strengths while mitigating their limitations.

Reflection

Compare your list of the slide formats from above to the formats mentioned in the ‘10 simple rules’ paper.

Answer as Table 1

Format	Advantages	Disadvantages
PPT and PPTX	Easily (re)usable	Limited way to provide detailed training instructions
	Available to multiple OSs/Software
	Widespread	Not version controlled
Keynote	Polished overall aesthetic	Limited to macOS family
		Not version controlled
PDF	Can be displayed identically in any environment	Not easily editable
		Not version controlled
TeX	Easily editable	Steep learning curve for trainers
	Version controlled
MD,RST and HTML	Version controlled	Rendering (need templating to transform into HTML)
	Free
Google slides	Version controlled	Not always possible to use owing to local/institutional policies
	Free	Not always accessible (depending on geographic location

Summary of training material file formats

We’re going to consolidate our understanding of the diverse resources we’ve been discussing. These resources form the backbone of our life science training and are crucial for a holistic learning experience.

Let’s take a brief tour through these resources¹:

Presentations: Our journey begins with presentations, the visual storytellers of complex concepts. They provide clear, structured information at a glance.

Website: A course website is your go-to destination of the knowledge, accessible anytime and anywhere, enriching your learning beyond the classroom.

Video: Our videos offer dynamic and engaging narratives, making complex topics digestible and memorable.

Guidelines: As checklists of our training, guidelines are your roadmap to best practices and essential procedures, ensuring you’re always on the right track.

Dataset: Our datasets are the real-world data playgrounds where you can apply and hone your analytical skills.

Tutorial: Our tutorials provide step-by-step guidance, helping you navigate through practical applications with ease.

Software: The gear of our toolkit, software training is where you’ll gain hands-on experience with the tools that drive life science research forward.

Each of these resources is valuable training material that supports your teaching approaches in the life sciences.

4.3 Training material crafted for collaboration

Training materials need to be captured in interoperable formats, so that they can be used in different contexts (e.g., operating systems and software tools) and built upon later. For materials like slides, it is important that other trainers are able to (re)use, fine-tune or even extend them. This means that you should choose a format that supports editing and extension.

Enhance your training materials via

Interoperability: Ensure your training materials are versatile. Use formats that are compatible across various operating systems and software platforms.
Reusability: Design your slides for longevity. Allow other trainers to adopt and adapt your materials with ease.
Editability & Extensibility: Select formats that support seamless editing and extension, enabling continuous improvement and customization.

How re-usable public training material are

Reflection

Have a look at the slides on the String Database (by Lars Juhl Jensen) on Slideshare. Imagine the slides were downloadable in pptx format. |

Could the presentation be extended?
Could you choose a few slides and incorporate them in your presentation?
Could you easily fix a typo?

Evaluate interoperability and re-usability of training material

Reflection

Consider the list of in table 1. For each format, specify whether it is interoperable, reusable or both and explain the reason for your opinion.

Formats	Interoperability	Reusability
pdf	partially	yes
	A pdf can be read in any OS, but to modify it you need to pay a licence	Only as is
…	yes/no/partially	yes/no/partially
	Explanation	Explanation

The more context you give about your material the better

For a lecture-style presentation, you can annotate each slide with an extensive narrative capturing all aspects of the subject on the slides. You can put the complete transcript of the verbal presentation in the Notes panel in Powerpoint or in Google slides. Suppose you want to share your slides in pdf format. In that case, it is handier to place the detailed content into a handbook or use text-book style reference materials and keep the slides for lectures cleaner, only placing relevant elements directly on the slides.
You may associate “Instructor notes” with the materials, but you don’t need to include them in the materials. The Instructor notes should provide information drawing on your experience or the experience of other instructors. They may consist of technical tips and tricks, common problems, and a description of what parts or exercises are essential and what could be skipped in case of lack of time. Very good examples of Instructor/Trainer notes are provided by the Carpentries (Carpentry Trainer notes, Instructor notes template).
You may create a lesson plan describing the purpose and the mode of delivery of each piece of material. Lesson plans could contain many practical details, including - for each part of the material - the time needed for the delivery, the learning experiences and expected learning outcomes.



narratives	instructor notes	lesson plan

4.3 Create and explore Interoperable and Reproducible training material (text, presentation)

In our session, we are using two different approaches - one using documents from the Google suite and another one using a markdown-based trainig material. Since many of use might have been using the Google suite already, let’s first have a look at example presentations using Liascript, a markdown dialect.

Example presentation

Rendering

File on Github

Exercise

Create a presentation (2-4 slides) using a markdown dialect called Liascript in the repository you have created in session 3. It is another markdown file which will be linked in the rendered form in the course template. Look at the documentation about Liascript in case you need some extra inspiration.

Exercise

Create a presentation using a Google slides. In the Google drive, create a presentation with 2-3 slides.

Exercise

Create a PDF with Liascript (additional installation needed). By using the Liascript exporter, you can create a static PDF or ePub docuemnt as well as educational content for Learning management systems.

4.5 Final considerations

When considering the re-usability and extendability of training materials, PDF documents offer limited flexibility due to their static nature, making them less adaptable for updates or interactive elements. HTML pages provide greater re-usability and extendability, allowing for dynamic content and easier updates. PowerPoint files are somewhat reusable but can be cumbersome to update and share collaboratively. Google Presentations enhance re-usability through cloud-based collaboration and real-time updates, though they still face limitations in format compatibility. Markdown-based material stands out for its high degree of re-usability and extendability, being easily editable, version-controlled, and convertible to various formats.

Looking ahead, the future of interoperable training material formats lies in developing standards that ensure seamless integration across platforms. Current gaps include inconsistent formatting, limited support for interactive elements, and challenges in maintaining version control across different tools. Addressing these gaps will be crucial for creating truly interoperable and user-friendly training materials.

https://docs.google.com/presentation/d/1fVbtwJACMnRM8GgMpGVfi373geFMQCZH6uSoihsRyxM/edit#slide=id.g26da19ef7b0_0_789 ↩