From 110420932cab41b949d50aeb0339d50de3c61ae8 Mon Sep 17 00:00:00 2001 From: Josh de Leeuw Date: Fri, 1 Oct 2021 14:23:47 -0400 Subject: [PATCH] fix broken links and titles --- docs/developers/extension-development.md | 2 +- docs/extensions/list-of-extensions.md | 2 +- docs/extensions/webgazer.md | 2 +- docs/overview/extensions.md | 2 +- docs/overview/eye-tracking.md | 8 +- docs/overview/media-preloading.md | 2 +- docs/overview/prolific.md | 2 +- docs/overview/running-experiments.md | 2 +- docs/plugins/animation.md | 2 +- docs/plugins/audio-button-response.md | 4 +- docs/plugins/audio-keyboard-response.md | 4 +- docs/plugins/audio-slider-response.md | 4 +- docs/plugins/call-function.md | 2 +- docs/plugins/canvas-button-response.md | 2 +- docs/plugins/canvas-keyboard-response.md | 2 +- docs/plugins/canvas-slider-response.md | 2 +- docs/plugins/categorize-animation.md | 2 +- docs/plugins/categorize-html.md | 2 +- docs/plugins/categorize-image.md | 2 +- docs/plugins/cloze.md | 2 +- docs/plugins/external-html.md | 2 +- docs/plugins/free-sort.md | 2 +- docs/plugins/fullscreen.md | 2 +- docs/plugins/html-button-response.md | 2 +- docs/plugins/html-keyboard-response.md | 2 +- docs/plugins/html-slider-response.md | 2 +- docs/plugins/iat-html.md | 2 +- docs/plugins/iat-image.md | 2 +- docs/plugins/image-button-response.md | 4 +- docs/plugins/image-keyboard-response.md | 4 +- docs/plugins/image-slider-response.md | 4 +- docs/plugins/instructions.md | 2 +- docs/plugins/list-of-plugins.md | 90 +++++++++++----------- docs/plugins/maxdiff.md | 2 +- docs/plugins/preload.md | 2 +- docs/plugins/reconstruction.md | 2 +- docs/plugins/resize.md | 2 +- docs/plugins/same-different-html.md | 2 +- docs/plugins/same-different-image.md | 2 +- docs/plugins/serial-reaction-time-mouse.md | 2 +- docs/plugins/serial-reaction-time.md | 2 +- docs/plugins/survey-html-form.md | 2 +- docs/plugins/survey-likert.md | 2 +- docs/plugins/survey-multi-choice.md | 2 +- docs/plugins/survey-multi-select.md | 2 +- docs/plugins/survey-text.md | 2 +- docs/plugins/video-button-response.md | 4 +- docs/plugins/video-keyboard-response.md | 4 +- docs/plugins/video-slider-response.md | 4 +- docs/plugins/virtual-chinrest.md | 2 +- docs/plugins/visual-search-circle.md | 2 +- docs/plugins/webgazer-calibrate.md | 4 +- docs/plugins/webgazer-init-camera.md | 4 +- docs/plugins/webgazer-validate.md | 4 +- docs/tutorials/hello-world.md | 10 +-- docs/tutorials/rt-task.md | 4 +- 56 files changed, 120 insertions(+), 120 deletions(-) diff --git a/docs/developers/extension-development.md b/docs/developers/extension-development.md index d8fc3ff4..8e175acd 100644 --- a/docs/developers/extension-development.md +++ b/docs/developers/extension-development.md @@ -158,7 +158,7 @@ MyAwesomeExtension.info = { ### Optional methods -The extension can also include any additional methods that are necessary for interacting with it. See the [webgazer extension](../extensions/jspsych-ext-webgazer.md) for an example. +The extension can also include any additional methods that are necessary for interacting with it. See the [webgazer extension](../extensions/webgazer.md) for an example. ## Advice for writing extensions diff --git a/docs/extensions/list-of-extensions.md b/docs/extensions/list-of-extensions.md index b2fe43c8..92cae8e9 100644 --- a/docs/extensions/list-of-extensions.md +++ b/docs/extensions/list-of-extensions.md @@ -9,4 +9,4 @@ For an overview of what extensions are and how they work, see our [extensions ov Extension | Description ------ | ----------- -[jspsych‑ext‑webgazer](../extensions/jspsych-ext-webgazer.md) | Enables eye tracking using the [WebGazer](https://webgazer.cs.brown.edu/) library. \ No newline at end of file +[jspsych‑ext‑webgazer](../extensions/webgazer.md) | Enables eye tracking using the [WebGazer](https://webgazer.cs.brown.edu/) library. \ No newline at end of file diff --git a/docs/extensions/webgazer.md b/docs/extensions/webgazer.md index a521c50b..3d25fecc 100644 --- a/docs/extensions/webgazer.md +++ b/docs/extensions/webgazer.md @@ -1,4 +1,4 @@ -# jspsych-ext-webgazer +# webgazer This extension supports eye tracking through the [WebGazer](https://webgazer.cs.brown.edu/) library. For a narrative description of how to use this extension see the [eye tracking overview](../overview/eye-tracking.md). diff --git a/docs/overview/extensions.md b/docs/overview/extensions.md index d38a2ddc..09fb3c01 100644 --- a/docs/overview/extensions.md +++ b/docs/overview/extensions.md @@ -35,7 +35,7 @@ var trial = { Extension | Description ------ | ----------- -[jspsych‑ext‑webgazer.js](../extensions/jspsych-ext-webgazer.md) | Enables eye tracking using the [WebGazer](https://webgazer.cs.brown.edu/) library. +[jspsych‑ext‑webgazer.js](../extensions/webgazer.md) | Enables eye tracking using the [WebGazer](https://webgazer.cs.brown.edu/) library. ## Writing an Extension diff --git a/docs/overview/eye-tracking.md b/docs/overview/eye-tracking.md index 93dfb9f6..a119e9dd 100644 --- a/docs/overview/eye-tracking.md +++ b/docs/overview/eye-tracking.md @@ -29,7 +29,7 @@ Instead, it can be found on the jsdelivr.net CDN at: "https://cdn.jsdelivr.net/g ### Load the jsPsych webgazer extension -The [webgazer extension](../extensions/jspsych-ext-webgazer.md) adds functionality to jsPsych for interacting with webgazer. Load it like you would a plugin file. +The [webgazer extension](../extensions/webgazer.md) adds functionality to jsPsych for interacting with webgazer. Load it like you would a plugin file. ```html @@ -51,7 +51,7 @@ initJsPsych({ ### Initialize the camera -To help the participant position their face correctly for eye tracking you can use the [jspsych-webgazer-init-camera plugin](../plugins/jspsych-webgazer-init-camera.md). This will show the participant what the camera sees, including facial feature landmarks, and prevent the participant from continuing until their face is in good position for eye tracking. This plugin will also trigger the experiment to request permission to access the user's webcam if it hasn't already been granted. +To help the participant position their face correctly for eye tracking you can use the [webgazer-init-camera plugin](../plugins/webgazer-init-camera.md). This will show the participant what the camera sees, including facial feature landmarks, and prevent the participant from continuing until their face is in good position for eye tracking. This plugin will also trigger the experiment to request permission to access the user's webcam if it hasn't already been granted. ```js @@ -63,7 +63,7 @@ var init_camera_trial = { ### Calibration -To calibrate WebGazer, you can use the [jspsych-webgazer-calibrate plugin](../plugins/jspsych-webgazer-calibrate.md). This plugin allows you to specify a set of points on the screen for calibration and to choose the method for calibrating -- either clicking on each point or simply fixating on each point. The location of calibration points is specified in percentages, e.g., `[25,50]` will result in a point that is 25% of the width of the screen from the left edge and 50% of the height of the screen from the top edge. Options for controlling other details of the calibration are explained in the [documentation for the plugin](../plugins/jspsych-webgazer-calibrate.md). +To calibrate WebGazer, you can use the [webgazer-calibrate plugin](../plugins/webgazer-calibrate.md). This plugin allows you to specify a set of points on the screen for calibration and to choose the method for calibrating -- either clicking on each point or simply fixating on each point. The location of calibration points is specified in percentages, e.g., `[25,50]` will result in a point that is 25% of the width of the screen from the left edge and 50% of the height of the screen from the top edge. Options for controlling other details of the calibration are explained in the [documentation for the plugin](../plugins/webgazer-calibrate.md). Note that instructions are not included in the calibration plugin, so you'll likely want to use a different plugin (e.g., `html-button-response`) to display instructions prior to running the calibration. @@ -78,7 +78,7 @@ var calibration_trial = { ### Validation -To measure the accuracy and precision of the calibration, you can use the [jspsych-webgazer-vaidate plugin](../plugins/jspsych-webgazer-validate.md). Like the calibration plugin, you can specify a list of points to perform validation on. Here you can specify the points as either percentages or in terms of the distance from the center of the screen in pixels. Which mode you use will probably depend on how you are defining your stimuli throughout the experiment. You can also specify the radius of tolerance around each point, and the plugin will calculate the percentage of measured gaze samples within that radius. This is a potentially useful heuristic for deciding whether or not to calibrate again. Options for controlling other details of the validation are explained in the [documentation for the plugin](../plugins/jspsych-webgazer-validate.md). +To measure the accuracy and precision of the calibration, you can use the [webgazer-vaidate plugin](../plugins/webgazer-validate.md). Like the calibration plugin, you can specify a list of points to perform validation on. Here you can specify the points as either percentages or in terms of the distance from the center of the screen in pixels. Which mode you use will probably depend on how you are defining your stimuli throughout the experiment. You can also specify the radius of tolerance around each point, and the plugin will calculate the percentage of measured gaze samples within that radius. This is a potentially useful heuristic for deciding whether or not to calibrate again. Options for controlling other details of the validation are explained in the [documentation for the plugin](../plugins/webgazer-validate.md). ```js diff --git a/docs/overview/media-preloading.md b/docs/overview/media-preloading.md index 9cf1096d..faf94084 100644 --- a/docs/overview/media-preloading.md +++ b/docs/overview/media-preloading.md @@ -1,6 +1,6 @@ # Media Preloading -If an experiment uses image, audio, or video files as stimuli, it is a good idea to preload the files before running the experiment. You can preload files at any point in your experiment using the [jsPsych `preload` plugin](../plugins/jspsych-preload.md). Preloading files means that the subject's browser will download the files and store them in local memory on the subject's computer. This is important because displaying or playing a media file is much faster if it is already in memory on the subject's computer. Without preloading, there will be noticeable delays in the display of media, which will affect any timing measurements (such as how long an image is displayed, or a subject's response time since first viewing an image). For particularly large files, like video, preloading content avoids lengthy pauses in the middle of the experiment that can be disruptive to the flow of the experiment. +If an experiment uses image, audio, or video files as stimuli, it is a good idea to preload the files before running the experiment. You can preload files at any point in your experiment using the [jsPsych `preload` plugin](../plugins/preload.md). Preloading files means that the subject's browser will download the files and store them in local memory on the subject's computer. This is important because displaying or playing a media file is much faster if it is already in memory on the subject's computer. Without preloading, there will be noticeable delays in the display of media, which will affect any timing measurements (such as how long an image is displayed, or a subject's response time since first viewing an image). For particularly large files, like video, preloading content avoids lengthy pauses in the middle of the experiment that can be disruptive to the flow of the experiment. !!! warning Note that video preloading will not work when you run your experiment offline (e.g., by double-clicking on the HTML file), but it will work once your experiment is running online (hosted on a server). The [Cross-origin requests (CORS) and safe mode](running-experiments.md#cross-origin-requests-cors-and-safe-mode) section on the Running Experiments page contains more information about this. diff --git a/docs/overview/prolific.md b/docs/overview/prolific.md index 23a767b8..fa0a14fb 100644 --- a/docs/overview/prolific.md +++ b/docs/overview/prolific.md @@ -43,7 +43,7 @@ When the experiment is complete, Prolific requires that you send the participant You can accomplish this in a couple different ways. !!! warning - It's important that you've saved all the data from your experiment before the participant returns to Prolific. Make sure that any server communication has completed prior to redirecting the participant. One way to do this is by using the async features of the `call-function` plugin ([example](../plugins/jspsych-call-function.md#async-function-call)). + It's important that you've saved all the data from your experiment before the participant returns to Prolific. Make sure that any server communication has completed prior to redirecting the participant. One way to do this is by using the async features of the `call-function` plugin ([example](../plugins/call-function.md#async-function-call)). ### Participant clicks a link diff --git a/docs/overview/running-experiments.md b/docs/overview/running-experiments.md index 444fc2fd..92c0ecbf 100644 --- a/docs/overview/running-experiments.md +++ b/docs/overview/running-experiments.md @@ -40,7 +40,7 @@ The `override_safe_mode` parameter also has no effect when your experiment is ru While running your experiment offline, any media files are likely to load very quickly because they are stored on your own computer's disk. Therefore you may not notice problems with file loading delays while running your experiment locally (either offline or on a _local_ server) because the files will load fast enough that they never cause disruption. However, when your experiment is hosted on a _remote_ server, the files will need to be transferred over the internet, which means they will take longer to load - in some cases much longer. Loading delays are most noticeable with media files: images, audio, and video. As explained on the [Media Preloading](media-preloading.md) page, loading delays during your experiment can cause problems for stimulus display and response times. -It is important to test your experiment to ensure that any media files are preloading successfully and not being requested again during the experiment. You can use the Network tab in your browser's developer tools to see when files are loaded and to simulate a slow internet connection (see [here](https://developers.google.com/web/tools/chrome-devtools/network) for Chrome Network tab documentation). If you are preloading many and/or large files, such as videos, you may want to increase the `max_load_time` parameter in [`the preload plugin`](../plugins/jspsych-preload.md) so that participants with slow/unreliable internet connections will be able to take part in your experiment. +It is important to test your experiment to ensure that any media files are preloading successfully and not being requested again during the experiment. You can use the Network tab in your browser's developer tools to see when files are loaded and to simulate a slow internet connection (see [here](https://developers.google.com/web/tools/chrome-devtools/network) for Chrome Network tab documentation). If you are preloading many and/or large files, such as videos, you may want to increase the `max_load_time` parameter in [`the preload plugin`](../plugins/preload.md) so that participants with slow/unreliable internet connections will be able to take part in your experiment. ### Permanent data storage diff --git a/docs/plugins/animation.md b/docs/plugins/animation.md index 979f9804..8b4f837d 100644 --- a/docs/plugins/animation.md +++ b/docs/plugins/animation.md @@ -1,4 +1,4 @@ -# jspsych-animation +# animation This plugin displays a sequence of images at a fixed frame rate. The sequence can be looped a specified number of times. The subject is free to respond at any point during the animation, and the time of the response is recorded. diff --git a/docs/plugins/audio-button-response.md b/docs/plugins/audio-button-response.md index 41fc29b5..141e101a 100644 --- a/docs/plugins/audio-button-response.md +++ b/docs/plugins/audio-button-response.md @@ -1,10 +1,10 @@ -# jspsych-audio-button-response +# audio-button-response This plugin plays audio files and records responses generated with a button click. 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, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the audio. +Audio files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if you are using timeline variables or another dynamic method to specify the audio stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the audio. The trial can end when the subject responds, when the audio file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent a button response from being made before the audio has finished playing. diff --git a/docs/plugins/audio-keyboard-response.md b/docs/plugins/audio-keyboard-response.md index e7fda8ba..e462921d 100644 --- a/docs/plugins/audio-keyboard-response.md +++ b/docs/plugins/audio-keyboard-response.md @@ -1,10 +1,10 @@ -# jspsych-audio-keyboard-response +# audio-keyboard-response This plugin plays audio files and records responses generated with the keyboard. 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.md#manual-preloading) the audio. +Audio files can be automatically preloaded by jsPsych using the [`preload` plugin](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.md#manual-preloading) the audio. The trial can end when the subject responds, when the audio file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent a keyboard response from being recorded before the audio has finished playing. diff --git a/docs/plugins/audio-slider-response.md b/docs/plugins/audio-slider-response.md index 2510ecb2..b90216e5 100644 --- a/docs/plugins/audio-slider-response.md +++ b/docs/plugins/audio-slider-response.md @@ -1,10 +1,10 @@ -# jspsych-audio-slider-response +# 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.md#manual-preloading) the audio. +Audio files can be automatically preloaded by jsPsych using the [`preload` plugin](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.md#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. diff --git a/docs/plugins/call-function.md b/docs/plugins/call-function.md index 19f6114e..3a8fa1a3 100644 --- a/docs/plugins/call-function.md +++ b/docs/plugins/call-function.md @@ -1,4 +1,4 @@ -# jspsych-call-function +# call-function This plugin executes a specified function. This allows the experimenter to run arbitrary code at any point during the experiment. diff --git a/docs/plugins/canvas-button-response.md b/docs/plugins/canvas-button-response.md index 797a998f..58214449 100644 --- a/docs/plugins/canvas-button-response.md +++ b/docs/plugins/canvas-button-response.md @@ -1,4 +1,4 @@ -# jspsych-canvas-button-response +# 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. diff --git a/docs/plugins/canvas-keyboard-response.md b/docs/plugins/canvas-keyboard-response.md index 2f30d316..db59a0bc 100644 --- a/docs/plugins/canvas-keyboard-response.md +++ b/docs/plugins/canvas-keyboard-response.md @@ -1,4 +1,4 @@ -# jspsych-canvas-keyboard-response +# 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. diff --git a/docs/plugins/canvas-slider-response.md b/docs/plugins/canvas-slider-response.md index 4fc3fb4c..ca105154 100644 --- a/docs/plugins/canvas-slider-response.md +++ b/docs/plugins/canvas-slider-response.md @@ -1,4 +1,4 @@ -# jspsych-canvas-slider-response +# 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. diff --git a/docs/plugins/categorize-animation.md b/docs/plugins/categorize-animation.md index 96ca18b2..c9a56c40 100644 --- a/docs/plugins/categorize-animation.md +++ b/docs/plugins/categorize-animation.md @@ -1,4 +1,4 @@ -# jspsych-categorize-animation +# 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. diff --git a/docs/plugins/categorize-html.md b/docs/plugins/categorize-html.md index ebca8dfb..fcb91640 100644 --- a/docs/plugins/categorize-html.md +++ b/docs/plugins/categorize-html.md @@ -1,4 +1,4 @@ -# jspsych-categorize-html +# 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. diff --git a/docs/plugins/categorize-image.md b/docs/plugins/categorize-image.md index f8aad8a3..b0582db3 100644 --- a/docs/plugins/categorize-image.md +++ b/docs/plugins/categorize-image.md @@ -1,4 +1,4 @@ -# jspsych-categorize-image +# 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. diff --git a/docs/plugins/cloze.md b/docs/plugins/cloze.md index cfcd876e..860b59c5 100644 --- a/docs/plugins/cloze.md +++ b/docs/plugins/cloze.md @@ -1,4 +1,4 @@ -# *jspsych-cloze +# 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. diff --git a/docs/plugins/external-html.md b/docs/plugins/external-html.md index d94ea7ab..5f58b715 100644 --- a/docs/plugins/external-html.md +++ b/docs/plugins/external-html.md @@ -1,4 +1,4 @@ -# jspsych-external-html plugin +# external-html plugin The HTML plugin displays an external HTML document (often a consent form). Either a keyboard response or a button press can be used to continue to the next trial. It allows the experimenter to check if conditions are met (such as indicating informed consent) before continuing. diff --git a/docs/plugins/free-sort.md b/docs/plugins/free-sort.md index 8f909990..998ff6a2 100644 --- a/docs/plugins/free-sort.md +++ b/docs/plugins/free-sort.md @@ -1,4 +1,4 @@ -# jspsych-free-sort plugin +# free-sort plugin The free-sort plugin displays one or more images on the screen that the participant can interact with by clicking and dragging with a mouse, or touching and dragging with a touchscreen device. When the trial starts, the images can be positioned outside or inside the sort area. All images must be moved into the sorting area before the participant can click a button to end the trial. All of the moves that the participant performs are recorded, as well as the final positions of all images. This plugin could be useful when asking participants to position images based on similarity to one another, or to recall image spatial locations. diff --git a/docs/plugins/fullscreen.md b/docs/plugins/fullscreen.md index 00117556..667ecf5d 100644 --- a/docs/plugins/fullscreen.md +++ b/docs/plugins/fullscreen.md @@ -1,4 +1,4 @@ -# jspsych-fullscreen plugin +# fullscreen plugin The fullscreen plugin allows the experiment to enter or exit fullscreen mode. For security reasons, all browsers require that entry into fullscreen mode is triggered by a user action. To enter fullscreen mode, this plugin has the user click a button. Exiting fullscreen mode can be done without user input. diff --git a/docs/plugins/html-button-response.md b/docs/plugins/html-button-response.md index 1bc06e99..1de80b16 100644 --- a/docs/plugins/html-button-response.md +++ b/docs/plugins/html-button-response.md @@ -1,4 +1,4 @@ -# jspsych-html-button-response +# html-button-response This plugin displays HTML content and records responses generated by button click. 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. The button itself can be customized using HTML formatting. diff --git a/docs/plugins/html-keyboard-response.md b/docs/plugins/html-keyboard-response.md index cb66542a..cda5be1c 100644 --- a/docs/plugins/html-keyboard-response.md +++ b/docs/plugins/html-keyboard-response.md @@ -1,4 +1,4 @@ -# jspsych-html-keyboard-response +# html-keyboard-response This plugin displays HTML content and records responses generated with the keyboard.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. diff --git a/docs/plugins/html-slider-response.md b/docs/plugins/html-slider-response.md index 3b6e114d..f8d0a71e 100644 --- a/docs/plugins/html-slider-response.md +++ b/docs/plugins/html-slider-response.md @@ -1,4 +1,4 @@ -# jspsych-html-slider-response +# html-slider-response This plugin displays HTML content and allows the subject to respond by dragging a slider. diff --git a/docs/plugins/iat-html.md b/docs/plugins/iat-html.md index 5aba3857..7bff6641 100644 --- a/docs/plugins/iat-html.md +++ b/docs/plugins/iat-html.md @@ -1,4 +1,4 @@ -# jspsych-iat-html plugin +# iat-html plugin This plugin runs a single trial of the [implicit association test (IAT)](https://implicit.harvard.edu/implicit/iatdetails.html), using HTML content as the stimulus. diff --git a/docs/plugins/iat-image.md b/docs/plugins/iat-image.md index ff979dfc..5e35f5a4 100644 --- a/docs/plugins/iat-image.md +++ b/docs/plugins/iat-image.md @@ -1,4 +1,4 @@ -jspsych-iat-image plugin +# iat-image This plugin runs a single trial of the [implicit association test (IAT)](https://implicit.harvard.edu/implicit/iatdetails.html), using an image as the stimulus. diff --git a/docs/plugins/image-button-response.md b/docs/plugins/image-button-response.md index 17b934a5..95bf06bf 100644 --- a/docs/plugins/image-button-response.md +++ b/docs/plugins/image-button-response.md @@ -1,8 +1,8 @@ -# jspsych-image-button-response +# image-button-response This plugin displays an image and records responses generated with a button click. 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. The button itself can be customized using HTML formatting. -Image 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 image stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the images. +Image files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if you are using timeline variables or another dynamic method to specify the image stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the images. ## Parameters diff --git a/docs/plugins/image-keyboard-response.md b/docs/plugins/image-keyboard-response.md index a39b955a..4775698f 100644 --- a/docs/plugins/image-keyboard-response.md +++ b/docs/plugins/image-keyboard-response.md @@ -1,8 +1,8 @@ -# jspsych-image-keyboard-response +# image-keyboard-response This plugin displays and image and records responses generated with the keyboard. 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. -Image 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 image stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the images. +Image files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if you are using timeline variables or another dynamic method to specify the image stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the images. ## Parameters diff --git a/docs/plugins/image-slider-response.md b/docs/plugins/image-slider-response.md index 88854bb8..9ac4a229 100644 --- a/docs/plugins/image-slider-response.md +++ b/docs/plugins/image-slider-response.md @@ -1,8 +1,8 @@ -# jspsych-image-slider-response +# image-slider-response This plugin displays and image and allows the subject to respond by dragging a slider. -Image 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 image stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the images. +Image files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if you are using timeline variables or another dynamic method to specify the image stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the images. ## Parameters diff --git a/docs/plugins/instructions.md b/docs/plugins/instructions.md index 41bc17ea..66ced9da 100644 --- a/docs/plugins/instructions.md +++ b/docs/plugins/instructions.md @@ -1,4 +1,4 @@ -# jspsych-instructions plugin +# instructions plugin This plugin is for showing instructions to the subject. It allows subjects to navigate through multiple pages of instructions at their own pace, recording how long the subject spends on each page. Navigation can be done using the mouse or keyboard. Subjects can be allowed to navigate forwards and backwards through pages, if desired. diff --git a/docs/plugins/list-of-plugins.md b/docs/plugins/list-of-plugins.md index 99fc5540..eb7a36a5 100644 --- a/docs/plugins/list-of-plugins.md +++ b/docs/plugins/list-of-plugins.md @@ -8,48 +8,48 @@ For an overview of what plugins are and how they work, see our [plugins overview Plugin | Description ------ | ----------- -[jspsych‑animation](jspsych-animation) | Shows a sequence of images at a specified frame rate. Records key presses (including timing information) made by the subject while they are viewing the animation. -[jspsych‑audio‑button‑response](jspsych-audio-button-response) | Play an audio file and allow the subject to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons. -[jspsych‑audio‑keyboard‑response](jspsych-audio-keyboard-response) | Play an audio file and allow the subject to respond by pressing a key. -[jspsych‑audio‑slider‑response](jspsych-audio-slider-response) | Play an audio file and allow the subject to respond by moving a slider to indicate a value. -[jspsych‑call‑function](jspsych-call-function) | Executes an arbitrary function call. Doesn't display anything to the subject, and the subject is usually unaware that this plugin has even executed. It's useful for performing tasks at specified times in the experiment, such as saving data. -[jspsych‑canvas‑button‑response](jspsych-canvas-button-response) | Draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and record a button click response. Useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). -[jspsych‑canvas‑keyboard‑response](jspsych-canvas-keyboard-response) | Draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and record a key press response. Useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). -[jspsych‑canvas‑slider‑response](jspsych-canvas-slider-response) | Draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and ask the subject to respond by moving a slider to indicate a value. Useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). -[jspsych‑categorize‑animation](jspsych-categorize-animation) | The subject responds to an animation and can be given feedback about their response. -[jspsych‑categorize‑html](jspsych-categorize-html) | The subject responds to an HTML-formatted stimulus using the keyboard and can be given feedback about the correctness of their response. -[jspsych‑categorize‑image](jspsych-categorize-image) | The subject responds to an image using the keyboard and can be given feedback about the correctness of their response. -[jspsych‑cloze](jspsych-cloze) | Plugin for displaying a cloze test and checking participants answers against a correct solution. -[jspsych‑external‑html](jspsych-external-html) | Displays an external HTML page (such as a consent form) and lets the subject respond by clicking a button or pressing a key. Plugin can validate their response, which is useful for making sure that a subject has granted consent before starting the experiment. -[jspsych‑free‑sort](jspsych-free-sort) | Displays a set of images on the screen in random locations. Subjects can click and drag the images to move them around the screen. Records all the moves made by the subject, so the sequence of moves can be recovered from the data. -[jspsych‑fullscreen](jspsych-fullscreen) | Toggles the experiment in and out of fullscreen mode. -[jspsych‑html‑button‑response](jspsych-html-button-response) | Display an HTML-formatted stimulus and allow the subject to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons. -[jspsych‑html‑keyboard‑response](jspsych-html-keyboard-response) | Display an HTML-formatted stimulus and allow the subject to respond by pressing a key. -[jspsych‑html‑slider‑response](jspsych-html-slider-response) | Display an HTML-formatted stimulus and allow the subject to respond by moving a slider to indicate a value. -[jspsych‑iat‑html](jspsych-iat-html) | The implicit association task, using HTML-formatted stimuli. -[jspsych‑iat‑image](jspsych-iat-image) | The implicit association task, using images as stimuli. -[jspsych‑image‑button‑response](jspsych-image-button-response) | Display an image and allow the subject to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons. -[jspsych‑image‑keyboard‑response](jspsych-image-keyboard-response) | Display an image and allow the subject to respond by pressing a key. -[jspsych‑image‑slider‑response](jspsych-image-slider-response) | Display an image and allow the subject to respond by moving a slider to indicate a value. -[jspsych‑instructions](jspsych-instructions) | For displaying instructions to the subject. Allows the subject to navigate between pages of instructions using keys or buttons. -[jspsych‑maxdiff](jspsych-maxdiff) | Displays rows of alternatives to be selected for two mutually-exclusive categories, typically as 'most' or 'least' on a particular criteria (e.g. importance, preference, similarity). The participant responds by selecting one radio button corresponding to an alternative in both the left and right response columns. -[jspsych‑preload](jspsych-preload) | This plugin loads images, audio, and video files into the browser's memory before they are needed in the experiment, in order to improve stimulus and response timing, and to avoid disrupting the flow of the experiment. -[jspsych‑reconstruction](jspsych-reconstruction) | The subject interacts with a stimulus by modifying a parameter of the stimulus and observing the change in the stimulus in real-time. -[jspsych‑resize](jspsych-resize) | Calibrate the display so that materials display with a known physical size. -[jspsych‑same‑different‑html](jspsych-same-different-html) | A same-different judgment task. An HTML-formatted stimulus is shown, followed by a brief gap, and then another stimulus is shown. The subject indicates whether the stimuli are the same or different. -[jspsych‑same‑different‑image](jspsych-same-different-image) | A same-different judgment task. An image is shown, followed by a brief gap, and then another stimulus is shown. The subject indicates whether the stimuli are the same or different. -[jspsych‑serial‑reaction‑time](jspsych-serial-reaction-time) | A set of boxes are displayed on the screen and one of them changes color. The subject presses a key that corresponds to the different color box as fast as possible. -[jspsych‑serial‑reaction‑time‑mouse](jspsych-serial-reaction-time-mouse) | A set of boxes are displayed on the screen and one of them changes color. The subjects clicks the box that changed color as fast as possible. -[jspsych‑survey‑html‑form](jspsych-survey-html-form) | Renders a custom HTML form. Allows for mixing multiple kinds of form input. -[jspsych‑survey‑likert](jspsych-survey-likert) | Displays likert-style questions. -[jspsych‑survey‑multi‑choice](jspsych-survey-multi-choice) | Displays multiple choice questions with one answer allowed per question. -[jspsych‑survey‑multi‑select](jspsych-survey-multi-select) | Displays multiple choice questions with multiple answes allowed per question. -[jspsych‑survey‑text](jspsych-survey-text) | Shows a prompt with a text box. The subject writes a response and then submits by clicking a button. -[jspsych‑video‑button‑response](jspsych-video-button-response) | Displays a video file with many options for customizing playback. Subject responds to the video by pressing a button. -[jspsych‑video‑keyboard‑response](jspsych-video-keyboard-response) | Displays a video file with many options for customizing playback. Subject responds to the video by pressing a key. -[jspsych‑video‑slider‑response](jspsych-video-slider-response) | Displays a video file with many options for customizing playback. Subject responds to the video by moving a slider. -[jspsych‑virtual‑chinrest](jspsych-virtual-chinrest) | An implementation of the "virutal chinrest" procedure developed by [Li, Joo, Yeatman, and Reinecke (2020)](https://doi.org/10.1038/s41598-019-57204-1). Calibrates the monitor to display items at a known physical size by having participants scale an image to be the same size as a physical credit card. Then uses a blind spot task to estimate the distance between the participant and the display. -[jspsych‑visual‑search‑circle](jspsych-visual-search-circle) | A customizable visual-search task modelled after [Wang, Cavanagh, & Green (1994)](http://dx.doi.org/10.3758/BF03206946). The subject indicates whether or not a target is present among a set of distractors. The stimuli are displayed in a circle, evenly-spaced, equidistant from a fixation point. -[jspsych‑webgazer‑calibrate](jspsych-webgazer-calibrate) | Calibrates the WebGazer extension for eye tracking. -[jspsych‑webgazer‑init‑camera](jspsych-webgazer-init-camera) | Initializes the camera and helps the participant center their face for eye tracking. -[jspsych‑webgazer‑validate](jspsych-webgazer-validate) | Performs validation to measure precision and accuracy of WebGazer eye tracking predictions. +[animation](animation) | Shows a sequence of images at a specified frame rate. Records key presses (including timing information) made by the subject while they are viewing the animation. +[audio‑button‑response](audio-button-response) | Play an audio file and allow the subject to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons. +[audio‑keyboard‑response](audio-keyboard-response) | Play an audio file and allow the subject to respond by pressing a key. +[audio‑slider‑response](audio-slider-response) | Play an audio file and allow the subject to respond by moving a slider to indicate a value. +[call‑function](call-function) | Executes an arbitrary function call. Doesn't display anything to the subject, and the subject is usually unaware that this plugin has even executed. It's useful for performing tasks at specified times in the experiment, such as saving data. +[canvas‑button‑response](canvas-button-response) | Draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and record a button click response. Useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). +[canvas‑keyboard‑response](canvas-keyboard-response) | Draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and record a key press response. Useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). +[canvas‑slider‑response](canvas-slider-response) | Draw a stimulus on a [HTML canvas element](https://www.w3schools.com/html/html5_canvas.asp), and ask the subject to respond by moving a slider to indicate a value. Useful for displaying dynamic, parametrically-defined graphics, and for controlling the positioning of multiple graphical elements (shapes, text, images). +[categorize‑animation](categorize-animation) | The subject responds to an animation and can be given feedback about their response. +[categorize‑html](categorize-html) | The subject responds to an HTML-formatted stimulus using the keyboard and can be given feedback about the correctness of their response. +[categorize‑image](categorize-image) | The subject responds to an image using the keyboard and can be given feedback about the correctness of their response. +[cloze](cloze) | Plugin for displaying a cloze test and checking participants answers against a correct solution. +[external‑html](external-html) | Displays an external HTML page (such as a consent form) and lets the subject respond by clicking a button or pressing a key. Plugin can validate their response, which is useful for making sure that a subject has granted consent before starting the experiment. +[free‑sort](free-sort) | Displays a set of images on the screen in random locations. Subjects can click and drag the images to move them around the screen. Records all the moves made by the subject, so the sequence of moves can be recovered from the data. +[fullscreen](fullscreen) | Toggles the experiment in and out of fullscreen mode. +[html‑button‑response](html-button-response) | Display an HTML-formatted stimulus and allow the subject to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons. +[html‑keyboard‑response](html-keyboard-response) | Display an HTML-formatted stimulus and allow the subject to respond by pressing a key. +[html‑slider‑response](html-slider-response) | Display an HTML-formatted stimulus and allow the subject to respond by moving a slider to indicate a value. +[iat‑html](iat-html) | The implicit association task, using HTML-formatted stimuli. +[iat‑image](iat-image) | The implicit association task, using images as stimuli. +[image‑button‑response](image-button-response) | Display an image and allow the subject to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons. +[image‑keyboard‑response](image-keyboard-response) | Display an image and allow the subject to respond by pressing a key. +[image‑slider‑response](image-slider-response) | Display an image and allow the subject to respond by moving a slider to indicate a value. +[instructions](instructions) | For displaying instructions to the subject. Allows the subject to navigate between pages of instructions using keys or buttons. +[maxdiff](maxdiff) | Displays rows of alternatives to be selected for two mutually-exclusive categories, typically as 'most' or 'least' on a particular criteria (e.g. importance, preference, similarity). The participant responds by selecting one radio button corresponding to an alternative in both the left and right response columns. +[preload](preload) | This plugin loads images, audio, and video files into the browser's memory before they are needed in the experiment, in order to improve stimulus and response timing, and to avoid disrupting the flow of the experiment. +[reconstruction](reconstruction) | The subject interacts with a stimulus by modifying a parameter of the stimulus and observing the change in the stimulus in real-time. +[resize](resize) | Calibrate the display so that materials display with a known physical size. +[same‑different‑html](same-different-html) | A same-different judgment task. An HTML-formatted stimulus is shown, followed by a brief gap, and then another stimulus is shown. The subject indicates whether the stimuli are the same or different. +[same‑different‑image](same-different-image) | A same-different judgment task. An image is shown, followed by a brief gap, and then another stimulus is shown. The subject indicates whether the stimuli are the same or different. +[serial‑reaction‑time](serial-reaction-time) | A set of boxes are displayed on the screen and one of them changes color. The subject presses a key that corresponds to the different color box as fast as possible. +[serial‑reaction‑time‑mouse](serial-reaction-time-mouse) | A set of boxes are displayed on the screen and one of them changes color. The subjects clicks the box that changed color as fast as possible. +[survey‑html‑form](survey-html-form) | Renders a custom HTML form. Allows for mixing multiple kinds of form input. +[survey‑likert](survey-likert) | Displays likert-style questions. +[survey‑multi‑choice](survey-multi-choice) | Displays multiple choice questions with one answer allowed per question. +[survey‑multi‑select](survey-multi-select) | Displays multiple choice questions with multiple answes allowed per question. +[survey‑text](survey-text) | Shows a prompt with a text box. The subject writes a response and then submits by clicking a button. +[video‑button‑response](video-button-response) | Displays a video file with many options for customizing playback. Subject responds to the video by pressing a button. +[video‑keyboard‑response](video-keyboard-response) | Displays a video file with many options for customizing playback. Subject responds to the video by pressing a key. +[video‑slider‑response](video-slider-response) | Displays a video file with many options for customizing playback. Subject responds to the video by moving a slider. +[virtual‑chinrest](virtual-chinrest) | An implementation of the "virutal chinrest" procedure developed by [Li, Joo, Yeatman, and Reinecke (2020)](https://doi.org/10.1038/s41598-019-57204-1). Calibrates the monitor to display items at a known physical size by having participants scale an image to be the same size as a physical credit card. Then uses a blind spot task to estimate the distance between the participant and the display. +[visual‑search‑circle](visual-search-circle) | A customizable visual-search task modelled after [Wang, Cavanagh, & Green (1994)](http://dx.doi.org/10.3758/BF03206946). The subject indicates whether or not a target is present among a set of distractors. The stimuli are displayed in a circle, evenly-spaced, equidistant from a fixation point. +[webgazer‑calibrate](webgazer-calibrate) | Calibrates the WebGazer extension for eye tracking. +[webgazer‑init‑camera](webgazer-init-camera) | Initializes the camera and helps the participant center their face for eye tracking. +[webgazer‑validate](webgazer-validate) | Performs validation to measure precision and accuracy of WebGazer eye tracking predictions. diff --git a/docs/plugins/maxdiff.md b/docs/plugins/maxdiff.md index bd2c0d17..d34fcff9 100644 --- a/docs/plugins/maxdiff.md +++ b/docs/plugins/maxdiff.md @@ -1,4 +1,4 @@ -# jspsych-maxdiff plugin +# maxdiff plugin The maxdiff plugin displays a table with rows of alternatives to be selected for two mutually-exclusive categories, typically as 'most' or 'least' on a particular criteria (e.g. importance, preference, similarity). The participant responds by selecting one radio button corresponding to an alternative in both the left and right response columns. The same alternative cannot be endorsed on both the left and right response columns (e.g. 'most' and 'least') simultaneously. diff --git a/docs/plugins/preload.md b/docs/plugins/preload.md index e7631ccf..e44e607f 100644 --- a/docs/plugins/preload.md +++ b/docs/plugins/preload.md @@ -1,4 +1,4 @@ -# jspsych-preload +# preload This plugin loads images, audio, and video files. It is used for loading files into the browser's memory before they are needed in the experiment, in order to improve stimulus and response timing, and avoid disruption to the experiment flow. We recommend using this plugin anytime you are loading media files, and especially when your experiment requires large and/or many media files. See the [Media Preloading page](../overview/media-preloading/) for more information. diff --git a/docs/plugins/reconstruction.md b/docs/plugins/reconstruction.md index 0a0b9dea..89ce12dc 100644 --- a/docs/plugins/reconstruction.md +++ b/docs/plugins/reconstruction.md @@ -1,4 +1,4 @@ -# jspsych-reconstruction plugin +# reconstruction plugin This plugin allows a subject to interact with a stimulus by modifying a parameter of the stimulus and observing the change in the stimulus in real-time. diff --git a/docs/plugins/resize.md b/docs/plugins/resize.md index db6db7dd..931732ce 100644 --- a/docs/plugins/resize.md +++ b/docs/plugins/resize.md @@ -1,4 +1,4 @@ -# jspsych-resize +# resize This plugin displays a resizable div container that allows the user to drag until the container is the same size as the item being measured. Once the user measures the item as close as possible, clicking the button sets a scaling factor for the div containing jsPsych content. This causes the stimuli that follow to have a known size, independent of monitor resolution. diff --git a/docs/plugins/same-different-html.md b/docs/plugins/same-different-html.md index dea2029b..9c88e430 100644 --- a/docs/plugins/same-different-html.md +++ b/docs/plugins/same-different-html.md @@ -1,4 +1,4 @@ -# jspsych-same-different-html plugin +# same-different-html plugin The same-different-html plugin displays two stimuli sequentially. Stimuli are HTML objects. The subject responds using the keyboard, and indicates whether the stimuli were the same or different. Same does not necessarily mean identical; a category judgment could be made, for example. diff --git a/docs/plugins/same-different-image.md b/docs/plugins/same-different-image.md index fbbd6f28..887e7e5f 100644 --- a/docs/plugins/same-different-image.md +++ b/docs/plugins/same-different-image.md @@ -1,4 +1,4 @@ -# jspsych-same-different-image plugin +# same-different-image plugin The same-different-image plugin displays two stimuli sequentially. Stimuli are images. The subject responds using the keyboard, and indicates whether the stimuli were the same or different. Same does not necessarily mean identical; a category judgment could be made, for example. diff --git a/docs/plugins/serial-reaction-time-mouse.md b/docs/plugins/serial-reaction-time-mouse.md index 8c8638b4..0b2b4a6a 100644 --- a/docs/plugins/serial-reaction-time-mouse.md +++ b/docs/plugins/serial-reaction-time-mouse.md @@ -1,4 +1,4 @@ -# jspsych-serial-reaction-time-mouse plugin +# serial-reaction-time-mouse plugin The serial reaction time mouse plugin implements a generalized version of the SRT task [(Nissen & Bullmer, 1987)](https://doi.org/10.1016%2F0010-0285%2887%2990002-8). Squares are displayed in a grid-based system on the screen, and one square changes color. The participant must click on the square that changes color. diff --git a/docs/plugins/serial-reaction-time.md b/docs/plugins/serial-reaction-time.md index 7d9db83b..190c79b1 100644 --- a/docs/plugins/serial-reaction-time.md +++ b/docs/plugins/serial-reaction-time.md @@ -1,4 +1,4 @@ -# jspsych-serial-reaction-time plugin +# serial-reaction-time plugin The serial reaction time plugin implements a generalized version of the SRT task [(Nissen & Bullemer, 1987)](https://doi.org/10.1016%2F0010-0285%2887%2990002-8). Squares are displayed in a grid-based system on the screen, and one square changes color. The participant presses a key that corresponds to the darkened key. Feedback is optionally displayed, showing the participant which square the key they pressed matches. diff --git a/docs/plugins/survey-html-form.md b/docs/plugins/survey-html-form.md index 47d30a62..57d2d3b5 100644 --- a/docs/plugins/survey-html-form.md +++ b/docs/plugins/survey-html-form.md @@ -1,4 +1,4 @@ -# jspsych-survey-html-form plugin +# survey-html-form plugin The survey-html-form plugin displays a set of `` from a HTML string. The type of input can be freely chosen, for a list of possible input types see the [MDN page on inputs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). The subject provides answers to the input fields. diff --git a/docs/plugins/survey-likert.md b/docs/plugins/survey-likert.md index 92a9a420..1276e500 100644 --- a/docs/plugins/survey-likert.md +++ b/docs/plugins/survey-likert.md @@ -1,4 +1,4 @@ -# jspsych-survey-likert plugin +# survey-likert plugin The survey-likert plugin displays a set of questions with Likert scale responses. The subject responds by selecting a radio button. diff --git a/docs/plugins/survey-multi-choice.md b/docs/plugins/survey-multi-choice.md index 62ec1b95..54427b2f 100644 --- a/docs/plugins/survey-multi-choice.md +++ b/docs/plugins/survey-multi-choice.md @@ -1,4 +1,4 @@ -# jspsych-survey-multi-choice plugin +# survey-multi-choice plugin The survey-multi-choice plugin displays a set of questions with multiple choice response fields. The subject selects a single answer. diff --git a/docs/plugins/survey-multi-select.md b/docs/plugins/survey-multi-select.md index b34b2833..9a8f9c5e 100644 --- a/docs/plugins/survey-multi-select.md +++ b/docs/plugins/survey-multi-select.md @@ -1,4 +1,4 @@ -# jspsych-survey-multi-select plugin +# survey-multi-select plugin The survey-multi-select plugin displays a set of questions with multiple select response fields. The subject could select multiple answers. diff --git a/docs/plugins/survey-text.md b/docs/plugins/survey-text.md index f3f1aa0e..5cdaf468 100644 --- a/docs/plugins/survey-text.md +++ b/docs/plugins/survey-text.md @@ -1,4 +1,4 @@ -# jspsych-survey-text plugin +# survey-text plugin The survey-text plugin displays a set of questions with free response text fields. The subject types in answers. diff --git a/docs/plugins/video-button-response.md b/docs/plugins/video-button-response.md index 83d374e1..bf010dfa 100644 --- a/docs/plugins/video-button-response.md +++ b/docs/plugins/video-button-response.md @@ -1,8 +1,8 @@ -# jspsych-video-button-response plugin +# video-button-response plugin This plugin plays a video and records responses generated by button click. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically when the subject responds, when the video file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent a button response from being made before the video has finished playing. The button itself can be customized using HTML formatting. -Video 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 video stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the videos. Also note that video preloading is disabled when the experiment is running as a file (i.e. opened directly in the browser, rather than through a server), in order to prevent CORS errors - see the section on [Running Experiments](../overview/running-experiments.md) for more information. +Video files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if you are using timeline variables or another dynamic method to specify the video stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the videos. Also note that video preloading is disabled when the experiment is running as a file (i.e. opened directly in the browser, rather than through a server), in order to prevent CORS errors - see the section on [Running Experiments](../overview/running-experiments.md) for more information. ## Parameters diff --git a/docs/plugins/video-keyboard-response.md b/docs/plugins/video-keyboard-response.md index f28e25f1..67e309ab 100644 --- a/docs/plugins/video-keyboard-response.md +++ b/docs/plugins/video-keyboard-response.md @@ -1,8 +1,8 @@ -# jspsych-video-keyboard-response plugin +# video-keyboard-response plugin This plugin plays a video file and records a keyboard response. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically when the subject responds, when the video file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent a keyboard response from being recorded before the video has finished playing. -Video 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 video stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the videos. Also note that video preloading is disabled when the experiment is running as a file (i.e. opened directly in the browser, rather than through a server), in order to prevent CORS errors - see the section on [Running Experiments](../overview/running-experiments.md) for more information. +Video files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if you are using timeline variables or another dynamic method to specify the video stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the videos. Also note that video preloading is disabled when the experiment is running as a file (i.e. opened directly in the browser, rather than through a server), in order to prevent CORS errors - see the section on [Running Experiments](../overview/running-experiments.md) for more information. ## Parameters diff --git a/docs/plugins/video-slider-response.md b/docs/plugins/video-slider-response.md index c1ec05b4..3345553b 100644 --- a/docs/plugins/video-slider-response.md +++ b/docs/plugins/video-slider-response.md @@ -1,8 +1,8 @@ -# jspsych-video-slider-response plugin +# video-slider-response plugin This plugin plays a video and allows the subject to respond by dragging a slider. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically when the subject responds, when the video file has finished playing, 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 video has finished playing. -Video 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 video stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the videos. Also note that video preloading is disabled when the experiment is running as a file (i.e. opened directly in the browser, rather than through a server), in order to prevent CORS errors - see the section on [Running Experiments](../overview/running-experiments.md) for more information. +Video files can be automatically preloaded by jsPsych using the [`preload` plugin](preload.md). However, if you are using timeline variables or another dynamic method to specify the video stimulus, you will need to [manually preload](../overview/media-preloading.md#manual-preloading) the videos. Also note that video preloading is disabled when the experiment is running as a file (i.e. opened directly in the browser, rather than through a server), in order to prevent CORS errors - see the section on [Running Experiments](../overview/running-experiments.md) for more information. ## Parameters diff --git a/docs/plugins/virtual-chinrest.md b/docs/plugins/virtual-chinrest.md index 304d01fd..aae94155 100644 --- a/docs/plugins/virtual-chinrest.md +++ b/docs/plugins/virtual-chinrest.md @@ -1,4 +1,4 @@ -# jspsych-virtual-chinrest +# virtual-chinrest This plugin provides a "virtual chinrest" that can measure the distance between the participant and the screen. It can also standardize the jsPsych page content to a known physical dimension (e.g., ensuring that a 200px wide stimulus is 2.2cm wide on the participant's monitor). This is based on the work of [Li, Joo, Yeatman, and Reinecke (2020)](https://doi.org/10.1038/s41598-019-57204-1), and the plugin code is a modified version of [their implementation](https://github.com/QishengLi/virtual_chinrest). We recommend citing their work in any paper that makes use of this plugin. diff --git a/docs/plugins/visual-search-circle.md b/docs/plugins/visual-search-circle.md index 4761dc6b..b7b4e3e2 100644 --- a/docs/plugins/visual-search-circle.md +++ b/docs/plugins/visual-search-circle.md @@ -1,4 +1,4 @@ -# jspsych-visual-search-circle plugin +# visual-search-circle plugin This plugin presents a customizable visual-search task modelled after [Wang, Cavanagh, & Green (1994)](http://dx.doi.org/10.3758/BF03206946). The subject indicates whether or not a target is present among a set of distractors. The stimuli are displayed in a circle, evenly-spaced, equidistant from a fixation point. Here is an example using normal and backward Ns: diff --git a/docs/plugins/webgazer-calibrate.md b/docs/plugins/webgazer-calibrate.md index f17b9137..6c0f41fd 100644 --- a/docs/plugins/webgazer-calibrate.md +++ b/docs/plugins/webgazer-calibrate.md @@ -1,6 +1,6 @@ -# jspsych-webgazer-calibrate +# webgazer-calibrate -This plugin can be used to calibrate the [WebGazer extension](../extensions/jspsych-ext-webgazer). For a narrative description of eye tracking with jsPsych, see the [eye tracking overview](../overview/eye-tracking). +This plugin can be used to calibrate the [WebGazer extension](../extensions/webgazer). For a narrative description of eye tracking with jsPsych, see the [eye tracking overview](../overview/eye-tracking). ## Parameters diff --git a/docs/plugins/webgazer-init-camera.md b/docs/plugins/webgazer-init-camera.md index 9723757f..458e369b 100644 --- a/docs/plugins/webgazer-init-camera.md +++ b/docs/plugins/webgazer-init-camera.md @@ -1,6 +1,6 @@ -# jspsych-webgazer-init-camera +# webgazer-init-camera -This plugin initializes the camera and helps the participant center their face in the camera view for using the the [WebGazer extension](../extensions/jspsych-ext-webgazer). For a narrative description of eye tracking with jsPsych, see the [eye tracking overview](../overview/eye-tracking). +This plugin initializes the camera and helps the participant center their face in the camera view for using the the [WebGazer extension](../extensions/webgazer). For a narrative description of eye tracking with jsPsych, see the [eye tracking overview](../overview/eye-tracking). ## Parameters diff --git a/docs/plugins/webgazer-validate.md b/docs/plugins/webgazer-validate.md index 78ce7328..b84dc590 100644 --- a/docs/plugins/webgazer-validate.md +++ b/docs/plugins/webgazer-validate.md @@ -1,6 +1,6 @@ -# jspsych-webgazer-validate +# webgazer-validate -This plugin can be used to measure the accuracy and precision of gaze predictions made by the [WebGazer extension](../extensions/jspsych-ext-webgazer). For a narrative description of eye tracking with jsPsych, see the [eye tracking overview](../overview/eye-tracking). +This plugin can be used to measure the accuracy and precision of gaze predictions made by the [WebGazer extension](../extensions/webgazer). For a narrative description of eye tracking with jsPsych, see the [eye tracking overview](../overview/eye-tracking). ## Parameters diff --git a/docs/tutorials/hello-world.md b/docs/tutorials/hello-world.md index 56542e30..7f49cf71 100644 --- a/docs/tutorials/hello-world.md +++ b/docs/tutorials/hello-world.md @@ -103,7 +103,7 @@ To initialize jsPsych we use the `initJsPsych()` function and assign the output ### Step 4: Use a plugin to print a message -For this demo we want to show some text on the screen. This is exactly what the [jspsych-html-keyboard-response plugin](../plugins/jspsych-html-keyboard-response.md) is designed to do. To use the plugin, we need to load it with a `