Difference between revisions of "CLIO Documentation"
| Line 6: | Line 6: | ||
===Requirements=== | ===Requirements=== | ||
{{Main|CLIO Requirements}} | {{Main|CLIO 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=== | ===Creating a Local Development Environment=== | ||
{{Main|Creating a Local Development Environment}} | {{Main|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=== | ===Installation=== | ||
{{Main|CLIO Installation}} | {{Main|CLIO Installation}} | ||
CLIO is a web-based application, which means that it 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. These locations also depend on where the software was installed. | |||
Revision as of 13:05, 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 is a web-based application, which means that it 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. These locations also depend on where the software was installed.
Creating an Interactive Exhibit
Defining Audiences
Adding Media to CLIO
Creating an Interactive
Creating a Program
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.
Exporting a CLIO Interactive
Updating CLIO Exhibit Content
Integrating CLIO Content into Your Institution
Creating a Kiosk
Using CLIO in Video Conference Software
Using CLIO on a Blog
Facilitation
Configuring Facilitator Information
Configuring Facilitator Discussions
Using Facilitator Mode
Interface
Adding Custom CSS to an Interactive
Adding Custom CSS to a Program
Creating Activity Themes
Adding a Custom Web Font
Important IDs and Classes
Using Design Assets
Activity Types
Creating an Activity Type
Using Integrated Libraries
Using CLIO Functions
Integrating a JavaScript Library
Framework
Understanding the URL Scheme
Understanding the 'content' Folder
Understanding an Activity Configuration File
Understanding the Look Closer Content System
Understanding the Rich Text Markup System
Controlling Hardware
Contribute
