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
- Publisher
- Zenodo
- Language
- en
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 Se ice Repo
o Miles ones
Documen in o
Ti le
Use iendly ins uc ions on how o use Bioschemas o aining e en s and
ma e ials
Deli e able/Miles one
Numbe
D2.7
Responsible Pa icipan
Alexande Bo zki
WP Numbe
WP2
Dissemina ion le el
PU
Ve sion his o y
Ve sion
Re ised by
Da e
Commen
0.1
d a
10/11/2024
1.0.0
Alexande Bo zki
23/12/2024
1.0.1
e iewe s:
Pa icia Palagi
Helena Schni ze
Alexande Bo zki
Diana Pil a
Oli ie Sand
08/01/2025
eph asing o se e al sen ences o cla i y
meaning
1.0.2
Alexande Bo zki
24/01/2025
final d a e sion
Admin Check by Hub (CoS
Po olio Manage )
(To e ise sec ion X)
Con en Check by Hub
(P og amme Manage )
1
Au ho Lis
Node (ISO 2
le e coun y
code o
(eg: EMBL-EBI)
Ins i u e (no
add ess)
Name, su name
ORCID
Email
BE
VIB
Alexande
Bo zki
0000-0001-669
1-4233
alexande .bo zki@ i
b.be
BE
VIB
B una Pie eck
Mou a
0000-0001-595
8-0669
b una.pie eckmou a
@ ib.be
CH
SIB
Pa icia Palagi
0000-0001-906
2-6303
[email p o ec ed]
wiss
DE
FZ Jülich
Helena
Schni ze
0000-0002-638
2-9452
h.schni ze @ z-juelic
h.de
EE
Ta u Uni e si y
Diana Pil a
[email p o ec ed]
FR
IFB
Oli ie Sand
oli ie [email p o ec ed]
Abb e ia ions and Ac onyms
ET P
ELIXIR T aining Pla o m
2
Con en s
Documen in o 1
Ve sion his o y 1
Au ho Lis 2
Abb e ia ions and Ac onyms 3
Execu i e Summa y 5
Ou comes and Impac s o he miles one 5
3
Execu i e Summa y
This deli e able is a publicly a ailable, use - iendly guide on how o use Bioschemas o
aining e en s and ma e ials, u ilizing he ELIXIR T aining Lesson empla e as ounda ional
in as uc u e. The objec i e is o p o ide he fi s comp ehensi e guide on Bioschemas
anno a ion o aining e en s and ma e ials, add essing he cu en lack o such a esou ce.
The guide is buil on exis ing ELIXIR aining ma e ial abou TeSS, de i ed om he pape
“Making Bioin o ma ics T aining E en s and Ma e ial Mo e Disco e able Using TeSS, he
ELIXIR T aining Po al” (h ps://doi.o g/10.1002/cpz1.682), and echnical documen a ion
om he Bioschemas po al. I s a s wi h ounda ional knowledge o non- echnical end
use s, co e s in e media e opics o anno a ion using s a ic si e ende e s like mkdocs and
Jekyll, and concludes wi h anno a ion o aining ma e ial hos ed on he popula Wo dP ess
Con en Managemen Sys em. The au ho s o his guide eel he need o u u e alignmen
and collabo a ion wi h he membe s o he BioHacka hon 2024 p ojec 10, "Bioschemas o
Mo als," since a su ey execu ed du ing his BioHacka hon p ojec iden ified a s ong need
o such a guide. Fu he mo e, pa icipan s o he TeSS club and membe s o he
Bioschemas communi y con ibu ed o he cu en con en o he guide.
This guide p o ides backg ound in o ma ion abou he echnical componen s o use
Bioschemas ma kup o aining asse s. This will assis exis ing and new echnical
main aine s in onboa ding and p o ide clea ins uc ions on using hese echnical websi e
ende e s oge he wi h Bioschemas ma kup. The esou ce and i s documen a ion a e
designed o be open, easily main ained, and ailo ed o a non- echnical audience,
p omo ing be e adop ion among aining coo dina o s and p o ide s ac oss he Nodes.
The in eg a ion o Bioschemas ma kup in o ELIXIR-b anded aining e en s and ma e ials
will acili a e au oma ic popula ion when in use, enhancing accessibili y and sus ainabili y.
Ou comes and Impac s o he deli e able
The ou pu o his deli e able was fi s d a ed in Summe 2024. The cou se del es in o he
specifics o Bioschemas anno a ion, demons a ing how o apply i o an HTML page o
enhance disco e abili y and in e ope abili y. Following his in oduc o y pa , he guide
explo es he in eg a ion o Bioschemas wi h popula s a ic si e gene a o s and con en
managemen sys ems, including Jekyll, Mkdocs, and Wo dP ess. Each sec ion p o ides
p ac ical examples and s ep-by-s ep ins uc ions o ensu e lea ne s can effec i ely
implemen Bioschemas anno a ions in hei own p ojec s. This aining is designed o equip
pa icipan s wi h he skills needed o imp o e he isibili y and accessibili y o hei aining
con en on he web.
4
Figu e 1: ELIXIR Bioschemas o T aining Guide1
Subsequen eedback has been eques ed by he membe s o he ELIXIR T aining Pla o m
(Oc obe 2024 and No embe 2024) as well as om he membe s o he TeSS club a
a ious mee ings. This miles one inco po a es eedback om he TeSS eam and he
'Bioschemas o Mo als' p ojec , which iden ified key challenges o non- echnical use s
and p io i y a eas o imp o emen (No e: BioHack Xi pape is coming soon).
As a esul , his wo k highligh s syne gies and c oss- ela ionships wi h he BioHacka hon
2024 p ojec , u he aligning effo s o add ess use needs effec i ely.
The fi s e sion published as aining ma e ial wi hin he ELIXIR T aining Gi Hub
o ganisa ion using he ELIXIR Lesson empla e was eleased on he 30 h o Decembe 2024.
Fu he wo kshops a e planned in 2025 o ex end he cu en con en (e.g., wi h o he
Con en Managemen Sys ems used o aining ma e ial) suppo ing he wo k om he
Biohacka hon 2024 p ojec 10. We also aim o add his ma e ial on he ELIXIR T aining
SPLASH websi e unde he ocus opic ‘FAIR aining’.
1 h ps://elixi -eu ope- aining.gi hub.io/ELIXIR-T P-Bioschemas/
5