Difference between revisions of "Creating a CLIO Interactive"

Revision as of 14:00, 30 October 2022

This section requires photographs, illustrations or screenshots.

Installing CLIO

The first step to creating an interactive is completing the CLIO Installation guide or POP Kiosk Creation Guide. After you're done, you've successfully created your first Interactive! Now, we can look at the default settings to configure this Interactive how we want.

Configuring an Interactive

There is a @Configuration.json file stored in the 'config' folder located within the CLIO root directory. This file provides a place for Interactive-specific settings to be saved persistently. This includes options controlled through the Facilitator Mode interface, as well as screensaver and PIN code settings that cannot be changed elsewhere. When these options are changed through Facilitator Mode, this file is updated to reflect these changes.

We provide a default template you can download in case you run into errors. Also, you can use our online JSON template editor to make your desired changes and download a properly-formatted @Configuration.json file to replace the default.

Download the template.

Edit the template.

Screensaver Options

These options cannot be changed through the Facilitator Mode interface. They are provided as a way for institutions to configure branding and design integration of their Interactives.

Setting	Description	Expected Parameters
Text	This is the text that is displayed when the screensaver is activated.	Plain Text
Image	This is the image that is displayed when the screensaver is activated.	Image File

Device Options

These options cannot be changed through the Facilitator Mode interface. They are provided as a way for institutions to configure device-specific Interactive options, such as the Facilitator PIN code and the default POP kiosk screen brightness.

Setting	Description	Expected Parameters
Screen Brightness	This is the default brightness when used on the POP kiosk.	1 - 10
PIN Code	PIN to allow facilitators to return the kiosk from Exhibit Mode to Facilitator Mode.	Any four-digit number.

Settings

Setting	Description	Expected Parameters
Default Program	This is the default brightness when used on the POP kiosk.	1 - 10
Screensaver	Enable or disable the screensaver.	"true" or "false"
Contrast Mode	Configure whether a contrast mode is enabled by default.	"blackonwhite", "whiteonblack", or "greenonblack"
Activity Timeout	The amount of time the kiosk should remain idle while in Exhibit Mode before returning to the activity carousel.	"15", "30", "60", "300", "600", or "99999999"
Slide Duration	The amount of time each activity should be displayed on the carousel while in Exhibit Mode.	"5000", "10000", "15000", "30000", "60000", "120000", or "300000"

@@ Line 2: / Line 2: @@
 == Installing CLIO ==
-The first step to creating an interactive is completing the [[CLIO Installation|CLIO Installation guide]] or [[Creating a POP Kiosk|POP Kiosk Creation Guide]].  After you're done, you've successfully created your first Interactive!
+The first step to creating an interactive is completing the [[CLIO Installation|CLIO Installation guide]] or [[Creating a POP Kiosk|POP Kiosk Creation Guide]].  After you're done, you've successfully created your first Interactive!  Now, we can look at the default settings to configure this Interactive how we want.
-Now, we can look at the default settings to configure this Interactive how we want.  This includes settings controlled through the CLIO Exhibit Facilitator Mode interface, as well as screensaver and PIN code settings, which cannot be changed elsewhere.
 == Configuring an Interactive ==
-{{Coding Template|Download URL=https://cliomuseums.org/clio/exhibit/config/@Configuration.json|Edit URL=https://cliomuseums.org/jsoneditor/?file=https://cliomuseums.org/clio/exhibit/config/@Configuration.json}}
+There is a ''@Configuration.json'' file stored in the ''<nowiki/>'config''' folder located within the CLIO root directory.  This file provides a place for Interactive-specific settings to be saved persistently.  This includes options controlled through the Facilitator Mode interface, as well as screensaver and PIN code settings that cannot be changed elsewhere.  When these options are changed through Facilitator Mode, this file is updated to reflect these changes.
-There is a @Configuration.json file stored in the 'config' folder located within the CLIO root directory.  This file provides a place for Interactive-specific settings to be saved persistently.  When these settings are changed through Facilitator Mode, this file is updated to reflect these changes.
+We provide a default template you can download in case you run into errors.  Also, you can use our online JSON template editor to make your desired changes and download a properly-formatted @Configuration.json file to replace the default. {{Coding Template|Download URL=https://cliomuseums.org/clio/exhibit/config/@Configuration.json|Edit URL=https://cliomuseums.org/jsoneditor/?file=https://cliomuseums.org/clio/exhibit/config/@Configuration.json}}
 === Screensaver Options ===
+These options cannot be changed through the Facilitator Mode interface.  They are provided as a way for institutions to configure branding and design integration of their Interactives.
 {| class="wikitable"
 !Setting
@@ Line 26: / Line 25: @@
 === Device Options ===
+These options cannot be changed through the Facilitator Mode interface.  They are provided as a way for institutions to configure device-specific Interactive options, such as the Facilitator PIN code and the default POP kiosk screen brightness.
 {| class="wikitable"
 !Setting