Skip to content

Commit eaed6da

Browse files
authored
Update index.md
1 parent 3cf8331 commit eaed6da

1 file changed

Lines changed: 59 additions & 38 deletions

File tree

  • docs/teacher/reference/response_area_components

docs/teacher/reference/response_area_components/index.md

Lines changed: 59 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Response Area Components
22

3-
These are what the user interacts with on the front-end. They check an input given by the student, and provide feedback. As React components, they admit a certain number of parameters which are described in this section.
3+
Response Areas are the interactive elements your students will use to submit their answers. They check an input given by the student, and provide feedback. As React components, they admit a certain number of parameters which are described in this section.
44

55
![Screenshot](screenshots/Responsearea.png)
66

@@ -10,78 +10,99 @@ Response areas are added to the question field, and are configured for each ques
1010

1111
### Add Response Area
1212

13-
The user can add any number of response areas to a question part. These may be separated by text fields. If desired, adding a double space in the field will space out response areas.
13+
You can add any number of response areas to a question part. These may be separated by text fields. If desired, adding a double space in the field will space out response areas.
1414

1515
### Duplicate
1616

17-
The user can duplicate the response area within the same part using the duplicate icon. When a response area is duplicated, data entered in the teacher edit mode is copied (such as input type, evaluation function, input symbols, pre and post text, answer, tests, cases, ...). Data entered in the teacher preview mode (such as comments) and student mode (comments, flags, likes, student solutions, ...) is not copied.
17+
You can duplicate the response area within the same part by clicking on the duplicate icon.
1818

19-
### Reorder
19+
* **What gets copied:** All teacher-configured settings are duplicated. This includes the input type, evaluation function, pre/post text, the correct answer, tests, and any feedback cases you've set up.
20+
* **What is NOT copied:** Any data generated during use is not carried over. This includes comments, flags, likes, and student submissions.
2021

21-
It is possible to reorder response areas within the part using the "drag and drop" feature. It works in the same way a reordering of parts:
22+
### Reorder
2223

23-
Move your mouse cursor over the response are you want to move. Then, press and hold down the left mouse button, move the object to the location you desire, and release the mouse button to set it down.
24+
It is possible to reorder response areas within the part using the "drag and drop" feature. It works in the same way as reordering of parts.
2425

2526
### Delete Response Area
2627

27-
The user can delete a response area without any restrictions. A popup message appears to confirm the deletion.
28+
You can delete a response area without any restrictions. A pop-up message appears to confirm the deletion.
2829

29-
However, it is important to remember that there might be submissions against the response area you are trying to delete. If this is the case, the popup message will contain the relevant information.
30+
If students have already submitted answers to the response area you are deleting, the confirmation message will warn you.
3031

31-
See more information about analytics against deleted response areas in [Analytics](../../guides/analytics)
32+
See more information about analytics for deleted response areas in [Analytics](../../guides/analytics)
3233

3334
## Response Area configuration
3435

35-
The user can configure a response area using the configure button:
36+
To configure a response area, click the configure button:
3637
![conifgure button](../images/configure.png)
37-
which opens the 'Response Area Panel'. The panel follows a workflow designed around the way a teacher thinks:
3838

39-
- Input
40-
- Evaluation
41-
- Feedback
42-
- Tests
39+
This opens the **Response Area Panel**, separated into four tabs:
4340

44-
Each stage is in a separate tab. Teachers are recommended to be mindful of this process when creating a response area.
41+
1. **Input:** Define what the student sees and how they answer.
42+
2. **Evaluate:** Set up the logic for how the answer is checked.
43+
3. **Feedback:** Create customised feedback for different correct or incorrect answers.
44+
4. **Test:** Define correct and incorrect answers to test your configuration to ensure it works as expected.
4545

46-
### Input
46+
### 1. Input
4747
![Screenshot](screenshots/Inputfield.png)
4848

4949
- Select an input style for the student by scrolling or filtering. These consist of the following:
5050
- Matrix
5151
- Number
52-
- Boolean (True/false)
53-
- Text (Suitable for short text answers)
52+
- Boolean (true/false)
53+
- Text (for short text answers)
5454
- Table
5555
- Multiple-choice
56-
- Expression (Gives a preview for the typed symbolic expression)
57-
- Numeric units (Two fields, allowing for units to be assessed)
56+
- Expression (gives a preview for the typed symbolic expression)
57+
- Numeric units (separate fields for a number and its units)
5858
- Code
59-
- Essay (Suitable for long text answers)
59+
- Essay (for long text answers)
60+
- Milkdown
6061

61-
- Each field has suitable evaluation functions. For example, a simple numerical answer is best suited to number, as this supports isSimilar, while assessing an equation is best suited to the expression foeld, as this supports compareExpressions.
62+
Each field has suitable evaluation functions. For example, a simple numerical answer is best suited to 'Number', as this supports isSimilar, while assessing an equation is best suited to the 'Expression' field, as this supports compareExpressions.
6263

63-
- Each input field may be configured with a series of options:
64+
In short, choose the most suitable input style for your desired answer.
6465

65-
- Enable live preview. Default TRUE for the EXPRESSION input type, to validate student input before submitting for feedback.
66-
- Display input symbols. Default FALSE. When TRUE, the symbols and associated shortcut codes that may be required for a problem are displayed beneath the input field. These are configured in the 'Evaluate' tab.
67-
- Include in PDF. Default FALSE except for MCQ. Only affects the PDF version. Includes pre/post response text in the PDF, with a blank space between.
68-
- Pre/post response text (optional). To clarify to students what to input in the response area. Accepts plain text, including single-dollar-delimited latex. E.g. `Estimate $f(x)=$` is acceptable. When using fractions in this field, use `$\dfrac{}{}$` as this is more legible.
69-
- Answer. Enter a reference answer. This will typically be the absolute solution to a problem. When requesting a symbolic answer, it must be given in terms of the chosen symbol shortcuts. Configure the answer where relevant (e.g. number of rows and columns).
70-
- Response Area Preview: for teachers to verify the configuration
66+
- **Configuration Options**
67+
68+
- **Enable live preview**: Renders the typed expression in realtime. Allows to validate student input before submitting. `Default: TRUE` for the EXPRESSION input type.
69+
- **Display input symbols**: Displays the symbols and associated shortcut codes that may be required for a problem beneath the input field. These are configured in the 'Evaluate' tab. `Default: FALSE`.
70+
- **Include in PDF**: Only affects the PDF version. Includes pre/post response text in the PDF, with a blank space between. `Default: FALSE` except for Multiple-choice.
71+
- **Pre/post response text** (optional): Add text before and after the response area to clarify to students what to input. Accepts plain text, and single-dollar-delimited latex. E.g. `Estimate $f(x)=$` is acceptable. When using fractions in this field, use `$\dfrac{}{}$` as this is more legible.
72+
- **Response Area Answer**: Enter a reference answer. This will typically be the absolute solution to a problem. When requesting a symbolic answer, you must use the variable names (codes) you define in the 'Evaluate' tab. Configure the answer where relevant (e.g. number of rows and columns).
73+
- **Response Area Preview**: Shows you what the configured response area will look like.
7174

72-
- EVALUATE: configure how student expressions are evaluated. This is a 'no code' parametric configuration. Settings will be upgraded as the system improves.
75+
### 2. EVALUATE
76+
77+
Configure how student expressions are evaluated.
7378

74-
- [Evaluation Function](https://lambda-feedback.github.io/user-documentation/teacher/reference/evaluation_functions/) - select an evaluation function from the list. For example:
75-
- isSimilar will perform a basic numerical comparison between the reference answer and student input, with a configurable level of absolute and relative uncertainty.
76-
- compareExpressions is typically used where a symbolic answer is requested.
77-
- Parameters - configure as provided, and add new parameters as required. Details depend on the Evaluation Function.
78-
- Input symbols - define a dictionary of symbols and their equivalent in code form. This essentially associates a LaTeX-rendered symbol with a machine-readable variable label, with the LaTeX render returned to the student through the preview. These symbols may also be hiddent to students. All inputs are plain text. For example, the symbol `$f(x)$` may have code `fx` and alternatives `f_x`, `f(x)`, `f`. This dictionary will be provided to the evaluation function, even if the teacher has not displayed it to the student. This allow teachers to accept several alternative symbols, such as those with different cases or conventional expressions. The configuration of input symbols is a very important part of providing high quality feedback. Note that the 'visibility' Boolean applies if input symbols are displayed to students, otherwise it is irrelevant. It allows Teachers to communicate some symbols to students, while keeping others hidden to the student but visible to the evaluation function.
79+
This is a 'no code' parametric configuration. Settings will be upgraded as the system improves.
7980

80-
- FEEDBACK: add 'cases'. Each case is an alternative reference answer, with customised parameters, so that multiple cases can be dealt with independently. Cases can be used to capture multiple correct approaches that are not equivalent. Cases can also be used to identify common incorrect approaches and to provide customised feedback. The FEEDBACK tab is typically populated after students start using the system, and when data is available to point to common expressions. Configuring a case works similarly to setting up the default answer in the INPUT tab, with added options for changing the colour of the given feedback, give custom feedback and toggling whether the case answer should be considered correct or not. Adding custom feedback will overwrite the feedback produced by the evaluation function. When a response is submitted, it is evaluated for all cases and feedback for the first case that matches will be displayed. When determining which matched case is first, the default answer described in the INPUT tab will take precedence over all other cases, otherwise the feedback for the matched case with the lowest number will be displayed (i.e. the answer given in the INPUT tab can be considered to be Case 0). <br> Feedback fields also support LaTeX equations in both `$f(x)$` and `$$f(x)$$` formats, and Markdown inputs such as line breaks. Make sure to follow good typesetting practice in this field.
81+
- **[Evaluation Function](https://lambda-feedback.github.io/user-documentation/teacher/reference/evaluation_functions/)** - Select an evaluation function from the list. For example:
82+
- `isSimilar`: Best for numerical answers. It performs a basic comparison, allowing for a configurable tolerance (absolute and relative).
83+
- `compareExpressions`: Best for symbolic answers (e.g., equations).
84+
- **Evaluation Function Parameters** - Configure as provided, and add new parameters as required. Details depend on the selected Evaluation Function.
85+
- **Input Symbols:** This is a powerful feature for defining a dictionary of accepted symbols. For each symbol, you define:
86+
* **Symbol:** The LaTeX-rendered symbol (e.g., `$f(x)$`).
87+
* **Code:** The machine-readable variable name (e.g., `fx`). This is what you use in your reference answer and what the evaluation function sees.
88+
* **Alternatives:** A list of other codes you want to accept for the same symbol (e.g., `f_x`, `f(x)`, `f`). This allows you to anticipate different ways students might type the same thing.
89+
* **Visibility:** A `TRUE`/`FALSE` toggle. If "Display input symbols" is enabled in the Input tab, this setting determines whether a specific symbol is shown to the student. This allows you to show students common symbols while still accepting less common or alternative ones in the background.
90+
91+
- **Input Symbols** - Define a dictionary of symbols and their equivalent in code form.
92+
- This essentially associates a LaTeX-rendered symbol with a machine-readable variable label, with the LaTeX render returned to the student through the preview. These symbols may also be hidden to students.
93+
- All inputs are plain text. For example, the symbol `$f(x)$` may have code `fx` and alternatives `f_x`, `f(x)`, `f`. This dictionary will be provided to the evaluation function, even if the teacher has not displayed it to the student. This allow teachers to accept several alternative symbols, such as those with different cases or conventional expressions.
94+
- The configuration of input symbols is a very important part of providing high quality feedback.
95+
- Note that the 'visibility' Boolean applies if input symbols are displayed to students, otherwise it is irrelevant. It allows Teachers to communicate some symbols to students, while keeping others hidden to the student but visible to the evaluation function.
96+
97+
### 3. FEEDBACK
98+
99+
Add alternative reference answers, 'cases', with customised parameters, so that multiple cases can be dealt with independently. Cases can be used to capture multiple correct approaches that are not equivalent. Cases can also be used to identify common incorrect approaches and to provide customised feedback. The FEEDBACK tab is typically populated after students start using the system, and when data is available to point to common expressions. Configuring a case works similarly to setting up the default answer in the INPUT tab, with added options for changing the colour of the given feedback, give custom feedback and toggling whether the case answer should be considered correct or not. Adding custom feedback will overwrite the feedback produced by the evaluation function. When a response is submitted, it is evaluated for all cases and feedback for the first case that matches will be displayed. When determining which matched case is first, the default answer described in the INPUT tab will take precedence over all other cases, otherwise the feedback for the matched case with the lowest number will be displayed (i.e. the answer given in the INPUT tab can be considered to be Case 0). <br> Feedback fields also support LaTeX equations in both `$f(x)$` and `$$f(x)$$` formats, and Markdown inputs such as line breaks. Make sure to follow good typesetting practice in this field.
81100

82101
![Screenshot](screenshots/Feedback.gif)
83102

84-
- TESTS: tests provide a systematic way to log what behaviour the teacher expects. It provides a useful record and an efficient way to retest the bevhaiour of a response area over time (e.g. as evaluation functions evolve, or as the subject matter itself changes).
103+
### 4. TEST
104+
105+
tests provide a systematic way to log what behaviour the teacher expects. It provides a useful record and an efficient way to retest the bevhaiour of a response area over time (e.g. as evaluation functions evolve, or as the subject matter itself changes).
85106

86107
## Restrictions on changes: the input type
87108

0 commit comments

Comments
 (0)