Skip to content

Commit 2eb6273

Browse files
committed
Add manual registration
1 parent c5d07b8 commit 2eb6273

6 files changed

Lines changed: 140 additions & 6 deletions

File tree

TeSS_docs/_toc.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@ parts:
2424
- file: content/intro-content
2525
- file: content/auto
2626
sections:
27-
- file: content/auto-events
28-
- file: content/auto-materials
29-
- file: content/auto-workflows
30-
- file: content/auto-schemas
27+
- file: content/structured-data-types
28+
- file: content/sources
3129
- file: content/manual
3230
sections:
3331
- file: content/manual-events-materials

TeSS_docs/content/auto.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# Automatic content registration
2+
3+
TeSS features several options for automatically "harvesting" resources from external sources.
4+
This can be helpful if you are maintaining a large collection of events and materials that changes frequently.
5+
26
```{tableofcontents}
37
```
Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
# Learning paths
1+
# Learning paths in TeSS
2+
3+
## What is a learning path?
4+
5+
A learning path is 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.
6+
7+
## Editorial process for Learning Paths in TeSS
8+
There are several roles associated with learning paths in general:
9+
10+
- Author: Individuals and organisations involved in the preparation, creation or presentation of the published work.
11+
- Contributor: Individuals and organisations that contributed to the published work but are not authors.
12+
- Collaborator: An individual who has been granted editing rights to a material, topic or learning path by the individual (owner) who created it.
13+
- Curator: An individual who has been granted permission to create a learning path in TeSS while following their community’s editorial process.
14+
- Owner: An individual who has created a material, topic or learning path in TeSS.
15+
Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
# Manually add events and materials
1+
# Manually add events and materials
2+
3+
Resources may be added manually to TeSS.
4+
5+
To do so, first [register for a free account](../accounts/user). Members of academic institutions may be able to log-in via LS-Login.
6+
7+
Once registered and logged in, the 'Register event' and 'Register material' buttons will become visible on the events and materials tabs.
8+
9+
## Manually register training materials
10+
11+
To register a training material:
12+
13+
1. In the top menu, click ‘Materials’.
14+
2. Click the button 'Register training material'.
15+
3. Complete the fields (required fields are marked with an asterisk) then click the 'Register Material' button.
16+
17+
18+
## Manually register events
19+
20+
To register an event:
21+
22+
1. In the top menu, click ‘Events’.
23+
2. Click the buttom 'Register event'.
24+
3. Complete the fields (required fields are marked with an asterisk) then click the 'Register Event' button.
25+
26+
Alternatively, you can clone a previous event or training material. View the existing material and click the 'Clone' button at the top-right.
27+
28+
## Associate materials with a content provider
29+
30+
Training materials and events may be associated to one content provider.
31+
Content providers are entities (such as academic institutions, non-profit organisations, portals) that provide training materials
32+
33+
1. To do so, first [register a content provider](../accounts/provider).
34+
2. When creating or editing any training material or event, select your content provider in the relevant field.

TeSS_docs/content/sources.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Sources
2+
3+
Owners and editors of content providers in TeSS can register and manage Sources to be automatically ingested. A source consists of a URL for TeSS to fetch, and an "ingestion method" - which hints to TeSS how the contents of the URL should be processed.
4+
5+
Once registered, a source will need to be approved by an administrator before it is active, but can be tested to see exactly what metadata TeSS can extract from the source.
6+
7+
To register a source, click the "Sources" tab on your content provider page, or if you have not yet registered a content provider, see our page [Provider account creation](../accounts/provider).
8+
9+
Currently available user-managed ingestion methods:
10+
11+
- Bioschemas
12+
13+
For other methods, please [contact us](https://tess.elixir-europe.org/about/us#contact) to discuss how to register your content automatically in TeSS.
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Structured data types
2+
3+
To register resources in TeSS automatically, we need to be able to extract data from target sources reliably.
4+
To this end, it is helpful if the data is structured according to some kind of standard format.
5+
6+
The following are examples of the kinds of structured data that TeSS can work with.
7+
8+
If your website currently includes no structured data, and you’d like your resources added to TeSS, we recommend using [Bioschemas](http://bioschemas.org/) to structure your site.
9+
10+
11+
12+
::::{grid} 1 1 1 1
13+
:gutter: 3
14+
15+
:::{grid-item-card}
16+
{fas}`atom;sd-text-secondary` **Schema .org / Bioschemas**
17+
^^^
18+
Schema.org is a project run by a consortium of search engines. Schema.org has created an extensive library of schemas that web-masters can use to explicitly mark-up their websites content in order to improve search engine visibility and interoperability.
19+
20+
Bioschemas is an initiative to supplement the work of schema.org to help improve the findability of online resources in the life sciences.
21+
22+
The two main activities of Bioschemas are:
23+
- Proposing new types and properties to Schema.org to allow for the description of life science resources.
24+
- Defining usage profiles over the Schema.org types that identify the essential properties to use in describing a resource.
25+
26+
TeSS supports the following Bioschemas profiles:
27+
28+
for events that are courses
29+
- [CourseInstance](https://bioschemas.org/profiles/CourseInstance/1.0-RELEASE)
30+
- [Course](https://bioschemas.org/profiles/Course/1.0-RELEASE)
31+
32+
for other events
33+
- [Event](https://bioschemas.org/profiles/Event/0.2-DRAFT-2019_06_14)
34+
35+
for training materials
36+
- [TrainingMaterial](https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE)
37+
:::
38+
39+
40+
:::{grid-item-card}
41+
{fas}`laptop-code;sd-text-secondary` **Sitemaps**
42+
^^^
43+
44+
To help search engines (and TeSS) discover all the pages on a site that have Bioschemas markup, a [sitemap](https://developers.google.com/search/docs/crawling-indexing/sitemaps/overview) should be used. Sitemaps are basically a directory listing of all the pages on your site.
45+
46+
Sitemaps are a well-established standard, and there should be sitemap libraries and plugins available for whichever software you are using to provide your site.
47+
:::
48+
49+
50+
:::{grid-item-card}
51+
{fas}`plug;sd-text-secondary` **API**
52+
^^^
53+
Application Programming Interfaces, or APIs, typically have endpoint URLs that, when accessed, return data in a common exchange format, such as JSON.
54+
55+
TeSS currently supports the APIs for:
56+
57+
- [Eventbrite](https://eventbrite.com/) - for events
58+
- [Zenodo](https://zenodo.com/) - for materials
59+
- Other TeSS instances - for events
60+
:::
61+
62+
63+
:::{grid-item-card}
64+
{fas}`calendar-days;sd-text-secondary` **Calendar**
65+
^^^
66+
67+
Many organisations use calendar applications to organise and display their events. These may be custom-made or, more likely, utilise applications like Google Calendar. Calendar applications maintain an underlying file for event storage and retrieval, typically in the iCal (.ics) format.
68+
69+
TeSS can extract event descriptions, dates and locations from iCal files.
70+
:::
71+
72+
::::

0 commit comments

Comments
 (0)