Difference between revisions of "Understanding the CLIO URL Scheme"
(Created page with "== Overview == The CLIO web application uses a URL query-based system to load the interface dynamically based on what parameters is based to it through the URL. This can be...") |
|||
| Line 1: | Line 1: | ||
{{NeedsDemonstration}} | |||
== Overview == | == Overview == | ||
The CLIO web application uses a URL query-based system to load the interface dynamically based on what parameters is based to it through the URL. This can be thought of similarly to the way options are passed into a programming function. When the CLIO web application directory is navigated to without any parameters, it will default to the full “Facilitator Mode” experience. | The CLIO web application uses a URL query-based system to load the interface dynamically based on what parameters is based to it through the URL. This can be thought of similarly to the way options are passed into a programming function. When the CLIO web application directory is navigated to without any parameters, it will default to the full “Facilitator Mode” experience. | ||
Revision as of 16:47, 19 April 2022
Overview
The CLIO web application uses a URL query-based system to load the interface dynamically based on what parameters is based to it through the URL. This can be thought of similarly to the way options are passed into a programming function. When the CLIO web application directory is navigated to without any parameters, it will default to the full “Facilitator Mode” experience.
Using URL Parameters
By utilizing some URL configuration parameters, we can change how the web application will appear when loaded. This is helpful for configuring how we would like any standalone kiosks to operate, such as automatically loading an exhibit or activity on startup, or for sending links to activities for use in remote lesson plans.
We can navigate to a full facilitator mode experience using http://www.cliomuseums.org/clio/exhibit/. Parameters are attached to the end of the URL with a question mark ('?'). As an example, we can load the kiosk experience using http://www.cliomuseums.org/clio/exhibit/?mode=kiosk. Multiple arguments can be added together with an ampersand ('&'), such as https://www.cliomuseums.org/clio/exhibit/?program=NaturesNetworks&activity=salmon.
Parameters
There are several options that can be configured through the URL.
| Parameter | Description | Options |
|---|---|---|
| program | This is the program to be loaded. | This is the system name of the program, not the friendly name.
For example, the “Getting Started” program has a system name of “Default”. |
| activity | This is the activity to be loaded.
This requires that a program has been specified. |
This is the system name of the activity, not the friendly name. |
| menu | This is the menu section to be loaded.
This option will be ignored if there is a program and activity defined. |
The system name of the menu, as defined below.
facilitation: Facilitation Menu settings: Settings Menu accessibility: Accessibility Menu about: Help Menu |
| mode | This will configure the CLIO interface experience. | The system name of the mode, as defined below.
facilitator: Facilitator mode exhibit: Exhibit mode. Requires program to be set. activity: Activity mode. Requires program and activity to be set. |
| view | Configure how activity links are displayed within the interface. | 'list' or 'grid' |
| development | Used by kiosk mode to enable hidden hardware settings. | 'true' or 'false' |
