Skip to content

Commit 0ce7d46

Browse files
Kevin-MMbmcutler
authored andcommitted
Added documentation for 'notebook' support in config.json files. (#84)
* Added documentation for 'notebook' support in config.json files. Also added a few links to anchor points within the page for easier navigation. * Updated page to include information about 'starter_value_string'. * Added in documentation for the 'alt' field to be used in image object configuration. * Removed a note that was in the wrong spot.
1 parent 102c3ca commit 0ce7d46

File tree

1 file changed

+86
-45
lines changed

1 file changed

+86
-45
lines changed

_docs/instructor/assignment_configuration.md

Lines changed: 86 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,11 @@ executables.
198198

199199

200200
* **field:** ``"testcases"``
201-
**type:** _array of testcase objects_ (defined below)
201+
**type:** _array of testcase objects_ ([defined below](#specification-of-a-testcase))
202202
**REQUIRED**
203+
204+
* **field:** ``"notebook"``
205+
**type:** _array of notebook objects_ ([defined below](#specification-of-a-notebook))
203206

204207

205208
* **field:** ``"assignment_message"``
@@ -335,6 +338,88 @@ executables.
335338
* **field:** ``"textboxes"``
336339
**type:** _array of textbox objects_ (Described below)
337340
**default value:** ``empty``
341+
342+
343+
### Specification of a Notebook
344+
345+
346+
* **field:** ``"title"``
347+
**type:** _string_
348+
**value:** Title of the item (ex. Question 1)
349+
350+
* **field:** ``"description"``
351+
**type:** _string_
352+
353+
* **field:** ``"images"``
354+
**type:** _array of image objects_
355+
356+
* **field:** ``"input"``
357+
**type:** _array of input objects_
358+
359+
360+
### Specification of an Image Object
361+
362+
363+
* **field:** ``"image_name"``
364+
**type:** _string_
365+
**value:** Name of the image file to be displayed.
366+
**default value:** ``""``
367+
368+
* **field:** ``"alt"``
369+
**type:** _string_
370+
**value:** Specify alternate text that describes the image, for use with accessibility screen readers.
371+
372+
* **field:** ``"image_height"``
373+
**type:** _int_
374+
**value:** Numeric height in pixels to display the image at.
375+
**default value:** ``0`` _(displays at native image height)_
376+
377+
378+
* **field:** ``"image_width"``
379+
**type:** _int_
380+
**value:** Numeric width in pixels to display the image at.
381+
**default value:** ``0`` _(displays at native image width)_
382+
383+
384+
### Specification of Notebook Input Objects
385+
386+
387+
* **field:** ``"type"``
388+
**type:** _string_
389+
**value:** ``"short_answer"``, ``"codebox"``, or ``"multiplechoice"``
390+
**description:** Specifies the type of input to display
391+
392+
393+
### Specification of a Short Answer box (short_answer)
394+
395+
396+
* **field:** ``"label"``
397+
**type:** _string_
398+
**value:** String description of what to write in the short answer box.
399+
**default value:** ``""``
400+
401+
402+
* **field:** ``"starter_value_string"``
403+
**type:** _string_
404+
**value:** The text to be prepopulated into the input box
405+
406+
407+
* **field:** ``"rows"``
408+
**type:** _int_
409+
**value:** Numeric height of the textbox in rows.
410+
**default value:** ``1``
411+
412+
413+
* **field:** ``"filename"``
414+
**type:** _string_
415+
**value:** Specify a filename that the captured input data will be written to
416+
417+
418+
* **field:** ``"images"``
419+
**type:** _array of image objects_
420+
**value:** list of the images to be displayed.
421+
**default value:** ``empty``
422+
338423

339424

340425
### Specification of a Networked Gradeable
@@ -675,51 +760,7 @@ Moves the mouse to the origin (upper left) of the student’s window.
675760
```
676761

677762

678-
### Specification of a Textbox
679-
680-
681-
* **field:** ``"label"``
682-
**type:** _string_
683-
**value:** String description of what to write in the textbox.
684-
**default value:** ``""``
685-
686-
687-
* **field:** ``"rows"``
688-
**type:** _int_
689-
**value:** Numeric height of the textbox in rows.
690-
**default value:** ``1``
691-
692-
693-
* **field:** ``"filename"``
694-
**type:** _string_
695-
**value:** String name of the text file generated by submission of the textbox. (ex. input1.txt)
696-
**default value:** ``""``
697-
698-
699-
* **field:** ``"images"``
700-
**type:** _array of image objects_ (Described below)
701-
**value:** list of the images to be displayed.
702-
**default value:** ``empty``
703-
704-
#### Specification of an Image Object
705-
706-
707-
* **field:** ``"image_name"``
708-
**type:** _string_
709-
**value:** Name of the image file to be displayed.
710-
**default value:** ``""``
711-
712-
713-
* **field:** ``"image_height"``
714-
**type:** _int_
715-
**value:** Numeric height in pixels to display the image at.
716-
**default value:** ``0`` _(displays at native image height)_
717-
718763

719-
* **field:** ``"image_width"``
720-
**type:** _int_
721-
**value:** Numeric width in pixels to display the image at.
722-
**default value:** ``0`` _(displays at native image width)_
723764

724765

725766
### Specification of a Validation Object

0 commit comments

Comments
 (0)