View source for Creating a Tile Match Activity

{{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 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.
==Options==
===Card Configuration===
These are configuration settings for the content available within the activity.
{| class="wikitable"
!Property
!Description
!Expected Parameters
!Examples
|-
|Title
|The title that is displayed prominently on the card, highlighted along the bottom.
|Plain Text

''We recommend this field be less than 15 characters long or it may not display properly at small sizes.''
|
|-
|Content
|The text that is displayed on the center of the card
|Plain Text
|
|-
|Background
|The image that will be displayed on the card.
|Image File
|
|}

=== Answer Configuration ===
These are configuration settings for the answers to this activity.
{| class="wikitable"
!Property
!Description
!Expected Parameters
!Examples
|-
|Pair
|Select which two cards are a correct match.
|This field will only accept the index name of each card; for instance, L1 and R1.

''Cards are shuffled each time the activity is loaded, so it is not required to change this setting as long as the L1 card and the R1 card are a matching pair.''
|
|-
|Correct
|The text that is displayed on a correct pair.
|Rich Text
|
|-
|Incorrect
|The text that is displayed on an incorrect pair.
|Rich Text
|
|}
==Creating 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.
{{See|Defining a CLIO Activity}}
===Drafting the Content===
{{Drafting Template|Activity Type=Tile Match|URL=https://cliomuseums.org/clio/templates/drafting/Tile%20Match.docx}}Open the provided Content Template for drafting the Tile Match 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. 

We can now begin to write the content needed for the Tile Match activity type.  This activity type displays two sets of four cards and invites the user to find a matching pair.  A correct match can display a pop-up with more information to help solidify their understanding, while an incorrect match can offer clues to point them in the right direction.  

The first thing we should do is decide on the four matching pairs.  Each time this activity type is loaded, the four cards are shuffled.  This means, as long as we design the first card on the left (“L1”) and the first card on the right (“R1”), we don’t need to change these pairs.  In the following example, we presume that the default matching pairs are used.

We can finally choose the title, content and background image for each card, as well as the correct and incorrect responses that appear upon user input. You can use any combination of title, image and content for each card.

===Coding the Activity===
{{Coding Template|Download URL=https://cliomuseums.org/clio/templates/content/tile_match.json|Edit URL=https://cliomuseums.org/jsoneditor/?file=https://cliomuseums.org/clio/templates/content/tile_match.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 Tile Match activity.  This can be done in a plain text editor, but for the purpose of this manual we will be using jsoneditoronline.org/.  

This is how the configuration file will appear once opened within JSONEditorOnline.  Our first step will be configuring each of the eight cards; four on the right side and four on the left side.  Using the content we drafted earlier, we can begin to fill in the empty title, content and background fields. 

Now that we’ve entered the information for each of the eight cards, we can configure the responses that appear when a user picks a card from both sides.  This is located under the Answer object, shown below. 

When we were drafting our content for this activity, we presumed that we were going to keep the default matching pairs.  R1 will match with L1, R2 will match with L2, and so on.  When the activity is started, the cards on both sides will be shuffled.  For each number, 1 through 4, we can enter the correct and incorrect responses.  

This activity type assumes a correct or incorrect answer based on the card selected on the right side.  For example, if you select R1 and L2, the activity will check whether the L2 is a match for R1 and will not check if R1 is a match for L2.