Difference between revisions of "Creating a Rich Text with Narration Activity"

From CLIO

 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{NeedsDemonstration}}
{{DocumentationPage}}{{NeedsDemonstration}}
==Overview==
==Overview==
The Rich Text with Narration activity type displays rich text with an optional voiceover.
The Rich Text with Narration activity type displays rich text with an optional voiceover.
Line 9: Line 9:


===Define the Activity===
===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.
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:
{{See|Defining a CLIO Activity}}
{| 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 the Content===
{{Drafting Template|Activity Type=Rich Text with Narration|URL=https://cliomuseums.org/clio/templates/drafting/Rich%20Text%20Narration.docx}}Open the provided Content Template for drafting the Rich Text with Narration 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=Rich Text with Narration|URL=https://cliomuseums.org/clio/templates/drafting/Rich%20Text%20Narration.docx}}Open the provided Content Template for drafting the Rich Text with Narration 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 48: Line 75:
|
|
|}
|}
{{DocumentationNavigation}}

Latest revision as of 19:41, 31 October 2022

Google material book.png
Add a photo.png

Overview

The Rich Text with Narration activity type displays rich text with an optional voiceover.


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 Rich Text with Narration 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 Rich Text with Narration activity type.  This activity type will display rich text content that the user can scroll, as well as an optional OGA audio file voice over.

For the Audio field, we can put the relative location to the OGG audio file that we would like to play.  This is entirely optional.  For the Rich Text field, we can put the rich text that we would like to display as part of our activity.

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 Rich Text with Narration activity.  This can be done in a plain text editor, but for the purpose of this manual we will be using jsoneditoronline.org/.  

We can now start filling out the empty fields for our activity.  Our audio file, named “1”, will be displayed under the object named “Audio”.  Here, we can enter the relative location of the OGA audio file that we put into our content draft.  Finally, we can enter the rich text that we want to display under “Richtext”.

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

Content Configuration

These are configuration settings for the content available within the activity.

Property Description Expected Parameters Examples
Audio The audio file to be played. OGG file


This activity type currently only supports the .OGG audio format.

Rich Text Rich text content to be displayed within the activity. Rich Text
Documentation
Installation Look and Feel
Interaction Modes Developing Activity Types
Creating an Interactive Framework
Integrating CLIO Contribute