** This feature is in beta and subject to change without notice **

You may encode one or more single- and multiple-choice questions (and answers) in the README.md file. Upon processing, Vocareum will automatically grade student submissions.

Please see this document for steps to release the README.md file.

Single-Choice Questions

In a single-choice question, there is only one correct answer. All other answers are distractors. The format for a Vocareum single-choice question is as follows:

@@ <max-score> <rubric-string>

<question text in markdown format>

[( )] <option>
[(x)] <option>
...
[( )] <option>

Where:

  • <max-score> is the value for the question
  • <rubric-string> is the unique name for the question (rubric)
  • <option> is one of several answer options for the question
  • [( )] indicates an incorrect option
  • [(x)] indicates the (one) correct option

Example 1

@@ 1 book analogy

A **book** is to **reading** as a **fork** is to:

[( )] drawing
[( )] writing
[( )] stirring
[(x)] eating

In this example, the rubric "book analogy" will have a max score of 1 and the fourth choice "eating" is the correct answer.

Here is the rendered result:

Multiple-Choice Questions

In a multiple-choice question, there may be one or more correct answers. All other answers are distractors. The format for a Vocareum multiple-choice question is as follows:

@@ <max-score> <rubric-string>

<question text in markdown format>

[[ ]] <option>
[[x]] <option>
[[x]] <option>
...
[[ ]] <option>

Where:

  • <max-score> is the value for the question
  • <rubric-string> is the unique name for the question (rubric)
  • <option> is one of several answer options for the question
  • [[ ]] indicates an incorrect option
  • [[x]] indicates the (one) correct option

Example 2

@@ 4 word game

Which of the following can be arranged into a 5-letter English word? (select two)

[[ ]] H R G S T
[[x]] R I L S A
[[x]] T O O M T
[[ ]] W Q R G S
[[ ]] Y R R 7 Q

In this example, the rubric "word game" will have a max score of 4 and both the 2nd and 3rd choices must be selected to receive the score.

Here is the rendered result:

NOTES:

  • There is limited error checking of the format at this time.
  • Please see this document for steps to release the README.md file.

Did this answer your question?