Difference between revisions of "Creating a Media Dichotomous Key Activity"

From CLIO

(Created page with "{{NeedsDemonstration}} ==Overview== Within our Getting Started Package, you will find a Template folder. We have provided a template for the configuration file, which is used...")
 
 
(3 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 Media Dichotomous Key activity type presents a gallery of images to the user and a series of questions. Using the images, they answer to the best of their ability and, when there have been enough questions asked to reach a conclusion, they will be presented with their answer versus the correct answer based on their responses.
==Options==
 
{{See|Media Dichotomous Key (activity type)}}
 
==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"
!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.{{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.
|-
|Acknowledgements
| Notifications of appreciation for content creators.
|}{{See|Defining a CLIO Activity}}
===Drafting the Content===
{{Drafting Template|Activity Type=Media Dichotomous Key|URL=https://cliomuseums.org/clio/templates/drafting/Media%20Dichotomous%20Key.docx}}{{Stub}}
 
===Coding the Activity===
{{Coding Template|Download URL=https://cliomuseums.org/clio/templates/content/media_dichotomous_key.json|Edit URL=https://cliomuseums.org/jsoneditor/?file=https://cliomuseums.org/clio/templates/content/media_dichotomous_key.json}}{{Stub}}
 
== Options ==
 
====Configuration====
====Configuration====
These are configuration settings specific to this activity type.
These are configuration settings specific to this activity type.
Line 11: Line 54:
!Examples
!Examples
|-
|-
|Scale to Fit
|Correct Answer
|Should the image be scaled to fill the screen, or should it remain at its full size and be centered?
|The correct answers from the defined answers.
|True or False
|Index name of a defined answer
|[[File:Scale to Fit - Small.png|center|300x300px|Scale to Fit - Small Screen|link=https://cliomuseums.org/wiki/index.php/File:Scale_to_Fit_-_Small.png]][[File:Scale to Fit - Large.png|center|300x300px|Scale to Fit - Large Screen|link=https://cliomuseums.org/wiki/index.php/File:Scale_to_Fit_-_Large.png]]
|
|-
|Prompt Text – Top
|Displayed at the top of the screen while checking the users answer.
|Plain Text
|
|-
|Prompt Text – Bottom
|Displayed at the bottom of the screen while checking the users answer.
|Plain Text
|
|-
|Answer Titles – User
|Displayed above the user's answer while they are being compared.
|Plain Text
|
|-
|Answer Titles – Correct
|Displayed above the correct answer while they are being compared.
|Plain Text
|
|}
 
==== Image Configuration ====
These are the images that are displayed in the right side panel.
{| class="wikitable"
!Property
!Description
!Expected Parameters
!Examples
|-
|-
|Image
|Image
|This is the image that will be annotated.
|The image to be displayed.
|Image File
|Image File
|[[File:Image.png|center|300x300px|Image source for the background|link=https://cliomuseums.org/wiki/index.php/File:Image.png]]
|
|-
|-
|Header
|Description
|''Optional.''  This can be used to display a "name plate" in the bottom right corner.
|The caption to be displayed alongside this image.
|Plain Text
|Plain Text
|[[File:Header.png|center|300x300px|Header that is used for the "name plate".|link=https://cliomuseums.org/wiki/index.php/File:Header.png]]
|
|}
 
==== Question Configuration ====
These are the questions that are asked in the left side panel.
{| class="wikitable"
!Property
!Description
!Expected Parameters
!Examples
|-
|Prompt
|Prompt displayed before the two options.
|Plain Text
|
|-
|Option 1 – Text
|Text displayed on button 1.
|Plain Text
|
|-
|Option 1 – Goto Type
|Signify whether selecting this button should lead to another question or an answer.
|"Question" or "Answer"
|
|-
|Option 1 – Goto Location
|The location that should be loaded when the user selects this button.
|Index name of the question or answer
|
|-
|Option 2 – Text
|Text displayed on button 2.
|Plain Text
|
|-
|Option 2 – Goto Type
|Signify whether selecting this button should lead to another question or an answer.
|"Question" or "Answer"
|
|-
|Option 2 – Goto Location
|The location that should be loaded when the user selects this button.
|Index name of the question or answer
|
|}
 
==== Answer Configuration ====
These are all of the possible answers a user could get.
{| class="wikitable"
!Property
!Description
!Expected Parameters
!Examples
|-
|Title
|The title for this answer.
|Plain Text
|
|-
|-
|Description
|Description
|''Optional.''  This is the description displayed when the Header "name plate" is touched.
|Look Closer content displayed when the user selects the Look Closer button.
|Rich Text
|Rich Text
|[[File:Description.png|center|300x300px|link=https://cliomuseums.org/wiki/index.php/File:Description.png]]
|
|-
|-
|Dimensions - Height
|Image
|The pixel height of the image to be annotated.  This is used by ScaleToFit.
|The image that is displayed alongside this answer.
|Unitless integer [ 0 - 9999]
|Image File
|[[File:Height.png|center|300x300px|Height of the image|link=https://cliomuseums.org/wiki/index.php/File:Height.png]]
|
|-
|Dimensions - Width
|The pixel width of the image to be annotated.  This is used by ScaleToFit.
|Unitless integer [ 0 - 9999]
|[[File:Width.png|center|300x300px|Width of the image|link=https://cliomuseums.org/wiki/index.php/File:Width.png]]
|}
|}
==Creating the Activity==
{{DocumentationNavigation}}
===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.
 
{{See|Defining a CLIO Activity}}
 
=== Drafting the Content ===
{{Drafting Template|Activity Type=Media Dichotomous Key|URL=https://cliomuseums.org/clio/templates/drafting/Media%20Dichotomous%20Key.docx}}{{Stub}}
 
===Coding the Activity===
{{Coding Template|Download URL=https://cliomuseums.org/clio/templates/content/media_dichotomous_key.json|Edit URL=https://cliomuseums.org/jsoneditor/?file=https://cliomuseums.org/clio/templates/content/media_dichotomous_key.json}}{{Stub}}

Latest revision as of 20:47, 31 October 2022

Google material book.png
This section contains CLIO documentation.
Add a photo.png
This section requires photographs, illustrations or screenshots.

Overview

The Media Dichotomous Key activity type presents a gallery of images to the user and a series of questions. Using the images, they answer to the best of their ability and, when there have been enough questions asked to reach a conclusion, they will be presented with their answer versus the correct answer based on their responses.

Read more.png


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.
Read more.png
Theme Each Activity can have a configured theme that allows each activity's aesthetic to vary slightly from the primary interface.
Read more.png
Attributions Notifications for copyrighted content used within the activity.
Acknowledgements Notifications of appreciation for content creators.
Read more.png

Drafting the Content

Download icon.png
Imbox style.png
This section could use more detail. You can help by expanding it.

Coding the Activity

Imbox style.png
This section could use more detail. You can help by expanding it.

Options

Configuration

These are configuration settings specific to this activity type.

Property Description Expected Parameters Examples
Correct Answer The correct answers from the defined answers. Index name of a defined answer
Prompt Text – Top Displayed at the top of the screen while checking the users answer. Plain Text
Prompt Text – Bottom Displayed at the bottom of the screen while checking the users answer. Plain Text
Answer Titles – User Displayed above the user's answer while they are being compared. Plain Text
Answer Titles – Correct Displayed above the correct answer while they are being compared. Plain Text

Image Configuration

These are the images that are displayed in the right side panel.

Property Description Expected Parameters Examples
Image The image to be displayed. Image File
Description The caption to be displayed alongside this image. Plain Text

Question Configuration

These are the questions that are asked in the left side panel.

Property Description Expected Parameters Examples
Prompt Prompt displayed before the two options. Plain Text
Option 1 – Text Text displayed on button 1. Plain Text
Option 1 – Goto Type Signify whether selecting this button should lead to another question or an answer. "Question" or "Answer"
Option 1 – Goto Location The location that should be loaded when the user selects this button. Index name of the question or answer
Option 2 – Text Text displayed on button 2. Plain Text
Option 2 – Goto Type Signify whether selecting this button should lead to another question or an answer. "Question" or "Answer"
Option 2 – Goto Location The location that should be loaded when the user selects this button. Index name of the question or answer

Answer Configuration

These are all of the possible answers a user could get.

Property Description Expected Parameters Examples
Title The title for this answer. Plain Text
Description Look Closer content displayed when the user selects the Look Closer button. Rich Text
Image The image that is displayed alongside this answer. Image File
Documentation
Installation Look and Feel
Interaction Modes Developing Activity Types
Creating an Interactive Framework
Integrating CLIO Contribute
Retrieved from "https://wiki.interpretive.tech/index.php?title=Creating_a_Media_Dichotomous_Key_Activity&oldid=1761"