Skip to content

Commit c44ae21

Browse files
authored
Merge pull request #18 from ElixirTeSS/search-section
Search section, searching page
2 parents eb1520d + a82140b commit c44ae21

File tree

5 files changed

+80
-14
lines changed

5 files changed

+80
-14
lines changed

TeSS_docs/_toc.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,14 @@ parts:
1111
- file: overview/mtess-x
1212
- file: overview/definitions
1313
- file: overview/what-we-catalogue
14+
- caption: Search
15+
chapters:
16+
- file: search/searching
17+
- file: search/subscribe
1418
- caption: Account creation
1519
chapters:
1620
- file: accounts/user
1721
- file: accounts/provider
18-
- file: accounts/subscribe
1922
- caption: Space creation
2023
chapters:
2124
- file: spaces/intro-spaces

TeSS_docs/overview/definitions.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,32 @@ Associations
229229
For each association, provide a title and a URL.
230230
```
231231

232+
## Searching
233+
234+
Definitions of filters and other controls that show when searching for training.
235+
236+
```{glossary}
237+
238+
Only show online events
239+
Hide events that are marked as Face-to-face. False by default.
240+
241+
Show events/materials from all spaces
242+
Show training that match your search criteria from all spaces on this TeSS instance, not just the current space. False by default.
243+
244+
Show past events
245+
Show events where the date is in the past. False by default.
246+
247+
Show disabled events/materials
248+
Show training where the provider has chosen not to show the event yet in search results, perhaps because the event entry is still in development. False by default.
249+
250+
Show hidden items
251+
This filter is for curators only. Show training created by unverified users, and users that have been flagged as spammers. False by default.
252+
253+
Show archived materials/learning paths/collections
254+
Show training where the provider has set the [status](#term-Status) as Archived. False by default.
255+
256+
```
257+
232258

233259
## Roles
234260

TeSS_docs/overview/tess.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,3 @@ TeSS was originally developed as part of [ELIXIR](https://elixir-europe.org/), E
1515
One of the goals of ELIXIR is to train research scientists to better use available computational infrastructures to address critical research questions.
1616
This requires access both to face-to-face training opportunities and to disparate training materials and resources, currently dispersed across Europe.
1717

18-
## Searching for training resources in TeSS
19-
20-
Training resources (both events and materials) may be searched in TeSS in several ways.
21-
If you are on the main page of TeSS, a general search can be performed based on keywords, which will return separate lists of events and materials.
22-
23-
Alternatively, events or materials can be searched for independently of each other.
24-
This second approach allows more precise filtering on several parameters (e.g., event type, country, and target audience) alone or in combination.
25-
26-
27-
```{admonition} See also guidance from the ELIXIR Training Platform
28-
:class: seealso
29-
* [Searching in TeSS](https://elixir-europe-training.github.io/ELIXIR-TrP-TeSS/chapters/chapter_01/)
30-
```

TeSS_docs/search/searching.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Searching for training resources
2+
3+
## Getting started searching in TeSS
4+
5+
Training resources (both events and materials) may be searched in TeSS in several ways.
6+
7+
::::{grid} 1 2 2 2
8+
:gutter: 3
9+
10+
:::{grid-item-card}
11+
{fas}`magnifying-glass;sd-text-secondary` **General search**
12+
^^^
13+
If you are on the main page of TeSS, a general search can be performed based on keywords, which will return separate lists of events and materials.
14+
:::
15+
:::{grid-item-card}
16+
{fas}`filter;sd-text-secondary` **Browsing and filtered search**
17+
^^^
18+
Use the tabs at the top of the page to browse events or materials separately then perform a more advanced search.
19+
:::
20+
::::
21+
22+
The second approach allows more precise filtering on several parameters (such as event type, country, and target audience), alone or in combination. You can also search for content providers, users and other types of training.
23+
24+
25+
## General search
26+
27+
To perform a general search:
28+
29+
1. In the top menu, click 'Home'.
30+
2. Click in the big search box in the centre of the screen and enter your query.
31+
3. Click the magnifying lens (search) button to the right or press {kbd}`Enter`.
32+
4. The search results are displayed in tabs for each type of result. These may include events, materials, content providers, learning paths, workflows, users, collections (depending on the search).
33+
34+
## Browsing and filtered search
35+
36+
To perform a filtered search on a particular type of training:
37+
38+
1. In the top menu, click the type of training you wish to search.
39+
2. You can enter **keywords** in the search box above the results.
40+
3. You can **sort** results by date or title using the control on the left.
41+
4. You can **filter** results by multiple paramaters using the controls on the left.
42+
- For example, search across all spaces in a TeSS instance by clicking 'Show materials from all spaces'.
43+
5. You can move through the pages of results at the bottom of the page.
44+
45+
Descriptions of the filters can be found on the [Definitions](../overview/definitions) page.
46+
47+
```{admonition} See also guidance from the ELIXIR Training Platform
48+
:class: seealso
49+
* [Searching in TeSS](https://elixir-europe-training.github.io/ELIXIR-TrP-TeSS/chapters/chapter_01/)
50+
```
File renamed without changes.

0 commit comments

Comments
 (0)