tb-micro-parsons¶

The tb-micro-parsons directive creates a token-level Parsons problem. Authors write tokens in the correct order. HTML shuffles the tokens and lets students move tokens from a source row into an answer row before checking the answer.

Synopsis¶

The general format of the tb-micro-parsons directive is:

.. tb-micro-parsons::
   :optional parameter: value

   + --- Optional prompt area ---
   |
   | question text and optional Sphinx content
   |
   + --- Token list in correct order ---

   - first-token
   - second-token
   - third-token

Options¶

class: String or List. Optional. A CSS class to add to the directive. See Common options for details.
name: String. Optional. Sphinx reference name for this micro-Parsons problem. See Common options for details.
distractor: String. Optional. Additional tokens that do not belong in the final answer. Tokens can be separated with semicolons or written one per continuation line.

Accessibility behavior¶

HTML renders each token as a native button. Activating a token in the source row moves it to the end of the answer row. Activating a token in the answer row moves it back to the source row. Keyboard focus remains on the token after it moves. Result text uses a status region so assistive technology can announce feedback after checking.

Distractors are omitted by leaving them in the source row.

Fallback behavior¶

HTML without JavaScript renders the prompt, a deterministic token order, and an empty answer row. Text builders render the prompt, shuffled tokens, and a blank answer line. PDF-oriented builders render the shuffled tokens in a literal block with a blank answer line. Static output does not support interactive checking.

Examples¶

Example 1: Assignment statement¶

Source

.. tb-micro-parsons::

   Arrange the tokens to create a valid assignment statement.

   - int
   - x
   - =
   - 42
   - ;

Rendered

Arrange the tokens to create a valid assignment statement.

Tokens

Answer

Example 2: Distractor tokens¶

Source

.. tb-micro-parsons::
   :distractor: float; ==

   Arrange the tokens to create a valid assignment statement.

   - int
   - x
   - =
   - 42
   - ;

Rendered

Arrange the tokens to create a valid assignment statement.

Tokens

Answer

Example 3: SQL clause¶

Source

.. tb-micro-parsons::
   :distractor:
      ORDER
      GROUP

   Arrange the tokens to create a SQL ``WHERE`` condition.

   - WHERE
   - score
   - >=
   - 90

Rendered

Arrange the tokens to create a SQL WHERE condition.

Tokens

Answer