Difference between revisions of "Understanding the CLIO Content Folder"

Latest revision as of 13:40, 15 December 2022

This section contains CLIO documentation.

This section requires photographs, illustrations or screenshots.

Overview

All of the data needed to operate the kiosk is stored locally on the kiosk in the web server’s directory. The ‘content’ folder is located at the root directory of the CLIO web application.

Each time the CLIO web application is loaded, it will retrieve a list of folders contained within this directory. Each folder represents the unique identification name CLIO will use to refer to that Program. We highly recommend avoiding spaces in this name. For example, the "Getting Started" Program is stored within the "Default" folder and "Default" is the unique name that CLIO uses to refer to this Program in URLs and program functions. An example URL for the "Getting Started" program would be:

https://cliomuseums.org/clio/exhibit/?program=Default&activity=types

Each Program folder contains an '@About.json' file containing descriptive metadata about this Program, such as it's friendly name or description. CLIO will retrieve this information about each Program and use it to populate the Program option in the Settings menu. This allows the Program to be changed on-the-fly though the Facilitator Mode interface, as well as through descriptive URLs.

Read More: Understanding the CLIO URL Scheme

Sample Programs

We include sample Programs in the CLIO toolkit based on previous projects:

Getting Started (Default): designed to help you get a better understanding of the toolkit using the different activity types.
Example Activities (Examples): designed to show the different ways activities can be configured.
Habitable Worlds (HabitableWorlds): reinterpretation of the Roger Williams Natural History Museums exhibit.
Nature's Networks (NaturesNetworks): designed as a pop-up exhibit for the Burke Museum's BurkeMobile program.
Bird Diversity (NICOBirdDiversity): designed as a part of a remote lesson plan for the Slater Museum of Natural History.
Tooth Sleuth (NICOToothSleuth): designed as a part of a remote lesson plan for the Slater Museum of Natural History.
Evergreen (Evergreen): designed for use on kiosks around the Evergreen State College's Indigenous Arts Campus.

Documentation
Installation	Look and Feel
Interaction Modes	Developing Activity Types
Creating an Interactive	Framework
Integrating CLIO	Contribute

@@ Line 1: / Line 1: @@
-{{NeedsDemonstration}}
+{{DocumentationPage}}{{NeedsDemonstration}}
 == Overview ==
-All of the data needed to operate the kiosk is stored locally on the kiosk in the web server’s directory.  The ‘content’ folder is located at the root directory of the CLIO web application.  When the kiosk is powered on, the CLIO web application will search this directory for available Programs and use this list to populate the Settings menu.
+All of the data needed to operate the kiosk is stored locally on the kiosk in the web server’s directory.  The ‘content’ folder is located at the root directory of the CLIO web application.
-We include two several sample Programs in the CLIO toolkit:
+Each time the CLIO web application is loaded, it will retrieve a list of folders contained within this directory.   Each folder represents the unique identification name CLIO will use to refer to that Program.  We highly recommend avoiding spaces in this name.  For example, the "Getting Started" Program is stored within the "Default" folder and "Default" is the unique name that CLIO uses to refer to this Program in URLs and program functions.  An example URL for the "Getting Started" program would be:
-* '''Getting Started:''' designed to help you get a better understanding of the toolkit using the different activity types.
+<code>https://cliomuseums.org/clio/exhibit/?program=Default&activity=types</code>
-* '''Example Activities:''' designed to show the different ways activities can be configured.
-*[[CLIO Development#Roger Williams Natural History Museum|Habitable Worlds]]: reinterpretation of the Roger Williams Natural History Museums exhibit.
+Each Program folder contains an '''@About.json''<nowiki/>' file containing descriptive metadata about this Program, such as it's friendly name or description.  CLIO will retrieve this information about each Program and use it to populate the Program option in the Settings menu.  This allows the Program to be changed on-the-fly though the Facilitator Mode interface, as well as through descriptive URLs.
-*[[CLIO Development#BurkeMobile|Nature's Networks]]: designed as a pop-up exhibit for the Burke Museum's ''BurkeMobile'' program.
-*[[CLIO Development#Slater Museum of Natural History|Bird Diversity:]] designed as a part of a remote lesson plan for the Slater Museum of Natural History.
+{{See|Understanding the CLIO URL Scheme}}
-*[[CLIO Development#Slater Museum of Natural History|Tooth Sleuth:]] designed as a part of a remote lesson plan for the Slater Museum of Natural History.
-*[[CLIO Development#The Evergreen State College|Evergreen]]: designed for use on kiosks around the Evergreen State College's ''Indigenous Arts Campus''.
+== Sample Programs ==
+We include sample Programs in the CLIO toolkit based on previous projects:
+* '''Getting Started (''Default''):''' designed to help you get a better understanding of the toolkit using the different activity types.
+* '''Example Activities (''Examples''):''' designed to show the different ways activities can be configured.
+*'''[[CLIO Development#Roger Williams Natural History Museum|Habitable Worlds]] (''HabitableWorlds''):''' reinterpretation of the Roger Williams Natural History Museums exhibit.
+*'''[[CLIO Development#BurkeMobile|Nature's Networks]] (''NaturesNetworks''):''' designed as a pop-up exhibit for the Burke Museum's ''BurkeMobile'' program.
+*[[CLIO Development#Slater Museum of Natural History|'''Bird Diversity''']] '''(''NICOBirdDiversity'')''': designed as a part of a remote lesson plan for the Slater Museum of Natural History.
+*[[CLIO Development#Slater Museum of Natural History|'''Tooth Sleuth''']] '''(''NICOToothSleuth'')''': designed as a part of a remote lesson plan for the Slater Museum of Natural History.
+*'''[[CLIO Development#The Evergreen State College|Evergreen]] (''Evergreen''):''' designed for use on kiosks around the Evergreen State College's ''Indigenous Arts Campus''.
+{{DocumentationNavigation}}