This user guide uses ‘portal’ to refer to the interface across all of the available Oni portals (see Available Portals for more details).
Data and Page Structure
Home Page (Top Menu, Left Panel, Main Panel)
Collection Page
Object Page (Notebooks)
File Page
Data and Page Structure
Both the data and the webpages in the portal are structured in a heirarchy: Collections contain Objects and Objects contain Files.
Level | Description |
---|---|
Collection | A group of related Objects. Examples of collections include corpora, and sub-corpora, as well as aggregations of cultural objects such as PARADISEC collections, which bring together items collected in a region or a session with consultants. |
↓ | |
Object | A single resource or a group of tightly related resources that record a communicative event; for example, a dialogue or session in a speech study, a work (document) in a written corpus. |
↓ | |
File | A container for data (in the form of bits and bytes). Files can store data in different formats; for example, a single Object could have an audio file as well as a text file containing a transcription of the audio. |
Home Page
There are three main sections of the Home Page in the portal: the top menu bar, the left panel and the main panel. Each of these is discussed below.
Image Source: LDaCA
Top Menu
Image Source: LDaCA
The top menu of the home page allows you to access some of the main features of the portal:
- LDaCA logo: Returns you to the home page from anywhere in the portal.
- Collections: Filters the results section of the main panel so that only collections are shown (excluding objects, files and notebooks). A search performed while in this view will only search the text in the Name and Description fields at the collection level.
- Notebooks: Filters the results section of the main panel so that only Jupyter notebooks associated with collections are shown.
- Browse: Resets your results to the default settings.
- Login: Takes you to the CILogon page where you can login to apply for access to collections or view your current access. See Login for more details.
- Help: Provides more general information about the infrastructure the portal was built with, as well as the Oni API functionalities. It also links back to this user guide for easy reference.
Left Panel
Image Source: LDaCA
The left panel of the portal home page allows you to refine your data query through the use of a search field and filters. Searching allows you to view records which include specific information, while filtering allows you to view records which share values for metadata categories. Hovering over the information icon next to each filter will display tooltips related to that filter. See Search and Filters for more details on how to use the search and filter functions.
Main Panel
The main panel has two views available; List View and Map View.
Note that if you switch views, all current search and filter options will be reset.
List View
By default, the main panel is displayed in List View, which shows the results as a list. This is the alternative to Map View.
Image Source: LDaCA
The main panel on the right of the home page allows you to view the top-level descriptions of collections, objects, files and notebooks in the portal. The top row shows the total number of Index entries or items; this total will reduce as you apply filters and search queries. Below this is the option to Reset Search, clearing all (current) filters and searches. The Sort by and Order by dropdown boxes can also be configured; see Sort and Order to learn more about their usage. Below this, there is a row of buttons which allow you to navigate through pages of results, with 10 results appearing on each page.
The results in the main panel contain a set of top-level descriptions:
- Name: The name of the collection, object, file or notebook.
- Type: The type of object a record describes, i.e. a collection, object or file.
- Language: The language(s) of the materials (including PrimaryMaterials, DerivedMaterials and Annotations) in this item.
- Description: An abstract of the collection, object, file or notebook.
- Members: The number of items (objects, files, etc.) within the given collection.
- Member of: The collection that an object, file or notebook is a part of.
Note that top-level descriptions will not appear in cases where they aren’t provided for that item, e.g. usually Description is not present for objects and files, and Member of does not appear for top-level collections.
Item Icons
The icons next to each item show you some important information about that item (Access, Communication Mode and File Format). You can hover over a icon to see more detail.
Icon | Category | Icon Tooltip |
---|---|---|
Access | You can access this data immediately. By doing so, you accept the license terms specified on the record. | |
Access | You can access this data after logging in. You may also have to agree to license terms in an automatic process. | |
Access | There are restrictions on access to this data. Log in to get further information. | |
Communication Mode | SpokenLanguage | |
Communication Mode | WrittenLanguage | |
Communication Mode | SignedLanguage | |
File Format | text/plain | |
File Format | application/msword | |
File Format | application/tei+xml application/vnd.openxmlformats-officedocument.wordprocessingml.document | |
File Format | audio/mpeg audio/x-wav | |
File Format | application/mp4 | |
File Format | text/csv | |
File Format | application/pdf |
Map View
Selecting Map View from the top row of the main panel will display results on a map. This is the alternative to List View.
Image Source: LDaCA
Both filter and search functions work much the same as in List View, however Advanced Search is not available. The results on Map View are displayed in grids, and these divide further into more specific grids as you zoom in. The colours vary depending on the number of results per grid. The results displayed in Map View are only those in the current visible map area, so in order to view other results, either resize the map or move it to a different section.
Note that only items with location data will be shown in Map View.
Collection Page
Clicking on one of the collections from the main page results will take you to the Collection page for that item.
Image Source: LDaCA
The main panel of the Collection page lists the main details and metadata associated with the collection. Clicking on the question mark icon or information icon next to each heading will display tooltips related to that item.
Below the main description and metadata is the number of objects present in the collection. The objects are then listed below, with buttons allowing navigation by page if there are more than 10 objects in the collection.
The right panel has the following sections:
- Access: Defines the license and access conditions for the current collection.
- Content: Lists some of the main features of the current collection including Language, Linguistic Genre, Communication Mode, File Formats and Data licenses for access.
- Downloads: Displays the downloads associated with the current collection. Show All Downloads provides a more detailed view, particularly for distributed collections that can’t be downloaded in a single ZIP file.
- Retrieve Metadata: View or download the metadata associated with the current collection, as well as the license and access conditions for this metadata.
- Notebooks: Lists any notebooks associated with the current collection.
- Takedown Request: Links to a form for users to make requests for data to be removed.
Object Page
Clicking on one of the objects or files from either the main page results or from a Collection page will take you to the Object page for that item.
Image Source: LDaCA
The left panel of the Object page lists the main details and metadata associated with the object. Clicking on the question mark icon or information icon next to each heading will display tooltips related to that item.
The right panel has the following sections:
- Access: Defines the license and access conditions for the current object, together with a click-through link to the full license.
- Downloads: Displays the downloads associated with the current object. Show All Downloads provides a more detailed view, particularly for distributed collections that can’t be downloaded in a single ZIP file.
- Member Of: Lists the collection that the current object is a part of.
- Other Objects in this Collection: Lists the other objects that are in the same collection as the current object.
- Takedown Request: Links to a form for users to make requests for data to be removed.
The end of the Object page provides details about the files that form part of the current object. In the example above, the object Text 1-028 1791 Convict has two associated files: a plain text version and a text version including metadata codes, the details of which can be viewed using the dropdown arrow to the right of the file name. A preview of the file is available (provided that the access conditions permit this), and there are two options: View File to display the full file in the web browser, and Download File to save a copy of the file to your local system.
Notebooks
Clicking on one of the notebooks from either the main page results or from a Collection page will take you to the Notebook page for that item.
The left panel of the Notebook page lists the main details and metadata associated with the notebook. Clicking on the question mark icon or information icon next to each heading will display tooltips related to that item.
The right panel has the following sections:
- Downloads: Displays the downloads associated with the current notebook. Show All Downloads provides a more detailed view, particularly for distributed collections that can’t be downloaded in a single ZIP file.
- Try this Notebook: Displays the BinderHub deployments which the current notebook can be launched in. The icons on the right show if any authentication is required to access each deployment.
- Takedown Request: Links to a form for users to make requests for data to be removed.
File Page
Clicking View File on one of the files in an Object page will take you the File page for that item.
Image Source: LDaCA
From this page, you can view the whole file or download it with the option at the end of the page.