Skip to content

Commit 6c2a176

Browse files
authored
Update good-practice.md
Shortened headings Removed reference to 'permit all types of input'
1 parent 01f0a66 commit 6c2a176

1 file changed

Lines changed: 23 additions & 17 deletions

File tree

docs/teacher/guides/good-practice.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Formatting & style for readability
44

5-
### Use romanised text for operators and units
5+
### Romanised text for operators and units
66

77
Use romanised operators and scientific units to distinguish them from variables, which are italicised.
88

@@ -20,7 +20,7 @@ Put appropriate space between a number and its unit, such as `5 m` or `3 kg`, ac
2020

2121
e.g. `$5 \text{ m}$` to get $5 \text{ m}$
2222

23-
### Use empty lines
23+
### Empty lines
2424

2525
Using empty lines can improve the readability and neatness of your content.
2626

@@ -36,36 +36,40 @@ Saving and publishing work regularly is recommended to prevent accidental data l
3636

3737
### Add tests to response areas
3838

39+
Tests allow you to enter potential student responses, define whether they are correct or not, then run the evaluation function on those student responses. This allows you to quickly test whether or not the evaluation function works as expected.
40+
3941
In a response area, press `Configure` then `Test`.
4042

41-
Tests allow you to enter potential student responses, define whether they are correct or not, then run the evaluation function on those student responses. This allows you to quickly test whether or not the evaluation function works as expected.
43+
### Pre-response area text
4244

43-
### Use pre-response area text to be clear what should be entered
45+
Use pre-response area text to make clear what students should write.
4446

4547
Pre-response area text is found under `Configure` - `Input` in the evaluation function.
4648

4749
You can use LaTeX in the pre-response area text.
4850

4951
![Image showing a pre-response area](images/pre_response_area.png)
5052

51-
### Use live preview and permit all types of input
52-
53-
Live preview is found under `Configure` - `Input` - `Display settings`.
53+
### Live preview
5454

5555
Live preview instantly renders a student's input. This is very useful for long/complicated equations, as it allows students to ensure their input is correct.
5656

57+
Live preview is found under `Configure` - `Input` - `Display settings`.
58+
5759
![Image showing a live-preview to a student's response](images/live_preview.png)
5860

59-
### Use branching when relevant
61+
### Branching
6062

61-
Branching is a feature for `worked solutions`. It allows you to have different solution pathways Usage examples:
63+
Branching is a feature for `worked solutions`. It allows you to have different solution pathways
64+
65+
Usage examples:
6266

6367
- When a question can be solved via multiple different methods, branching can be used for each method.
6468
- When a question has multiple parts, where each part involves substitution of different values, branching can be used for each part.
6569

6670
![gif showing the branching feature](images/branching.gif)
6771

68-
### Use audio clips
72+
### Audio clips
6973

7074
Just drag + drop an audio file into the editor.
7175

@@ -77,7 +81,7 @@ When defining the `code` of an input symbol in the response areas, the system ca
7781

7882
## Latex help
7983

80-
### Use `\dfrac` for bigger fractions when needed.
84+
### Use `\dfrac` for bigger fractions
8185

8286
Use `$\dfrac{numerator}{denominator}$` for bigger fractions when you need to display them more clearly or emphasize them. For example, `$\dfrac{3}{4}$` will produce a bigger fraction than `$\frac{3}{4}$`:
8387

@@ -87,15 +91,15 @@ $\frac{3}{4} \quad$ (frac)
8791

8892
Alternatively, you can use `$\displaystyle$` at the start of an inline equation to render everything afterwards full-size (as in display maths mode), this is especially helpful for integrals.
8993

90-
### Use `\small` when smaller fonts or fractions are needed
94+
### Use `\small` for a smaller font
9195

9296
Use `$\small{text}$` when you need to display smaller fonts or fractions in your LaTeX expressions. For example, `$\small{\frac{1}{2}}$` will produce a smaller fraction than `$\frac{1}{2}$`.
9397

9498
$\small{\frac{1}{2}} \quad$ (small)
9599

96100
$\frac{1}{2}$
97101

98-
### Use `\begin{array}` to generate a compact table i.e.
102+
### Use `\begin{array}` to generate a compact table
99103

100104
```latex
101105
\begin{array}{|c|c|}
@@ -109,7 +113,7 @@ $\frac{1}{2}$
109113
\end{array}
110114
```
111115

112-
![Image showing a example of a table](images/table.png)
116+
![Image showing a example of a table](images/table.png)
113117

114118
### Use `\begin{aligned}` to keep your working formatted nicely
115119

@@ -121,17 +125,19 @@ $\frac{1}{2}$
121125
\end{aligned}
122126
```
123127

124-
![Image showing a example of a algined working](images/aligned.png)
128+
![Image showing a example of a algined working](images/aligned.png)
125129

126130
### Use `\left` and `\right` for equations with multiple brackets
127131

132+
This sizes the brackets correctly to the height of the equation.
133+
128134
```latex
129135
f(x)=\left (\frac{(\cos (x) -x) + i(\sin (x) - x)}{wi} \right)
130136
```
131137

132-
![Image showing a example of a brackets](images/bracket.png)
138+
![Image showing a example of a brackets](images/bracket.png)
133139

134-
This also works for `[ ]` and `\{ \}`
140+
This also works for `[ ]` and `\{ \}`
135141

136142
### Shortcut for romanised operators
137143

0 commit comments

Comments
 (0)