Skip to content

Instructions file info

Dan Brady edited this page Apr 2, 2024 · 2 revisions

Configuring the instructions

Outline

Instructions are set in the config/instructions.js file. Within this file there are variables that contain the instructions for each of the tasks. They are all structured in the same way:

var expt1_inst = [
    "<p>This is placeholder text for the <b>task 1</b>.</p><p>Please insert your own instructions</p>",
    "<p>Press any key to begin the task</p>"
]

The instructions are stored in an array (e.g. [x, y, z]) and each item in the array corresponds to a page of instructions on screen. So in the example above:

This is placeholder text for the task 1.
Please insert your own instructions

will appear on the first page, and:

Press any key to begin the task.

will appear on the second.

Updating the instruction text

Instructions can be included as plain text, but you will need to add HTML for any kind of styling (e.g. bold, line breaks, etc). You can write this manually if you are comfortable with HTML, or you can use an online editor to style text and have it automatically converted to HTML (e.g. wysiwyghtml.com).
Items can be spread over multiple lines but a \ needs to be included where a single item is broken over multiple lines. e.g.:

var expt1_inst = [
    "<p>This is placeholder text for the <b>task 1</b>.</p> \
     <p>Please insert your own instructions</p>",
    "<p>Press any key to begin the task</p>"
]

As many pages as needed can be created by adding items to the array. e.g.:

var expt1_inst = [
    "<p>This is placeholder text for the <b>task 1</b>.</p><p>Please insert your own instructions</p>",
    "<p>This is an additional page of instructions</p>", 
    "<p>Press any key to begin the task</p>"
]