|
| 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