Difference between revisions of "CLIO Documentation"
| Line 46: | Line 46: | ||
=== Configuring Facilitator Information === | === Configuring Facilitator Information === | ||
{{Main|Configuring CLIO Facilitator Information}} | {{Main|Configuring CLIO Facilitator Information}} | ||
When used as a kiosk for pop-up events, the Facilitation menu can provides facilitators with quick references, such as program information, goals, objectives, and instructions. | |||
===Configuring Facilitator Discussions=== | ===Configuring Facilitator Discussions=== | ||
{{Main|Configuring CLIO Facilitator Discussions}} | {{Main|Configuring CLIO Facilitator Discussions}} | ||
Facilitator Discussions provide curated topics that can be used to prompt a conversation or answer a question from a participant. | |||
===Updating CLIO Exhibit Content=== | ===Updating CLIO Exhibit Content=== | ||
| Line 101: | Line 101: | ||
===Creating an Activity Type=== | ===Creating an Activity Type=== | ||
{{Main|Creating a CLIO Activity Type}} | {{Main|Creating a CLIO Activity Type}} | ||
All [[CLIO Activity Types|Activity Types]] are created using JavaScript. They are defined as a single function designed to load content from the configuration file and use it to set up the activity. Each Activity Type will automatically load an HTML template into the container and apply a stylesheet to the page. Using JavaScript or jQuery events, you can manipulate these containers and styles. | |||
===Using Integrated Libraries=== | ===Using Integrated Libraries=== | ||
{{Main|Using the Integrated Libraries in CLIO}} | {{Main|Using the Integrated Libraries in CLIO}} | ||
There are a collection of JavaScript libraries that are already integrated into CLIO that can be used in new Activity Types without needing to install them. | |||
===Using CLIO Functions=== | ===Using CLIO Functions=== | ||
{{Main|Using CLIO Functions}} | {{Main|Using CLIO Functions}} | ||
There are several functions that have been created for use in the interface or other activity types that were included as part of the CLIO web application, making it so they can be integrated into new activity types. | |||
===Integrating a JavaScript Library=== | ===Integrating a JavaScript Library=== | ||
{{Main|Integrating a JavaScript Library}} | {{Main|Integrating a JavaScript Library}} | ||
When designing an Activity Type, new JavaScript libraries can be integrated into CLIO so you can use all the library's features | |||
==Framework== | ==Framework== | ||
===Understanding the URL Scheme=== | ===Understanding the URL Scheme=== | ||
{{Main|Understanding the CLIO URL Scheme}} | {{Main|Understanding the CLIO URL Scheme}} | ||
The CLIO web application uses a URL query-based system to load the interface dynamically based on what parameters is passed to it through the URL. By manipulating these parameters, we can change how the web application will appear when loaded. This can be thought of similarly to the way options are passed into a programming function. When the CLIO is loaded without any parameters, it will default to the full “Facilitator Mode” experience. | |||
===Understanding the 'content' Folder=== | ===Understanding the 'content' Folder=== | ||
{{Main|Understanding the CLIO Content Folder}} | {{Main|Understanding the CLIO Content Folder}} | ||
All of the data used by Interactives, Programs and Activities are stored as flat files within the 'content' directory at the root of the web application. When CLIO is loaded, it will search this directory for available Programs. This is because CLIO does not use a database server to store activity configurations. | |||
===Understanding an Activity Configuration File=== | ===Understanding an Activity Configuration File=== | ||
{{Main|Understanding a CLIO Activity Configuration File}} | {{Main|Understanding a CLIO Activity Configuration File}} | ||
Every Activity, even ones with different Activity Types, use the same configuration file structure. This allows the CLIO web application to configure the interface, identify the appropriate activity type and pass is the content used for setup. | |||
===Understanding the Look Closer Content System=== | ===Understanding the Look Closer Content System=== | ||
{{Main|Understanding the CLIO Look Closer Content System}} | {{Main|Understanding the CLIO Look Closer Content System}} | ||
Revision as of 14:21, 13 April 2022
Overview
Requirements
CLIO runs on hardware with very minimal specifications, including outdated systems and single-board computers like the Raspberry Pi. Software requirements are an HTML web server with PHP 6.0+. A web browser, such as Mozilla Firefox or Google Chromium, are required to view CLIO.
Creating a Local Development Environment
CLIO is a web-based application, which means that it needs to be developed on your local machine using a web development environment. Many forms of code development happen in an Integrated Development Environment (IDE) designed to work with a specific coding language, but web development takes a slightly different approach.
For web development, we instead use a Local Web Development Environment (LWDE). These perform very similarly to an on-line web server, like the ones the power the World Wide Web. The difference is that this web server is constrained to your local computer and – if configured properly – your local network, meaning that only you and those given access can view or edit content on your Local Web Development Environment.
There are many free and open-source Local Web Development Environments available, which combine all of the required software and configurations required to quickly create a local web server with all of the required tools.
Installation
CLIO needs to be installed on the Local Web Development Environment. There is no setup process for databases, meaning that the CLIO web application files can be dragged directly to the applicable web server folder and access without installation. Different Operating Systems, as well as different software packages, have different locations for their hosted content.
Accessing CLIO
Once CLIO has been installed on your web server, you can access it through your web browser of choice by navigating to http://localhost/.
Creating an Interactive Exhibit
Creating an Interactive
An Interactive refers to single instance of a digital interactive experience, such as an individual kiosk or web exhibition. Interactives can contain multiple Programs, allowing them to be used in different exhibitions even while away from your institution. Interactives can also have device-specific settings, such as kiosk screen brightness and Facilitator PIN codes.
Creating a Program
A Program is a selection of Activities within the same group, exhibit or educational program. Programs can be used to group Activities for pop-up exhibition tables, rooms, galleries, or just by subject. This allows facilitators to run multiple unrelated pop-up exhibits and programs using the same hardware, without having to connect to the internet or download additional data. Programs are provided as a way to create manageable collections of interactive activities that can be customized based on your institutions needs.
Defining Audiences
Each Program can have custom audiences groups, which are included as a way to help sort activities for predefined demographics. When setting up the kiosk as part of their pop-up exhibit, facilitators have the power to configure which activities they think would best fit their audience and what they’re trying to achieve. As an example, this allows you to create three Slideshow activities about the same topic, but tailor each one for a different audience; one for younger learners, one for middle school children, and one for community audiences where you can expect adults are available to help explain more complex topics.
Adding Multimedia
Each Program contains its own directory to store media, which allows multiple activities within a Program to utilize the same multimedia assets.
Creating an Activity
Activities are created through easily customizable activity templates, called Activity Types. You can make your own, or utilize the ones that are provided. The CLIO web application suite comes pre-installed with seventeen Activity Types that are designed specifically for use in an informal education or exhibit context. These activities are coded and stored as JSON files for use within CLIO, but we provide word processor templates to assist with collaboration during the development and drafting process.
Configuring Facilitator Information
When used as a kiosk for pop-up events, the Facilitation menu can provides facilitators with quick references, such as program information, goals, objectives, and instructions.
Configuring Facilitator Discussions
Facilitator Discussions provide curated topics that can be used to prompt a conversation or answer a question from a participant.
Updating CLIO Exhibit Content
Once you have created an interactive on your Local Web Development Environment, it will need to be installed onto a kiosk or live web server.
Integrating CLIO Content into Your Institution
Creating a Kiosk
You can use free and open-source software, alongside commodity or outdated hardware, to create an interactive kiosk to display within your institution.
Using CLIO in Broadcasting and Recording Software
You can use Open Broadcaster Software to integrate CLIO and its activities into a video conference, live stream or pre-recorded videos that you can share online.
Using CLIO on a Blog
When you host CLIO on a publicly accessible web server, it can be embedded directly into websites and blogging platforms, such as Wordpress.
Facilitation
Using Facilitator Mode
Interface
Adding Custom CSS to an Interactive
Custom CSS can be applied to an entire instance of CLIO Exhibit, which allows custom theming on a device-by-device or site-by-site basis.
Adding Custom CSS to a Program
Each Program can have custom CSS that allows the interface to be branded more specifically to the aesthetics of your exhibit.
Creating Activity Themes
Each Activity can have a configured theme that allows each activity's aesthetic to vary slightly from the primary interface.
Adding a Custom Web Font
CLIO can be configured to use custom web fonts to match your institutions branding. You can add fonts that are accessible to every Program in CLIO, or make certain fonts only available to certain Programs.
Important IDs and Classes
These are the classes and IDs that CLIO uses to create the interface, which can be used to create themes that match your style guidelines.
Using Design Assets
CLIO uses Google's Material.io Sharp icon set and several custom web fonts that can be utilized in your development.
Activity Types
Creating an Activity Type
All Activity Types are created using JavaScript. They are defined as a single function designed to load content from the configuration file and use it to set up the activity. Each Activity Type will automatically load an HTML template into the container and apply a stylesheet to the page. Using JavaScript or jQuery events, you can manipulate these containers and styles.
Using Integrated Libraries
There are a collection of JavaScript libraries that are already integrated into CLIO that can be used in new Activity Types without needing to install them.
Using CLIO Functions
There are several functions that have been created for use in the interface or other activity types that were included as part of the CLIO web application, making it so they can be integrated into new activity types.
Integrating a JavaScript Library
When designing an Activity Type, new JavaScript libraries can be integrated into CLIO so you can use all the library's features
Framework
Understanding the URL Scheme
The CLIO web application uses a URL query-based system to load the interface dynamically based on what parameters is passed to it through the URL. By manipulating these parameters, we can change how the web application will appear when loaded. This can be thought of similarly to the way options are passed into a programming function. When the CLIO is loaded without any parameters, it will default to the full “Facilitator Mode” experience.
Understanding the 'content' Folder
All of the data used by Interactives, Programs and Activities are stored as flat files within the 'content' directory at the root of the web application. When CLIO is loaded, it will search this directory for available Programs. This is because CLIO does not use a database server to store activity configurations.
Understanding an Activity Configuration File
Every Activity, even ones with different Activity Types, use the same configuration file structure. This allows the CLIO web application to configure the interface, identify the appropriate activity type and pass is the content used for setup.
Understanding the Look Closer Content System
Understanding the Rich Text Markup System
Controlling Hardware
Contribute
