minor docs edits

This commit is contained in:
Becky Gilbert 2022-09-29 16:23:02 -07:00
parent d7aba607fb
commit 60fb5b73f6
2 changed files with 2 additions and 2 deletions

View File

@ -15,7 +15,7 @@ In addition to the [parameters available in all plugins](../overview/plugins.md#
| key_backward | string | 'ArrowLeft' | This is the key that the participant can press to return to the previous page. This key should be specified as a string (e.g., `'a'`, `'ArrowLeft'`, `' '`, `'Enter'`). | | key_backward | string | 'ArrowLeft' | This is the key that the participant can press to return to the previous page. This key should be specified as a string (e.g., `'a'`, `'ArrowLeft'`, `' '`, `'Enter'`). |
| allow_backward | boolean | true | If true, the participant can return to previous pages of the instructions. If false, they may only advace to the next page. | | allow_backward | boolean | true | If true, the participant can return to previous pages of the instructions. If false, they may only advace to the next page. |
| allow_keys | boolean | true | If `true`, the participant can use keyboard keys to navigate the pages. If `false`, they may not. | | allow_keys | boolean | true | If `true`, the participant can use keyboard keys to navigate the pages. If `false`, they may not. |
| show_clickable_nav | boolean | false | If true, then a `Previous` and `Next` button will be displayed beneath the instructions. participants can click the buttons to navigate. | | show_clickable_nav | boolean | false | If true, then a `Previous` and `Next` button will be displayed beneath the instructions. Participants can click the buttons to navigate. |
| button_label_previous | string | 'Previous' | The text that appears on the button to go backwards. | | button_label_previous | string | 'Previous' | The text that appears on the button to go backwards. |
| button_label_next | string | 'Next' | The text that appears on the button to go forwards. | | button_label_next | string | 'Next' | The text that appears on the button to go forwards. |
| show_page_number | boolean | false | If true, and clickable navigation is enabled, then Page x/y will be shown between the nav buttons. | | show_page_number | boolean | false | If true, and clickable navigation is enabled, then Page x/y will be shown between the nav buttons. |

View File

@ -22,7 +22,7 @@ Plugin | Description
[categorize‑image](categorize-image.md) | The participant responds to an image using the keyboard and can be given feedback about the correctness of their response. [categorize‑image](categorize-image.md) | The participant 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. [cloze](cloze) | Plugin for displaying a cloze test and checking participants answers against a correct solution.
[external‑html](external-html.md) | Displays an external HTML page (such as a consent form) and lets the participant respond by clicking a button or pressing a key. Plugin can validate their response, which is useful for making sure that a participant has granted consent before starting the experiment. [external‑html](external-html.md) | Displays an external HTML page (such as a consent form) and lets the participant respond by clicking a button or pressing a key. Plugin can validate their response, which is useful for making sure that a participant has granted consent before starting the experiment.
[free‑sort](free-sort.md) | Displays a set of images on the screen in random locations. participants can click and drag the images to move them around the screen. Records all the moves made by the participant, so the sequence of moves can be recovered from the data. [free‑sort](free-sort.md) | Displays a set of images on the screen in random locations. Participants can click and drag the images to move them around the screen. Records all the moves made by the participant, so the sequence of moves can be recovered from the data.
[fullscreen](fullscreen.md) | Toggles the experiment in and out of fullscreen mode. [fullscreen](fullscreen.md) | Toggles the experiment in and out of fullscreen mode.
[html‑audio‑response](html-audio-response.md) | Display an HTML-formatted stimulus and records an audio response via a microphone. [html‑audio‑response](html-audio-response.md) | Display an HTML-formatted stimulus and records an audio response via a microphone.
[html‑button‑response](html-button-response.md) | Display an HTML-formatted stimulus and allow the participant to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons. [html‑button‑response](html-button-response.md) | Display an HTML-formatted stimulus and allow the participant to respond by choosing a button to click. The button can be customized extensively, e.g., using images in place of standard buttons.