Difference between revisions of "Creating a Meta Activity"

From CLIO

 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{NeedsDemonstration}}
{{DocumentationPage}}{{NeedsDemonstration}}


===Overview===
==Overview==
Within our Getting Started Package, you will find a Template folder. We have provided a template for the configuration file, which is used by the CLIO interface to set up the activity.  We also include a content drafting template created in Microsoft Word that can aid collaboration when creating activities as part of a development team.
The Meta activity type will display the included Activities as scrollable list.
===Options===
 
====Activity Configuration====
{{See|Exhibit List (activity type)}}
These are configuration settings for each activity contained within the Meta activity.  These Activities must be contained within the same Program as the Meta activity.
 
==Creating the Activity==
We have provided a template for the configuration file, which is used by the CLIO interface to set up the activity.  We also include a content drafting template created in Microsoft Word that can aid collaboration when creating activities as part of a development team.
 
===Define the Activity===
All CLIO activities, regardless of their Activity Type, contain many of the same configuration settings.  These are used to configure the screen and load the correct content.  By defining this information, we can begin to draft more specific activity content.  This information is included in both the drafting template and the coding template provided with each activity type.  These are the most common settings:
{| class="wikitable"
{| class="wikitable"
!Property
!Setting
!Description
! Description
!Expected Parameters
|-
!Examples
|Title
|The name for the activity.
|-
|-
|Activity
|Description
|The Activity that we would like to use.
|The description for the activity shown to visitors.
|This field requires that you use the unique name for the activity (the name of the file located within the Program’s @Activities directory, minus the .json extension), as opposed to it’s friendly name.
|
|-
|-
|Preview
|Preview
|The preview image to use for this activity.  
|The image displayed for the activity in Exhibit Mode.
 
|-
This will override any preview image configured within this activity.
| Introduction Video
|Image File
|The video displayed under the Activity Menu to provide a video introduction to the activity.
|
|-
|Audience
|Each Program can have custom audiences groups, which are included as a way to help sort activities for predefined demographicsWhen 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.{{See|Defining CLIO Audiences}}
|-
|Theme
|Each Activity can have a configured theme that allows each activity's aesthetic to vary slightly from the primary interface.{{See|Creating CLIO Activity Themes}}
|-
| Attributions
|Notifications for copyrighted content used within the activity.
|-
|-
|Description
|Acknowledgements
|The description to use for this activity.  
|Notifications of appreciation for content creators.
 
|}{{See|Defining a CLIO Activity}}
This will override any description configured within this activity.
|Rich Text
|
|}
 
===Drafting the Content===
===Drafting the Content===
{{Drafting Template|Activity Type=Meta Activity|URL=https://cliomuseums.org/clio/templates/drafting/Meta.docx}}Open the provided Content Template for drafting the Meta activity.  First, we must decide on the basic descriptive information for the activity, such as the title, description, preview image and theme.  This information is required because it is used by the CLIO interface to properly display the activity.
{{Drafting Template|Activity Type=Meta Activity|URL=https://cliomuseums.org/clio/templates/drafting/Meta.docx}}Open the provided Content Template for drafting the Meta activity.  First, we must decide on the basic descriptive information for the activity, such as the title, description, preview image and theme.  This information is required because it is used by the CLIO interface to properly display the activity.
Line 44: Line 51:


===Coding the Activity===
===Coding the Activity===
{{NeedsTemplate}}
{{Coding Template|Download URL=https://cliomuseums.org/clio/templates/content/meta.json|Edit URL=https://cliomuseums.org/jsoneditor/?file=https://cliomuseums.org/clio/templates/content/meta.json}}The next step will be to take the content that was created in the Content template and begin to migrate it into the Configuration template.  We will need to open the provided Configuration Template for drafting the Meta activity.  This can be done in a plain text editor, but for the purpose of this manual we will be using jsoneditoronline.org/.  
The next step will be to take the content that was created in the Content template and begin to migrate it into the Configuration template.  We will need to open the provided Configuration Template for drafting the Meta activity.  This can be done in a plain text editor, but for the purpose of this manual we will be using jsoneditoronline.org/.  


First, we will be duplicating the necessary fields to ensure that we can enter all of the data that we’ve spent time drafting.  In our previous example, we decided to use two activities within our meta activity, so we should start by making sure we have enough activities within the configuration file.
First, we will be duplicating the necessary fields to ensure that we can enter all of the data that we’ve spent time drafting.  In our previous example, we decided to use two activities within our meta activity, so we should start by making sure we have enough activities within the configuration file.
Line 58: Line 64:


Once you are finished, you can download the finished JSON file by clicking ‘Save’ and then ‘Save to Disk’.  This file can be copied to the Program’s @Activity folder, and the media can be copied to the Program’s @Media directory.
Once you are finished, you can download the finished JSON file by clicking ‘Save’ and then ‘Save to Disk’.  This file can be copied to the Program’s @Activity folder, and the media can be copied to the Program’s @Media directory.
== Options ==
===Activity Configuration===
These are configuration settings for each activity contained within the Meta activity.  These Activities must be contained within the same Program as the Meta activity.
{| class="wikitable"
!Property
!Description
!Expected Parameters
!Examples
|-
|Activity
|The Activity that we would like to use.
|This field requires that you use the unique name for the activity (the name of the file located within the Program’s @Activities directory, minus the .json extension), as opposed to it’s friendly name.
|
|-
|Preview
|The preview image to use for this activity.  
This will override any preview image configured within this activity.
|Image File
|
|-
|Description
|The description to use for this activity.  
This will override any description configured within this activity.
|Rich Text
|
|}
{{DocumentationNavigation}}

Latest revision as of 19:46, 31 October 2022

Google material book.png
Add a photo.png

Overview

The Meta activity type will display the included Activities as scrollable list.


Creating the Activity

We have provided a template for the configuration file, which is used by the CLIO interface to set up the activity. We also include a content drafting template created in Microsoft Word that can aid collaboration when creating activities as part of a development team.

Define the Activity

All CLIO activities, regardless of their Activity Type, contain many of the same configuration settings.  These are used to configure the screen and load the correct content.  By defining this information, we can begin to draft more specific activity content.  This information is included in both the drafting template and the coding template provided with each activity type. These are the most common settings:

Setting Description
Title The name for the activity.
Description The description for the activity shown to visitors.
Preview The image displayed for the activity in Exhibit Mode.
Introduction Video The video displayed under the Activity Menu to provide a video introduction to the activity.
Audience 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.
Theme Each Activity can have a configured theme that allows each activity's aesthetic to vary slightly from the primary interface.
Attributions Notifications for copyrighted content used within the activity.
Acknowledgements Notifications of appreciation for content creators.

Drafting the Content

Open the provided Content Template for drafting the Meta activity.  First, we must decide on the basic descriptive information for the activity, such as the title, description, preview image and theme.  This information is required because it is used by the CLIO interface to properly display the activity.

Next, we can start to write the content needed for the Meta activity type.  This activity type will display clickable links to different activities, allowing them all to be open under the same activity.  This allows you to change the preview image and description of these activities, allowing you to create different contexts using the same activities.

For this example, we want to display a total of two other activities.  To do this, we can copy the template for Activity 1 and create a duplicate.  To keep organized, we can rename this duplicate to Activity 2.

For each activity, we need to define the CLIO Program and Activity that we want to use.  This is the unique identifier that is used for the Program and Activity, which is the folder name of the program and the name of the activity configuration file.  

We want to create links to activities in the “Getting Started” program, which has the unique identifier of “Default”.  We want to use the two Visual Thinking activities, named “prototype” and “types”.  For each of these two activities, we can provide different preview images and descriptive text.

Coding the Activity

The next step will be to take the content that was created in the Content template and begin to migrate it into the Configuration template.  We will need to open the provided Configuration Template for drafting the Meta activity.  This can be done in a plain text editor, but for the purpose of this manual we will be using jsoneditoronline.org/.  

First, we will be duplicating the necessary fields to ensure that we can enter all of the data that we’ve spent time drafting.  In our previous example, we decided to use two activities within our meta activity, so we should start by making sure we have enough activities within the configuration file.

The first activity is labeled as ‘1’, underneath the Content object.  If we click on the small box to the left of ‘1’, we can choose to duplicate it as many times as we need to create enough.

For our example, we would need to duplicate it once to have a total of two activities.  After this is done, we will need to rename the activity we just duplicated.  Currently, it will be named “1 (copy)”.  It is important that these keys be numeric and unique.  We will rename our duplicate to “2”.

We can now start filling out the empty fields for the activities we want to display.  Under the first activity, named “1”, we have the same information we entered into our content draft.

First, we can put the relative location of the preview image we would like to use into “Preview”, as well as our description into “Description”.  Just like in our draft, we will also be entering the unique Program and Activity names that are used by the CLIO interface.

Once you are finished, you can download the finished JSON file by clicking ‘Save’ and then ‘Save to Disk’.  This file can be copied to the Program’s @Activity folder, and the media can be copied to the Program’s @Media directory.

Options

Activity Configuration

These are configuration settings for each activity contained within the Meta activity. These Activities must be contained within the same Program as the Meta activity.

Property Description Expected Parameters Examples
Activity The Activity that we would like to use. This field requires that you use the unique name for the activity (the name of the file located within the Program’s @Activities directory, minus the .json extension), as opposed to it’s friendly name.
Preview The preview image to use for this activity.  

This will override any preview image configured within this activity.

Image File
Description The description to use for this activity.  

This will override any description configured within this activity.

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