jspsych 6.3.0 → 7.1.1

package/docs/plugins/jspsych-audio-slider-response.md

@@ -1,53 +0,0 @@
-# jspsych-audio-slider-response
-
-This plugin plays an audio file and allows the subject to respond by dragging a slider.
-
-If the browser supports it, audio files are played using the WebAudio API. This allows for reasonably precise timing of the playback. The timing of responses generated is measured against the WebAudio specific clock, improving the measurement of response times. If the browser does not support the WebAudio API, then the audio file is played with HTML5 audio. 
-
-Audio files can be automatically preloaded by jsPsych using the [`preload` plugin](jspsych-preload.md). However, if you are using timeline variables or another dynamic method to specify the audio stimulus, then you will need to [manually preload](/overview/media-preloading/#manual-preloading) the audio.
-
-The trial can end when the subject responds, or if the subject has failed to respond within a fixed length of time. You can also prevent the slider response from being made before the audio has finished playing.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter                      | Type             | Default Value | Description                              |
-| ------------------------------ | ---------------- | ------------- | ---------------------------------------- |
-| stimulus                       | audio file       | *undefined*   | Audio file to be played                  |
-| labels                         | array of strings | []            | Labels displayed at equidistant locations on the slider. For example, two labels will be placed at the ends of the slider. Three labels would place two at the ends and one in the middle. Four will place two at the ends, and the other two will be at 33% and 67% of the slider width. |
-| button_label                   | string           | 'Continue'    | Label of the button to end the trial.    |
-| min                            | integer          | 0             | Sets the minimum value of the slider     |
-| max                            | integer          | 100           | Sets the maximum value of the slider     |
-| slider_start                   | integer          | 50            | Sets the starting value of the slider    |
-| step                           | integer          | 1             | Sets the step of the slider. This is the smallest amount by which the slider can change. |
-| slider_width                   | integer          | null          | Set the width of the slider in pixels. If left null, then the width will be equal to the widest element in the display. |
-| require_movement               | boolean          | false         | If true, the subject must move the slider before clicking the continue button. |
-| prompt                         | string           | null          | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., which key to press). |
-| trial_duration                 | numeric          | null          | How long to wait for the subject to make a response before ending the trial in milliseconds. If the subject fails to make a response before this timer is reached, the subject's response will be recorded as null for the trial and the trial will end. If the value of this parameter is null, then the trial will wait for a response indefinitely. |
-| response_ends_trial            | boolean          | true          | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can set this parameter to `false` to force the subject to listen to the stimulus for a fixed amount of time, even if they respond before the time is complete. |
-| response_allowed_while_playing | boolean          | true          | If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before the slider is enabled and the trial can end via the next button click. Once the audio has played all the way through, the slider is enabled and a response is allowed (including while the audio is being re-played via on-screen playback controls). |
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name         | Type    | Value                                    |
-| ------------ | ------- | ---------------------------------------- |
-| response     | numeric | The numeric value of the slider.         |
-| rt           | numeric | The time in milliseconds for the subject to make a response. The time is measured from when the stimulus first began playing until the subject's response. |
-| stimulus     | string  | The path of the audio file that was played. |
-| slider_start | numeric | The starting value of the slider.        |
-
-## Examples
-
-#### A simple rating scale
-
-```javascript
-var trial_1 = {
-	type: 'audio-slider-response',
-	stimulus: 'sound/speech_joke.mp3',
-	labels: ['Not Funny', 'Funny'],
-	prompt: '<p>How funny is the joke?</p>'
-}
-```

package/docs/plugins/jspsych-call-function.md

@@ -1,81 +0,0 @@
-# jspsych-call-function
-
-This plugin executes a specified function. This allows the experimenter to run arbitrary code at any point during the experiment.
-
-The function cannot take any arguments. If arguments are needed, then an anonymous function should be used to wrap the function call (see examples below).
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-Parameter | Type | Default Value | Description
-----------|------|---------------|------------
-func | function | *undefined* | The function to call.
-async | boolean | `false` | Set to true if `func` is an asynchoronous function. If this is true, then the first argument passed to `func` will be a callback that you should call when the async operation is complete. You can pass data to the callback. See example below.
-
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-value | any | The return value of the called function.
-
-## Examples
-
-#### Calling a simple function
-
-```javascript
-
-var myfunc = function() {
-	return 'you called?';
-}
-
-var trial = {
-	type: 'call-function',
-	func: myfunc
-}
-```
-
-#### Using an anonymous function to pass variables
-
-```javascript
-
-var myfunc = function(data){
-	// data contains all the experiment data so far,
-	// so this function could implement code to write
-	// the data to a database.
-}
-
-var trial = {
-	type: 'call-function',
-	func: function(){ myfunc(jsPsych.data.get())}
-}
-```
-
-#### Async function call
-
-```javascript
-var trial = {
-	type: 'call-function',
-	async: true,
-	func: function(done){
-		// can perform async operations here like
-		// creating an XMLHttpRequest to communicate
-		// with a server
-		var xhttp = new XMLHttpRequest();
-		xhttp.onreadystatechange = function() {
-			if (this.readyState == 4 && this.status == 200) {
-				var response_data = xhttp.responseText;
-				// line below is what causes jsPsych to 
-				// continue to next trial. response_data
-				// will be stored in jsPsych data object.
-				done(response_data);
-			}
-		};
-		xhttp.open("GET", "path_to_server_script.php", true);
-		xhttp.send();
-	}
-}
-```

package/docs/plugins/jspsych-canvas-button-response.md

@@ -1,66 +0,0 @@
-# jspsych-canvas-button-response
-
-This plugin can be used to draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and record a button click response and response time. The canvas stimulus can be useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. One or more button choices will be displayed under the canvas, and the button style can be customized using HTML formatting.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-Parameter | Type | Default Value | Description
-----------|------|---------------|------------
-stimulus | function | *undefined* | The function to draw on the canvas. This function automatically takes a canvas element as its only argument, e.g. `function(c) {...}`  or `function drawStim(c) {...}`, where `c` refers to the canvas element. Note that the stimulus function will still generally need to set the correct context itself, using a line like `let ctx = c.getContext("2d")`.
-canvas_size | array | [500, 500] | Array that defines the size of the canvas element in pixels. First value is height, second value is width.
-choices | array of strings | [] | Labels for the buttons. Each different string in the array will generate a different button.
-button_html | HTML string | `'<button class="jspsych-btn">%choice%</button>'` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on.
-prompt | string | null | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., what question to answer).
-trial_duration | numeric | null | How long to wait for the subject to make a response before ending the trial in milliseconds. If the subject fails to make a response before this timer is reached, the subject's response will be recorded as null for the trial and the trial will end. If the value of this parameter is null, the trial will wait for a response indefinitely.
-stimulus_duration | numeric | null | How long to display the stimulus in milliseconds. The visibility CSS property of the stimulus will be set to `hidden` after this time has elapsed. If this is null, then the stimulus will remain visible until the trial ends.
-margin_vertical | string | '0px' | Vertical margin of the button(s).
-margin_horizontal | string | '8px' | Horizontal margin of the button(s).
-response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response.
-response | numeric | Indicates which button the subject pressed. The first button in the `choices` array is 0, the second is 1, and so on.
-
-Note: the canvas stimulus is *not* included in the trial data because it is a function. Any stimulus information that should be saved in the trial data can be added via the `data` parameter.
-
-## Examples
-
-### Drawing circles based on parameters
-
-```javascript
-function filledCirc(canvas, radius, color){
-    var ctx = canvas.getContext("2d");
-    ctx.beginPath();
-    ctx.arc(250, 250, radius, 0, 2 * Math.PI);
-    ctx.fillStyle = color;
-    ctx.fill()
-}
-
-var circle_1 = {
-    type: 'canvas-button-response',
-    stimulus: function (c) {
-        filledCirc(c, 100, 'blue');
-    },
-    choices: ['Red', 'Green', 'Blue'],
-    prompt: '<p>What color is the circle?</p>'
-    data: {color: 'blue', radius: 100}
-};
-
-var circle_2 = {
-    type: 'canvas-button-response',
-    stimulus: function (c) {
-        filledCirc(c, 150, 'green');
-    },
-    choices: ['Larger', 'Smaller'],
-    prompt: '<p>Is this circle larger or smaller than the last one?</p>',
-    data: {color: 'green', radius: 150}
-};
-
-```

package/docs/plugins/jspsych-canvas-keyboard-response.md

@@ -1,68 +0,0 @@
-# jspsych-canvas-keyboard-response
-
-This plugin can be used to draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp) and record a keyboard response. The canvas stimulus can be useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter           | Type             | Default Value      | Description                              |
-| ------------------- | ---------------- | ------------------ | ---------------------------------------- |
-| stimulus            | function         | *undefined*        | The function to draw on the canvas. This function automatically takes a canvas element as its only argument, e.g. `function(c) {...}` or `function drawStim(c) {...}`, where `c` refers to the canvas element. Note that the stimulus function will still generally need to set the correct context itself, using a line like `let ctx = c.getContext("2d")`. |
-| canvas_size         | array            | [500, 500]         | Array that defines the size of the canvas element in pixels. First value is height, second value is width. |
-| choices             | array of strings | `jsPsych.ALL_KEYS` | This array contains the key(s) that the subject is allowed to press in order to respond to the stimulus. Keys should be specified as characters (e.g., `'a'`, `'q'`, `' '`, `'Enter'`, `'ArrowDown'`) - see [this page](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) and [this page (event.key column)](https://www.freecodecamp.org/news/javascript-keycode-list-keypress-event-key-codes/) for more examples. Any key presses that are not listed in the array will be ignored. The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. |
-| prompt              | string           | null               | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., which key to press). |
-| stimulus_duration   | numeric          | null               | How long to display the stimulus in milliseconds. The visibility CSS property of the stimulus will be set to `hidden` after this time has elapsed. If this is null, then the stimulus will remain visible until the trial ends. |
-| trial_duration      | numeric          | null               | How long to wait for the subject to make a response before ending the trial in milliseconds. If the subject fails to make a response before this timer is reached, the subject's response will be recorded as null for the trial and the trial will end. If the value of this parameter is null, then the trial will wait for a response indefinitely. |
-| response_ends_trial | boolean          | true               | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. |
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| response  | string  | Indicates which key the subject pressed. |
-| rt        | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. |
-
-Note: the canvas stimulus is *not* included in the trial data because it is a function. Any stimulus information that should be saved in the trial data can be added via the `data` parameter.
-
-## Examples
-
-### Draw rectangle and wait for response
-
-```javascript
-function drawRect(c){
-    var ctx = c.getContext('2d');
-    ctx.beginPath();
-    ctx.rect(30, 30, 200, 50);
-    ctx.stroke();
-}
-
-var trial = {
-    type: 'canvas-keyboard-response',
-    stimulus: drawRect,
-    choices: ['e','i'],
-    prompt: '<p>Is this a circle or a rectangle? Press "e" for circle and "i" for rectangle.</p>',
-    data: {shape: 'rectangle'}
-}
-```
-
-### Draw circle, no response allowed
-
-```javascript
-function drawCirc(c){
-    var ctx = c.getContext('2d');
-    ctx.beginPath();
-    ctx.arc(100, 75, 50, 0, 2 * Math.PI);
-    ctx.stroke();
-}
-
-var trial = {
-    type: 'canvas-keyboard-response',
-    stimulus: drawCirc,
-    choices: jsPsych.NO_KEYS,
-    trial_duration: 1000,
-    data: {shape: 'circle', radius: 50}
-}
-```

package/docs/plugins/jspsych-canvas-slider-response.md

@@ -1,89 +0,0 @@
-# jspsych-canvas-slider-response
-
-This plugin can be used to draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp) and collect a response within a range of values, which is made by dragging a slider. The canvas stimulus can be useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-Parameter | Type | Default Value | Description
-----------|------|---------------|------------
-stimulus | function | *undefined* | The function to draw on the canvas. This function automatically takes a canvas element as its only argument, e.g. `function(c) {...}` or `function drawStim(c) {...}`, where `c` refers to the canvas element. Note that the stimulus function will still generally need to set the correct context itself, using a line like `let ctx = c.getContext("2d")`.
-canvas_size | array | [500, 500] | Array that defines the size of the canvas element in pixels. First value is height, second value is width.
-labels | array of strings | [] | Labels displayed at equidistant locations on the slider. For example, two labels will be placed at the ends of the slider. Three labels would place two at the ends and one in the middle. Four will place two at the ends, and the other two will be at 33% and 67% of the slider width.
-button_label | string | 'Continue' | Label of the button to end the trial.
-min | integer | 0 | Sets the minimum value of the slider.
-max | integer | 100 | Sets the maximum value of the slider.
-slider_start | integer | 50 | Sets the starting value of the slider.
-step | integer | 1 | Sets the step of the slider. This is the smallest amount by which the slider can change.
-slider_width | integer | null | Set the width of the slider in pixels. If left null, then the width will be equal to the widest element in the display.
-require_movement | boolean | false | If true, the subject must click the slider before clicking the continue button.
-prompt | string | null | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., what question to answer).
-stimulus_duration | numeric | null | How long to display the stimulus in milliseconds. The visibility CSS property of the stimulus will be set to `hidden` after this time has elapsed. If this is null, then the stimulus will remain visible until the trial ends.
-trial_duration | numeric | null | How long to wait for the subject to make a response before ending the trial in milliseconds. If the subject fails to make a response before this timer is reached, the subject's response will be recorded as null for the trial and the trial will end. If the value of this parameter is null, then the trial will wait for a response indefinitely.
-response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-response | numeric | The numeric value of the slider.
-rt | numeric | The time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response.
-
-Note: the canvas stimulus is *not* included in the trial data because it is a function. Any stimulus information that should be saved in the trial data can be added via the `data` parameter.
-
-## Examples
-
-### Draw two squares
-
-```javascript
-var colors = [#'FF3333', '#FF6A33'];
-
-function twoSquares(c) {    
-    var ctx = c.getContext('2d');
-    ctx.fillStyle = colors[0];
-    ctx.fillRect(200, 70, 40, 40);
-    ctx.fillStyle = colors[1];
-    ctx.fillRect(260, 70, 40, 40);
-}
-
-var trial = {
-    type: 'canvas-slider-response',
-    stimulus: twoSquares,
-    labels: ['0','10'],
-    canvas_size: [200, 500],
-    prompt: '<p>How different would you say the colors of these two squares are on a scale from 0 (the same) to 10 (completely different)</p>',
-    data: {color1: colors[0], color2: colors[1]}
-}
-```
-
-### Draw two squares with additional parameters
-
-```javascript
-var colors;
-
-function twoSquares(c, colors) {
-    var ctx = c.getContext('2d');
-    ctx.fillStyle = colors[0];
-    ctx.fillRect(200, 70, 40, 40);
-    ctx.fillStyle = colors[1];
-    ctx.fillRect(260, 70, 40, 40);
-}
-
-var trial = {
-    type: 'canvas-slider-response',
-    stimulus: function(c) {
-        colors = ['darkred', 'cyan'];
-        twoSquares(c, colors);
-    },
-    labels: ['Exactly<br>the same','Totally<br>different'],
-    canvas_size: [200, 500],
-    prompt: '<p>How different would you say the colors of these two squares are?</p>',
-    on_finish: function(data) {
-        data.color1 = colors[0];
-        data.color2 = colors[1];
-    }
-};
-```

package/docs/plugins/jspsych-categorize-animation.md

@@ -1,60 +0,0 @@
-# jspsych-categorize-animation
-
-The categorize animation plugin shows a sequence of images at a specified frame rate. The subject responds by pressing a key. Feedback indicating the correctness of the response is given.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter                      | Type             | Default Value      | Description                              |
-| ------------------------------ | ---------------- | ------------------ | ---------------------------------------- |
-| stimuli                        | array            | *undefined*        | Each element of the array is a path to an image file. |
-| choices                        | array of strings | `jsPsych.ALL_KEYS` | This array contains the key(s) that the subject is allowed to press in order to respond to the stimulus. Keys should be specified as characters (e.g., `'a'`, `'q'`, `' '`, `'Enter'`, `'ArrowDown'`) - see [this page](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) and [this page (event.key column)](https://www.freecodecamp.org/news/javascript-keycode-list-keypress-event-key-codes/) for more examples. Any key presses that are not listed in the array will be ignored. The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. |
-| key_answer                     | string           | *undefined*        | The key character indicating the correct response. |
-| text_answer                    | string           | ""                 | A text label that describes the correct answer. Used in conjunction with the `correct_text` and `incorrect_text` parameters. |
-| correct_text                   | string           | "Correct."         | String to show when the correct answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the %ANS% string (see example below). |
-| incorrect_text                 | string           | "Wrong."           | String to show when the wrong answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the %ANS% string (see example below). |
-| frame_time                     | numeric          | 500                | How long to display each image (in milliseconds). |
-| sequence_reps                  | numeric          | 1                  | How many times to show the entire sequence. |
-| allow_response_before_complete | boolean          | false              | If true, the subject can respond before the animation sequence finishes. |
-| prompt                         | string           | null               | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., which key to press). |
-| feedback_duration              | numeric          | 2000               | How long to show the feedback (milliseconds). |
-| render_on_canvas               | boolean          | true               | If true, the images will be drawn onto a canvas element. This prevents a blank screen (white flash) between consecutive images in some browsers, like Firefox and Edge. If false, the image will be shown via an img element, as in previous versions of jsPsych. |
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| stimulus  | array   | Array of stimuli displayed in the trial. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. |
-| response  | string  | Indicates which key the subject pressed. |
-| rt        | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. |
-| correct   | boolean | `true` if the subject got the correct answer, `false` otherwise. |
-
-## Examples
-
-#### Basic example
-
-```javascript
-var animation_trial = {
-  type: 'categorize-animation',
-  stimuli: ["img/face_3.jpg", "img/face_2.jpg", "img/face_4.jpg", "img/face_1.jpg"],
-	choices: ['p', 'q'], 
-	key_answer: 'q', 
-};
-```
-
-#### Giving feedback with `%ANS%` string
-
-```javascript
-var animation_trial = {
-  type: 'categorize-animation',
-  stimuli: ["img/face_3.jpg", "img/face_2.jpg", "img/face_4.jpg", "img/face_1.jpg"],
-  choices: ['p', 'q'], 
-  key_answer: 'q', 
-	text_answer: 'Dax', // the label for the sequence is 'Dax'
-	correct_text: 'Correct! This was a %ANS%.',
-	incorrect_text: 'Incorrect. This was a %ANS%.'
-};
-```

package/docs/plugins/jspsych-categorize-html.md

@@ -1,53 +0,0 @@
-# jspsych-categorize-html
-
-The categorize html plugin shows an HTML object on the screen. The subject responds by pressing a key. Feedback indicating the correctness of the response is given.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter                  | Type             | Default Value            | Description                              |
-| -------------------------- | ---------------- | ------------------------ | ---------------------------------------- |
-| stimulus                   | html string      | *undefined*              | The HTML stimulus to display.            |
-| choices                    | array of strings | `jsPsych.ALL_KEYS`       | This array contains the key(s) that the subject is allowed to press in order to respond to the stimulus. Keys should be specified as characters (e.g., `'a'`, `'q'`, `' '`, `'Enter'`, `'ArrowDown'`) - see [this page](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) and [this page (event.key column)](https://www.freecodecamp.org/news/javascript-keycode-list-keypress-event-key-codes/) for more examples. Any key presses that are not listed in the array will be ignored. The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. |
-| key_answer                 | string           | *undefined*              | The key character indicating the correct response. |
-| text_answer                | string           | ""                       | A label that is associated with the correct answer. Used in conjunction with the `correct_text` and `incorrect_text` parameters. |
-| correct_text               | string           | "Correct."               | String to show when the correct answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the `%ANS%` string (see example below). |
-| incorrect_text             | string           | "Wrong."                 | String to show when the wrong answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the `%ANS%` string (see example below). |
-| prompt                     | string           | null                     | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., which key to press). |
-| force_correct_button_press | boolean          | false                    | If set to true, then the subject must press the correct response key after feedback is given in order to advance to the next trial. |
-| show_stim_with_feedback    | boolean          | true                     | If set to true, then the stimulus will be shown during feedback. If false, then only the text feedback will display during feedback. |
-| show_feedback_on_timeout   | boolean          | false                    | If true, then category feedback will be displayed for an incorrect response after a timeout (trial_duration is exceeded). If false, then a timeout message will be shown. |
-| timeout_message            | string           | "Please respond faster." | The message to show on a timeout non-response. |
-| stimulus_duration          | numeric          | null                     | How long to show the stimulus for (milliseconds). If null, then the stimulus is shown until a response is given. |
-| feedback_duration          | numeric          | 2000                     | How long to show the feedback for (milliseconds). |
-| trial_duration             | numeric          | null                     | The maximum time allowed for a response. If null, then the experiment will wait indefinitely for a response. |
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| stimulus  | string  | Either the path to the image file or the string containing the HTML formatted content that the subject saw on this trial. |
-| response  | string  | Indicates which key the subject pressed. |
-| rt        | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. |
-| correct   | boolean | `true` if the subject got the correct answer, `false` otherwise. |
-
-## Examples
-
-#### Categorizing HTML content
-
-```javascript
-var categorization_trial = {
-    type: 'categorize',
-    stimulus: '<p>B</p>',
-    key_answer: 'p',
-    text_answer: 'letter',
-    choices: ['p', 'q'],
-    correct_text: "<p class='prompt'>Correct, this is a %ANS%.</p>",
-    incorrect_text: "<p class='prompt'>Incorrect, this is a %ANS%.</p>",
-    prompt: "<p>Press p for letter. Press q for number.</p>"
-};
-```
-

package/docs/plugins/jspsych-categorize-image.md

@@ -1,53 +0,0 @@
-# jspsych-categorize-image
-
-The categorize image plugin shows an image object on the screen. The subject responds by pressing a key. Feedback indicating the correctness of the response is given.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter                  | Type             | Default Value            | Description                              |
-| -------------------------- | ---------------- | ------------------------ | ---------------------------------------- |
-| stimulus                   | string           | *undefined*              | The path to the image file.              |
-| key_answer                 | string           | *undefined*              | The key character indicating the correct response. |
-| choices                    | array of strings | `jsPsych.ALL_KEYS`       | This array contains the key(s) that the subject is allowed to press in order to respond to the stimulus. Keys should be specified as characters (e.g., `'a'`, `'q'`, `' '`, `'Enter'`, `'ArrowDown'`) - see [this page](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) and [this page (event.key column)](https://www.freecodecamp.org/news/javascript-keycode-list-keypress-event-key-codes/) for more examples. Any key presses that are not listed in the array will be ignored. The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. |
-| text_answer                | string           | ""                       | A label that is associated with the correct answer. Used in conjunction with the `correct_text` and `incorrect_text` parameters. |
-| correct_text               | string           | "Correct."               | String to show when the correct answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the %ANS% string (see example below). |
-| incorrect_text             | string           | "Wrong."                 | String to show when the wrong answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the %ANS% string (see example below). |
-| prompt                     | string           | null                     | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., which key to press). |
-| force_correct_button_press | boolean          | false                    | If set to true, then the subject must press the correct response key after feedback is given in order to advance to the next trial. |
-| show_stim_with_feedback    | boolean          | true                     | If set to true, then the stimulus will be shown during feedback. If false, then only the text feedback will display during feedback. |
-| show_feedback_on_timeout   | boolean          | false                    | If true, then category feedback will be displayed for an incorrect response after a timeout (trial_duration is exceeded). If false, then a timeout message will be shown. |
-| timeout_message            | string           | "Please respond faster." | The message to show on a timeout non-response. |
-| stimulus_duration          | numeric          | null                     | How long to show the stimulus for (milliseconds). If null, then the stimulus is shown until a response is given. |
-| feedback_duration          | numeric          | 2000                     | How long to show the feedback for (milliseconds). |
-| trial_duration             | numeric          | null                     | The maximum time allowed for a response. If null, then the experiment will wait indefinitely for a response. |
-
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| stimulus  | string  | Either the path to the image file or the string containing the HTML formatted content that the subject saw on this trial. |
-| response  | string  | Indicates which key the subject pressed. |
-| rt        | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. |
-| correct   | boolean | `true` if the subject got the correct answer, `false` otherwise. |
-
-## Examples
-
-#### Categorizing an image
-
-```javascript
-var categorization_trial = {
-    type: 'categorize-image',
-    stimulus: 'img/harrypotter.png',
-    key_answer: 'g',
-    text_answer: 'Gryffindor',
-    choices: ['g', 'h', 'r', 's'],
-    correct_text: "<p class='prompt'>Correct! This person is a %ANS%.</p>",
-    incorrect_text: "<p class='prompt'>Incorrect. This person is a %ANS%.</p>",
-    prompt: "<p>Is this person a (G)ryffindor, (H)ufflepuff, (R)avenclaw, or (S)lytherin?</p>"
-};
-```

package/docs/plugins/jspsych-cloze.md

@@ -1,45 +0,0 @@
-# *jspsych-cloze
-
-This plugin displays a text with certain words removed. Participants are asked to replace the missing items. Responses are recorded when clicking a button. Optionally, responses are evaluated and a function is called in case of differences, making it possible to inform participants about mistakes.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter     | Type     | Default Value      | Description                              |
-| ------------- | -------- | ------------------ | ---------------------------------------- |
-| text          | string   | *undefined*        | The cloze text to be displayed. Blanks are indicated by %% signs and automatically replaced by input fields. If there is a correct answer you want the system to check against, it must be typed between the two percentage signs (i.e. % correct solution %). |
-| button_text   | string   | OK                 | Text of the button participants have to press for finishing the cloze test. |
-| check_answers | boolean  | false              | Boolean value indicating if the answers given by participants should be compared against a correct solution given in the text (between % signs) after the button was clicked. If ```true```, answers are checked and in case of differences, the ```mistake_fn``` is called. In this case, the trial does not automatically finish. If ```false```, no checks are performed and the trial automatically ends when clicking the button. |
-| mistake_fn    | function | ```function(){}``` | Function called if ```check_answers``` is set to ```true``` and there is a difference between the participants answers and the correct solution provided in the text. |
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name     | Type             | Value                       |
-| -------- | ---------------- | --------------------------- |
-| response | array of strings | Answers the partcipant gave |
-
-## Examples
-
-#### Simple cloze using default settings (no check against correct solution, no custom button text)
-
-```javascript
-var trial = {
-	type: 'cloze',
-	text: 'The %% is the largest terrestrial mammal. It lives in both %% and %%.'
-};
-```
-
-#### More elaborate example (with check against correct solution, custom error handling and modified button text)
-
-```javascript
-var trial = {
-    type: 'cloze',
-    text: 'A rectangle has % 4 % corners and a triangle has % 3 %.',
-    check_answers: true,
-    button_text: 'Next',
-    mistake_fn: function(){alert("Wrong answer. Please check again.")}
-};
-```