Skip to content

Commit ec2265d

Browse files
authored
Merge pull request #28 from ElixirTeSS/orcid
Add ORCID to docs
2 parents eebf7b8 + 2d4bfcd commit ec2265d

2 files changed

Lines changed: 77 additions & 10 deletions

File tree

TeSS_docs/overview/definitions.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ ELIXIR TeSS Portal
2222
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.
2323
2424
Event
25-
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).
26-
25+
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).
26+
In SciLifeLab TeSS, this is called a Course. <br>
2727
Training events can be added manually or automatically harvested from a provider's website.
2828
2929
Exchange (TeSS-X)
@@ -32,8 +32,7 @@ Exchange (TeSS-X)
3232
See [What do we mean by eXchange?](https://elixirtess.github.io/mTeSS-X/exchange) on the mTeSS-X project website for details.
3333
3434
Instance
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-
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. <br>
3736
Examples of TeSS instances can be viewed on the [global usages page](global).
3837
3938
Learning path
@@ -50,14 +49,13 @@ Space (mTeSS)
5049
See [Introduction to spaces](../spaces/intro-spaces) for details.
5150
5251
TeSSHub
53-
The platform name for a TeSS instance with multiple [spaces](#term-Space-mTeSS)
52+
The strategic name for a TeSS instance with multiple [spaces](#term-Space-mTeSS)
5453
that can [exchange](#term-Exchange-TeSS-X) materials with other instances.
5554
The TeSSHub is one of the outputs from the mTeSS-X project,
5655
where [ELIXIR TeSS (life sciences)](https://tess.elixir-europe.org/)
5756
and [PaN-Training (photon and neutron)](https://www.panosc.eu/training-catalogue/)
5857
will be running multipe spaces from the same server, appearing as distinct catalogues,
59-
and can share relevant materials.
60-
58+
and can share relevant materials. <br>
6159
Communities may be welcome to [request their own space](../spaces/instance-or-space/)
6260
on a TeSSHub, providing them with their own registry,
6361
without the need to host and maintain their own instance.
@@ -66,8 +64,7 @@ TeSS Platform
6664
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.
6765
6866
Training material
69-
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).
70-
67+
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). <br>
7168
Materials can be added manually or automatically harvested from a provider's website.
7269
7370
Workflow
@@ -93,7 +90,9 @@ Resource Type
9390
The predominant category that describes the kind of learning material, for example, a presentation, video, handout, publication, poster.
9491
9592
Scientific Topics
96-
The scientific subject or field that the training material focuses on, for example, bioinformatics, genetics, biodiversity, genomics.
93+
The scientific subject or field that the training material focuses on, for example, bioinformatics, genetics, biodiversity, genomics.
94+
In ELIXIR TeSS, this field uses the [EDAM ontology](https://edamontology.github.io/edam-browser/).
95+
In PaN-Training, this field uses the [PaNET ontology](https://github.com/pan-ontologies/PaNET).
9796
9897
Keywords
9998
Free text about topics clearly identifying the training material.
@@ -120,9 +119,11 @@ Content Provider
120119
121120
Authors
122121
Individuals who made substantial intellectual or technical contributions to the conception, design, execution of the training material.
122+
This field supports freetext name and [ORCID](https://orcid.org/).
123123
124124
Contributor
125125
Individuals or entities who provided specific assistance, technical input, data, or materials to the work but may not meet the full criteria for authorship.
126+
This field supports freetext name and [ORCID](https://orcid.org/).
126127
127128
Target Audience
128129
The intended group of users or learners for whom the training material is designed, such as researchers, students, postdocs, trainers.
@@ -139,6 +140,10 @@ Learning Objectives
139140
Events
140141
Workshops, seminars, conferences, summer or winter schools that contribute to or disseminate the training.
141142
143+
Operations
144+
Functions that process a set of inputs and result in a set of outputs.
145+
In ELIXIR TeSS, this field uses the [EDAM ontology for Operation](https://www.ebi.ac.uk/ols4/ontologies/edam/classes/http%253A%252F%252Fedamontology.org%252Foperation_0004?lang=en).
146+
142147
```
143148

144149

@@ -256,6 +261,34 @@ Show archived materials/learning paths/collections
256261
257262
```
258263

264+
## User profile
265+
266+
Definitions of public user details associated with a TeSS use account.
267+
268+
```{glossary}
269+
270+
First name
271+
Your first name.
272+
273+
Last name
274+
Your last name.
275+
276+
Website
277+
Your individual, professional website.
278+
279+
ORCID
280+
Your [ORCID](https://orcid.org/): a free, unique, persistent identifier (PID) that allows individuals to be uniquely distinguished and claim credit for their scholarship work, no matter how many people have a similar name.
281+
You can authenticate your ORCID from the button on your user profile page.
282+
283+
Image
284+
The image displayed with your profile is the Gravatar image associated with the provided contact email address, unless you upload another image.
285+
Gravatar provides a way to link an avatar to an email address so that it can be used across sites and platforms.
286+
To set-up a linked avatar, go to the [Gravatar site](https://en.gravatar.com).
287+
288+
Contact email address
289+
Your email address to receive essential service messages such as a password reset.
290+
291+
```
259292

260293
## Roles
261294

TeSS_docs/overview/fair.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,40 @@ For providers, the TeSS Platform makes it easy to make resources [FAIR](http://d
1212
- **Reusable**: License is requested for all materials, such as Creative Commons.
1313

1414

15+
## ORCID for accurately recognising authors of training materials
16+
17+
Training materials in TeSS can be attributed to any number of authors (for substantial input) and contributors (for a smaller level of input).
18+
When the author or contributor is a person, their ORCID can be included.
19+
20+
::::{grid} 1 1 2 2
21+
:gutter: 3
22+
23+
:::{grid-item-card}
24+
:link: https://orcid.org/
25+
{fas}`id-badge;sd-text-secondary` **ORCID**
26+
^^^
27+
28+
This free, unique, persistent identifier (PID) allows individuals to be uniquely distinguished and claim credit for their scholarship work, no matter how many people have a similar name.
29+
:::
30+
::::
31+
32+
When you [manually edit your training material in TeSS](../content/manual-events-materials), as you type the name of each author or contributor, TeSS will suggest a name and ORCID. If you are entering this person for the first time, paste their ORCID in the box after their name.
33+
If your training material is [automatically ingested into TeSS](../content/structured-data-types), you can add the ORCID URL of each person into the Bioschemas markup under the `@id` or `identifier` property (either property will work). For example:
34+
35+
```json
36+
{
37+
"author": [
38+
{
39+
"@type": "Person",
40+
"name": "Daniela Schneider",
41+
"identifier": "https://orcid.org/0000-0001-9536-5587",
42+
"@id": "https://orcid.org/0000-0001-9536-5587"
43+
}
44+
]
45+
}
46+
```
47+
48+
1549
## Integration with tools, policies, standards and data registries
1650

1751
In [ELIXIR TeSS](https://tess.elixir-europe.org/), you can associate your training materials with resources held in other ELIXIR resources:

0 commit comments

Comments
 (0)