scieee AI-readable full text Open interactive document viewer

User friendly instructions on how to use Bioschemas for training events and materials

Botzki, Alexander; Palagi, Patricia M.; Piereck Moura, Bruna; Pilvar, Diana; Schnitzer, Helena; Sand, Olivier

Abstract

This deliverable is a publicly available, user-friendly guide on how to use Bioschemas fortraining events and materials, utilizing the ELIXIR Training Lesson template as foundationalinfrastructure. The objective is to provide the first comprehensive guide on Bioschemasannotation for training events and materials, addressing the current lack of such a resource.The guide is built on existing ELIXIR training material about TeSS, derived from the paper“Making Bioinformatics Training Events and Material More Discoverable Using TeSS, theELIXIR Training Portal” (https://doi.org/10.1002/cpz1.682), and technical documentationfrom the Bioschemas portal. It starts with foundational knowledge for non-technical endusers, covers intermediate topics of annotation using static site renderers like mkdocs andJekyll, and concludes with annotation of training material hosted on the popular WordPressContent Management System. The authors of this guide feel the need for future alignmentand collaboration with the members of the BioHackathon 2024 project 10, "Bioschemas forMortals," since a survey executed during this BioHackathon project identified a strong needfor such a guide. Furthermore, participants of the TeSS club and members of theBioschemas community contributed to the current content of the guide. This guide provides background information about the technical components to useBioschemas markup for training assets. This will assist existing and new technicalmaintainers in onboarding and provide clear instructions on using these technical websiterenderers together with Bioschemas markup. The resource and its documentation aredesigned to be open, easily maintained, and tailored for a non-technical audience,promoting better adoption among training coordinators and providers across the Nodes.The integration of Bioschemas markup into ELIXIR-branded training events and materialswill facilitate automatic population when in use, enhancing accessibility and sustainability.

Full text

ELIXIR Commissioned Service Report for Milestones Document info Title User friendly instructions on how to use Bioschemas for training events and materials Deliverable/Milestone Number D2.7 Responsible Participant Alexander Botzki WP Number WP2 Dissemination level PU Version history Version Revised by Date Comment 0.1 draft 10/11/2024 1.0.0 Alexander Botzki 23/12/2024 1.0.1 reviewers: Patricia Palagi Helena Schnitzer Alexander Botzki Diana Pilvar Olivier Sand 08/01/2025 rephrasing of several sentences to clarify meaning 1.0.2 Alexander Botzki 24/01/2025 final draft version Admin Check by Hub (CoS Portfolio Manager) (To revise section X) Content Check by Hub (Programme Manager) 1 Author List Node (ISO 2 letter country code or (eg: EMBL-EBI) Institute (no address) Name, surname ORCID Email BE VIB Alexander Botzki 0000-0001-669 1-4233 alexander.botzki@vi b.be BE VIB Bruna Piereck Moura 0000-0001-595 8-0669 bruna.piereckmoura @vib.be CH SIB Patricia Palagi 0000-0001-906 2-6303 [email protected] wiss DE FZ Jülich Helena Schnitzer 0000-0002-638 2-9452 h.schnitzer@fz-juelic h.de EE Tartu University Diana Pilvar [email protected] FR IFB Olivier Sand olivier[email protected] Abbreviations and Acronyms ETrP ELIXIR Training Platform 2 Contents Document info 1 Version history 1 Author List 2 Abbreviations and Acronyms 3 Executive Summary 5 Outcomes and Impacts of the milestone 5 3 Executive Summary This deliverable is a publicly available, user-friendly guide on how to use Bioschemas for training events and materials, utilizing the ELIXIR Training Lesson template as foundational infrastructure. The objective is to provide the first comprehensive guide on Bioschemas annotation for training events and materials, addressing the current lack of such a resource. The guide is built on existing ELIXIR training material about TeSS, derived from the paper “Making Bioinformatics Training Events and Material More Discoverable Using TeSS, the ELIXIR Training Portal” (https://doi.org/10.1002/cpz1.682), and technical documentation from the Bioschemas portal. It starts with foundational knowledge for non-technical end users, covers intermediate topics of annotation using static site renderers like mkdocs and Jekyll, and concludes with annotation of training material hosted on the popular WordPress Content Management System. The authors of this guide feel the need for future alignment and collaboration with the members of the BioHackathon 2024 project 10, "Bioschemas for Mortals," since a survey executed during this BioHackathon project identified a strong need for such a guide. Furthermore, participants of the TeSS club and members of the Bioschemas community contributed to the current content of the guide. This guide provides background information about the technical components to use Bioschemas markup for training assets. This will assist existing and new technical maintainers in onboarding and provide clear instructions on using these technical website renderers together with Bioschemas markup. The resource and its documentation are designed to be open, easily maintained, and tailored for a non-technical audience, promoting better adoption among training coordinators and providers across the Nodes. The integration of Bioschemas markup into ELIXIR-branded training events and materials will facilitate automatic population when in use, enhancing accessibility and sustainability. Outcomes and Impacts of the deliverable The output for this deliverable was first drafted in Summer 2024. The course delves into the specifics of Bioschemas annotation, demonstrating how to apply it to an HTML page to enhance discoverability and interoperability. Following this introductory part, the guide explores the integration of Bioschemas with popular static site generators and content management systems, including Jekyll, Mkdocs, and WordPress. Each section provides practical examples and step-by-step instructions to ensure learners can effectively implement Bioschemas annotations in their own projects. This training is designed to equip participants with the skills needed to improve the visibility and accessibility of their training content on the web. 4 Figure 1: ELIXIR Bioschemas for Training Guide1 Subsequent feedback has been requested by the members of the ELIXIR Training Platform (October 2024 and November 2024) as well as from the members of the TeSS club at various meetings. This milestone incorporates feedback from the TeSS team and the 'Bioschemas for Mortals' project, which identified key challenges for non-technical users and priority areas for improvement (Note: BioHackrXiv paper is coming soon). As a result, this work highlights synergies and cross-relationships with the BioHackathon 2024 project, further aligning efforts to address user needs effectively. The first version published as training material within the ELIXIR Training GitHub organisation using the ELIXIR Lesson template was released on the 30th of December 2024. Further workshops are planned in 2025 to extend the current content (e.g., with other Content Management Systems used for training material) supporting the work from the Biohackathon 2024 project 10. We also aim to add this material on the ELIXIR Training SPLASH website under the focus topic ‘FAIR training’. 1 https://elixir-europe-training.github.io/ELIXIR-TrP-Bioschemas/ 5