Skip to content

Commit 034fda0

Browse files
PhilReedDataPhilReedData
committed
Include definitions for materials and events
1 parent 97b2695 commit 034fda0

File tree

1 file changed

+173
-81
lines changed

1 file changed

+173
-81
lines changed

‎TeSS_docs/overview/definitions.md‎

Lines changed: 173 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -2,111 +2,203 @@
22

33
Definitions of terms and user roles used across TeSS.
44

5-
## Terms
5+
## Overall terms and concepts
66

7-
Definition of common terms used across TeSS.
7+
Definition of common terms used across TeSS, sorted alphabetically.
88

9-
### Content provider
9+
```{glossary}
1010
11-
Entities (such as academic institutions, non-profit organisations, portals) that provide training materials of relevance.
11+
Content provider
12+
Entities (such as academic institutions, non-profit organisations, portals) that provide training materials of relevance.
1213
14+
ELIXIR TeSS Portal
15+
The [ELIXIR TeSS](https://tess.elixir-europe.org/) portal, the training registry for Europe's distributed infrastructure for life-science data, is built using the TeSS Platform.
1316
14-
### ELIXIR TeSS Portal
17+
Event
18+
An event in TeSS is a link to a single training event sourced by a provider along with description and other meta information (e.g. date, location, audience, ontological categorization, keywords).
19+
20+
Training events can be added manually or automatically harvested from a provider's website.
1521
16-
The [ELIXIR TeSS](https://tess.elixir-europe.org/) portal, the training registry for Europe's distributed infrastructure for life-science data, is built using the TeSS Platform.
22+
Exchange (TeSS-X)
23+
If a community runs its own instance then a TeSS-X plugin sets up an exchange with other instances.
24+
In the mTeSS-X project, we will show how several TeSS-instance catalogues exchange nominated training resources.
25+
See [What do we mean by eXchange?](https://elixirtess.github.io/mTeSS-X/exchange) on the mTeSS-X project website for details.
1726
27+
Instance
28+
One installation of the TeSS Platform, on a server, managed by a technical administrator. An instance may have multiple spaces, if this option has been enabled by the administrator.
29+
30+
Examples of TeSS instances can be viewed on the [global usages page](global).
1831
19-
### Event
32+
Learning path
33+
A a pathway that guides learners through a set of modules (courses/materials) to be undertaken progressively (from lower- to higher-order thinking skills) to acquire the desired knowledge and skills on a subject by the end of the pathway.
2034
21-
An event in TeSS is a link to a single training event sourced by a provider along with description and other meta information (e.g. date, location, audience, ontological categorization, keywords).
35+
mTeSS-X
36+
The [mTeSS-X Project](mtess-x) (Multi-space Training e-Support System with eXchange) overcomes the fragmentation of training resources across Research Infrastructures and the European Science Clusters.
37+
The project aims to enhance existing TeSS-based training registries or catalogues like [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/) and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/) by building an aggregator for these and similar platforms.
2238
23-
Training events can be added manually or automatically harvested from a provider's website.
39+
Space (mTeSS)
40+
A single TeSS instance presents multiple tailored spaces (catalogues) whose selections of training material are “views” on a global catalogue.
41+
Each community registers, maintains and curates their material for their members in their own virtual space in the common portal environment.
42+
See [Introduction to spaces](../spaces/intro-spaces) for details.
2443
44+
TeSSHub
45+
The first TeSS instance with multiple spaces. This will be one of the outputs from the mTeSS-X project, where [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/) and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/) will be multipe spaces running from the same server, appearing as distinct catalogue.
46+
47+
Communities will be welcome to request their own space on the TeSSHub, providing them with their own registry, without the need to host and maintain their own instance.
2548
26-
### Exchange (TeSS-X)
49+
TeSS Platform
50+
The main codebase which is used for development, written in Ruby on Rails. The code is open source and [available on GitHub](https://github.com/ElixirTeSS/TeSS) under a BSD 3-Clause licence.
2751
28-
If a community runs its own instance then a TeSS-X plugin sets up an exchange with other instances.
29-
In the mTeSS-X project, we will show how several TeSS-instance catalogues exchange nominated training resources.
30-
See [What do we mean by eXchange?](https://elixirtess.github.io/mTeSS-X/exchange) on the mTeSS-X project website for details.
31-
32-
33-
### Instance
34-
35-
One installation of the TeSS Platform, on a server, managed by a technical administrator. An instance may have multiple spaces, if this option has been enabled by the administrator.
36-
37-
Examples of TeSS instances can be viewed on the [global usages page](global).
38-
39-
40-
### Learning path
41-
42-
A a pathway that guides learners through a set of modules (courses/materials) to be undertaken progressively (from lower- to higher-order thinking skills) to acquire the desired knowledge and skills on a subject by the end of the pathway.
43-
44-
45-
### mTeSS-X
46-
47-
The [mTeSS-X Project](mtess-x) (Multi-space Training e-Support System with eXchange) overcomes the fragmentation of training resources across Research Infrastructures and the European Science Clusters.
48-
The project aims to enhance existing TeSS-based training registries or catalogues like [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/) and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/) by building an aggregator for these and similar platforms.
49-
50-
51-
### Space (mTeSS)
52-
53-
A single TeSS instance presents multiple tailored spaces (catalogues) whose selections of training material are “views” on a global catalogue.
54-
Each community registers, maintains and curates their material for their members in their own virtual space in the common portal environment.
55-
See [Introduction to spaces](../spaces/intro-spaces) for details.
56-
57-
58-
### TeSSHub
59-
60-
The first TeSS instance with multiple spaces. This will be one of the outputs from the mTeSS-X project, where [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/) and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/) will be multipe spaces running from the same server, appearing as distinct catalogue.
61-
62-
Communities will be welcome to request their own space on the TeSSHub, providing them with their own registry, without the need to host and maintain their own instance.
63-
64-
65-
### TeSS Platform
66-
67-
The main codebase which is used for development, written in Ruby on Rails. The code is open source and [available on GitHub](https://github.com/ElixirTeSS/TeSS) under a BSD 3-Clause licence.
68-
69-
70-
### Training material
71-
72-
In the context of TeSS, a training material is a link to a single online training material sourced by a content provider (such as a text on a Web page, presentation, video) along with description and other meta information (e.g. ontological categorization, keywords).
73-
74-
Materials can be added manually or automatically harvested from a provider's website.
52+
Training material
53+
In the context of TeSS, a training material is a link to a single online training material sourced by a content provider (such as a text on a Web page, presentation, video) along with description and other meta information (e.g. ontological categorization, keywords).
54+
55+
Materials can be added manually or automatically harvested from a provider's website.
56+
```
7557

58+
## Materials
7659

60+
Definitions of fields used to describe training materials, sorted in the order they appear when editing a material.
61+
62+
```{glossary}
63+
Title
64+
A concise sentence that clearly indicates the topic of the training material.
65+
It should provide context and help learners understand what the material will cover.
66+
67+
Description
68+
A short, informative summary that outlines the purpose, scope, key topic and of the training material.
69+
It should help the learners and instructors understand the content and relevance of the training before engaging with it.
70+
71+
Resource Type
72+
The predominant category that describes the kind of learning material, for example, a presentation, video, handout, publication, poster.
73+
74+
Scientific Topics
75+
The scientific subject or field that the training material focuses on, for example, bioinformatics, genetics, biodiversity, genomics.
76+
77+
Keywords
78+
Free text about topics clearly identifying the training material.
79+
80+
License
81+
The most appropriate license that specifies the terms under which your training material and dataset can be used, modified, and distributed.
82+
Various options of licenses, for example, Creative Commons License are available to choose from.
83+
Free text is allowed if your license is not available in the menu.
84+
85+
Status
86+
The current state or stage of the training material indicating whether it is Active, Under development, or Archived.
87+
88+
Contact
89+
The individual responsible for communication regarding the training material, typically including name, affiliation, email address, and an ORCID identifier if possible.
90+
91+
DOI (Digital Object Identifier)
92+
A unique, persistent alphanumeric string assigned to the training material that provides a permanent link to its location for long-term accessibility and citation tracking.
93+
94+
Version
95+
A specific iteration or release of the training material document, labeled to track updates (for example, v1.0, v2.1).
96+
97+
Content Provider
98+
The organisation, institution, or individual responsible for providing, and maintaining the training material.
99+
100+
Authors
101+
Individuals who made substantial intellectual or technical contributions to the conception, design, execution of the training material.
102+
103+
Contributor
104+
Individuals or entities who provided specific assistance, technical input, data, or materials to the work but may not meet the full criteria for authorship.
105+
106+
Target Audience
107+
The intended group of users or learners for whom the training material is designed, such as researchers, students, postdocs, trainers.
108+
109+
Prerequisites
110+
The foundational knowledge, skills, or competencies that a learner or user must possess before engaging with the training content.
111+
112+
Competency Levels
113+
Gradations of expertise or proficiency expected of learners or users, categorised as beginner, intermediate, or advanced.
114+
115+
Learning Objectives
116+
Clearly defined, measurable statements describing the specific knowledge, skills a learner should acquire after completing the training course.
117+
118+
Events
119+
Workshops, seminars, conferences, summer or winter schools that contribute to or disseminate the training.
120+
121+
```
122+
123+
124+
## Events
125+
126+
Definitions of fields used to describe events, sorted in the order they appear when editing an event.
127+
128+
```{glossary}
129+
Type
130+
Describing the whether the event will be held Face-to-face, Online or both (hybrid).
131+
132+
Subtitle
133+
134+
URL
135+
Location where the event and its details are advertised on the internet.
136+
137+
Duration
138+
Time slot assigned/required for the event, for example, 2hrs, 2days.
139+
140+
Language of instruction
141+
The language in which the training/seminar/lecture will be delivered.
142+
Select from the list of available options.
143+
144+
Address, Venue, City, Region, Postcode
145+
Physical location of the event if its being conducted Face-to-face.
146+
147+
Eligibility
148+
Options for registration.
149+
To be chosen from one of the three: 1. First come first served, 2. Registration of Interest, 3. By invitation.
150+
151+
Organiser
152+
Institution/Organisation or the individual coordinating to organise the event.
153+
154+
Host institutions
155+
Institution/Organisation where the event will be held.
156+
157+
Capacity
158+
Maximum number of participants that can take part in the event.
159+
160+
Event type
161+
The category of an event based on its purpose, format, and activities.
162+
Can be chosen from the following options:
163+
- Awards and prizegivings
164+
- Meeting and conference
165+
- Receptions and networking
166+
- Workshops and courses
167+
168+
Nodes (ELIXIR Specific)
169+
The ELIXIR Node (Country) hosting the event
170+
171+
Sponsors
172+
Institution/Organisation or funding bodies that funded that event.
173+
174+
```
77175

78176
## Roles
79177

80178
Definitions of user roles in TeSS.
81179

82-
### Administrator
83-
84-
The technical administrator, responsible for installation, configuration and maintenance of a TeSS instance.
85-
86-
### Author
87-
88-
Individuals and organisations involved in the preparation, creation or presentation of the published work.
89-
90-
### Collaborator
91-
92-
An individual who has been granted editing rights to a material, topic or learning path by the individual (owner) who created it.
93-
94-
### Contributor
95-
96-
Individuals and organisations that contributed to the published work but are not authors.
97-
98-
### Curator
180+
```{glossary}
181+
Administrator
182+
The technical administrator, responsible for installation, configuration and maintenance of a TeSS instance.
99183
100-
An individual who has been granted permission to create a learning path in TeSS while following their community’s editorial process, or edit the materials associated with a content provider or node.
184+
Author
185+
Individuals and organisations involved in the preparation, creation or presentation of the published work.
101186
102-
### Editor (of a content provider)
187+
Collaborator
188+
An individual who has been granted editing rights to a material, topic or learning path by the individual (owner) who created it.
103189
104-
A person with editing rights to a content provider.
190+
Contributor
191+
Individuals and organisations that contributed to the published work but are not authors.
105192
106-
### Owner
193+
Curator
194+
An individual who has been granted permission to create a learning path in TeSS while following their community’s editorial process, or edit the materials associated with a content provider or node.
107195
108-
An individual who has created a material, topic or learning path in TeSS.
196+
Editor (of a content provider)
197+
A person with editing rights to a content provider.
109198
110-
### Space Manager
199+
Owner
200+
An individual who has created a material, topic or learning path in TeSS.
111201
112-
The person responsible for managing a space within an instance.
202+
Space Manager
203+
The person responsible for managing a space within an instance.
204+
```

0 commit comments

Comments
 (0)