Skip to content

Commit 4551c4b

Browse files
authored
Fixed to general errors and added links to relevant pages
* Update Text.md * Update NumericUnits.md added guide for evaluation function parameters * Add files via upload * Update NumericUnits.md * Update Expression.md added guide to input symbols * Add files via upload * Update NumericUnits.md * Update Expression.md * Update gettingstarted.md added links to branching and creating steps for worked solutions * Update getting_started_student.md * Update content-sets-questions.md
1 parent 042e617 commit 4551c4b

9 files changed

Lines changed: 51 additions & 14 deletions

File tree

docs/student/getting_started_student.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ See the [Answering Questions](answering_questions.md) page for more help with an
3737

3838
The Workspace provides you with various functionalities to assist you during your learning process:
3939
#### 1. Canvas:
40-
A pane where you can write down your thought process and notes for the previewed question (handwriting, sticky notes & text).
40+
A pane where you can write down your thought process and notes for the previewed question (handwriting, sticky notes & text).
4141

42-
![Canvas Interface](images/canvas_interface.png)
42+
![Canvas Interface](images/canvas_interface.png)
4343

4444
#### 2. Chat:
45-
A chat interface connecting you with helpful AI Chatbots to discuss any questions you have on the current topic you are working on.
45+
A chat interface connecting you with helpful AI Chatbots to discuss any questions you have on the current topic you are working on.
4646

47-
![Chat Interface](images/chat_interface.png)
47+
![Chat Interface](images/chat_interface.png)
4848

49-
Your edits and progress in the Workspace are saved per each Question you preview. So, you will be able to view your old edits for the Question you are currently on.
49+
Your edits and progress in the Workspace are saved per each Question you preview. So, you will be able to view your old edits for the Question you are currently on.

docs/teacher/guides/content-sets-questions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This guide explains how to use the editor to create and modify [sets](https://la
1616
| **4** | **Master Content** | The main content for the question, which is always visible above the individual parts. This field uses the Lexdown editor. |
1717
| **5** | **Current Part** | **Indicates** which question part you are currently editing. |
1818
| **6** | **Part Content** | Edit the content for the selected question part (i.e., the sub-question).|
19-
| **7** | **Response Area** | The input field where a student submits their answer. Adding a response area is optional. <br> See [here](https://lambda-feedback.github.io/user-documentation/teacher/reference/response_area_components/) for an in-depth explanation.|
19+
| **7** | **Response Area** | The input field where a student submits their answer. Adding a response area is optional. <br> See [**here**](https://lambda-feedback.github.io/user-documentation/teacher/reference/response_area_components/) for an in-depth explanation.|
2020
| **8** | **Question Help Options** | Add optional support materials for students, such as a [**Structured Tutorial**](https://lambda-feedback.github.io/user-documentation/terminology#structured-tutorial), a [**Final Answer**](https://lambda-feedback.github.io/user-documentation/terminology#final-answer), or [**Worked Solutions**](https://lambda-feedback.github.io/user-documentation/terminology#worked-solution). The buttons shown here are the same ones students will see. |
2121
| **9** | **Teacher/Student View Toggle** | Toggle between the teacher editing view ('EDIT') and the student 'PREVIEW' to see how the question will appear to students. |
2222
| **10** | **Edit Guidance** | Add extra details for the question, such as guidance notes, estimated completion time, and skill level. |

docs/teacher/guides/gettingstarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ A [student guide is here](../../student/index.md). Teachers use the 'below the l
4848
- **Final answer** is self-explanatory.
4949
- **Worked solutions** provides detailed, step-by-step solutions.
5050

51-
All content below the line uses Lexdown functionality. Worked solutions can be branched. Future developments will add branching and response areas to structured tutorials.
51+
All content below the line uses Lexdown functionality. Worked solutions can be [branched](https://lambda-feedback.github.io/user-documentation/teacher/guides/good-practice/#branching), or split into [steps](https://lambda-feedback.github.io/user-documentation/teacher/guides/lexdown/#steps-in-worked-solutions). Future developments will add branching and response areas to structured tutorials.
5252

5353
It is not necessary to include all three methods of help. If you only provide content for one tab, only that button will appear in the published student version.
5454

docs/teacher/reference/response_area_components/Expression.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ Calculates the difference between the teacher answer (ans) and the student respo
1212

1313
Compares two symbolic expressions for mathematical equivalence, using SymPy. See [SymPy](https://www.sympy.org/en/index.html.md-button) for further information.
1414

15+
## compareExpressions
16+
**Input Symbols**
17+
18+
This is a powerful feature for defining a dictionary of accepted symbols. For each symbol, you define:
19+
* **Symbol:** The LaTeX-rendered symbol (e.g., `$f(x)$`).
20+
* **Code:** The machine-readable variable name (e.g., `fx`). This is what your students will type and what the evaluation function sees.
21+
* **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.
22+
* **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.
23+
24+
![example](screenshots/input_symbols.png)
25+
![example](screenshots/input_symbols_preview.png)
26+
27+
Tolerances can also be added. These will apply to the numerical parts of the answer (e.g. the $10$ in $10x$).
28+
29+
This is done using the `atol` and `rtol` fields under the Evaluation Function Parameters section.
30+
1531
## Component Parameters
1632

1733
### `post_response_text` (optional)
@@ -22,11 +38,11 @@ Text block to be displayed to the left of the input field. Markdown and LaTeX ar
2238

2339
Text block to be displayed to the left of the input field. Markdown and LaTeX are allowed following the usual syntax.
2440

25-
### Allow Handwrite (Experimental)
41+
### Enable Handwriting Input
2642

27-
Enables a handwriting canvas in the browser, which allows a student can use to draw their expression, rather than type using Sympy's syntax.
43+
Enables a handwriting canvas in the browser, which allows a student to draw their expression, rather than type using Sympy's syntax.
2844

29-
### Photo (Experimental)
45+
### Enable Photo Upload
3046

3147
Allows a student to upload their expression as an image, as an alternative to handwriting if the student isn't using a phone or tablet.
3248

docs/teacher/reference/response_area_components/NumericUnits.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,41 @@
22

33
Provides two input fields with `Number` and `Units` placeholder texts. This area will also display its associated grading function (as seen in the screenshot below).
44

5-
**Note** this area will display how the user's response was interpred using the `interp_string` field provided in the feedback object returned by that function (if it exists).
5+
**Note:** this area will display how the user's response was interpred using the `interp_string` field provided in the feedback object returned by that function (if it exists).
66

77
## Component Parameters
8-
### `pre_response_text` (optional)
9-
Text block to be displayed to the left of the input field. Markdown and LaTeX are allowed following the usual syntax.
8+
### `pre_response_text` & `post_response_text` (optional)
9+
Text block to be displayed to the left and right of the input field respectively. Markdown and LaTeX are allowed following the usual syntax.
10+
11+
### Comparing units
12+
This is done using the **compareExpressions** evaluation function.
13+
14+
By ticking the `physical_quantity (boolean)` option in the *Evaluate* tab, answers with different units from the reference answer can be compared.
15+
16+
![physical quantity ticked](screenshots/physical_quantity.png)
17+
18+
For example, if the reference answer is 100 m, the following answers will also be accepted:
19+
20+
* 0.1 km
21+
* 10000 cm
22+
* 10^5 mm
23+
24+
See [here](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/compareExpressions/#4-checking-the-value-of-an-expression-or-a-physical-quantity) for more information
25+
### Tolerances
26+
This is done using the **compareExpressions** evaluation function.
27+
28+
Tolerances can be added to your answer using the `atol (number)` and `rtol (number)` fields, which denote absolute and relative tolerances respectively.
1029

1130
## Response Structure
1231
*This is how the react component will structure the user's input to the Grading Gateway, when they press the check button.*
1332

1433
In this case, the response is a single string which features the user's response to both fields separated by a space.
34+
1535
!!! example
1636

1737
```json
1838
"response": "150 g"
1939
```
2040

2141
## Example Screenshot
22-
![Screenshot](screenshots/NumericUnits.jpg)
42+
![Screenshot](screenshots/NumericUnits.jpg)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Text
32.5 KB
Loading
17 KB
Loading
17.8 KB
Loading

0 commit comments

Comments
 (0)