You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/teacher/guides/good-practice.md
+23-17Lines changed: 23 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Formatting & style for readability
4
4
5
-
### Use romanised text for operators and units
5
+
### Romanised text for operators and units
6
6
7
7
Use romanised operators and scientific units to distinguish them from variables, which are italicised.
8
8
@@ -20,7 +20,7 @@ Put appropriate space between a number and its unit, such as `5 m` or `3 kg`, ac
20
20
21
21
e.g. `$5 \text{ m}$` to get $5 \text{ m}$
22
22
23
-
### Use empty lines
23
+
### Empty lines
24
24
25
25
Using empty lines can improve the readability and neatness of your content.
26
26
@@ -36,36 +36,40 @@ Saving and publishing work regularly is recommended to prevent accidental data l
36
36
37
37
### Add tests to response areas
38
38
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
+
39
41
In a response area, press `Configure` then `Test`.
40
42
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
42
44
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.
44
46
45
47
Pre-response area text is found under `Configure` - `Input` in the evaluation function.
46
48
47
49
You can use LaTeX in the pre-response area text.
48
50
49
51

50
52
51
-
### Use live preview and permit all types of input
52
-
53
-
Live preview is found under `Configure` - `Input` - `Display settings`.
53
+
### Live preview
54
54
55
55
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.
56
56
57
+
Live preview is found under `Configure` - `Input` - `Display settings`.
58
+
57
59

58
60
59
-
### Use branching when relevant
61
+
### Branching
60
62
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:
62
66
63
67
- When a question can be solved via multiple different methods, branching can be used for each method.
64
68
- When a question has multiple parts, where each part involves substitution of different values, branching can be used for each part.
65
69
66
70

67
71
68
-
### Use audio clips
72
+
### Audio clips
69
73
70
74
Just drag + drop an audio file into the editor.
71
75
@@ -77,7 +81,7 @@ When defining the `code` of an input symbol in the response areas, the system ca
77
81
78
82
## Latex help
79
83
80
-
### Use `\dfrac` for bigger fractions when needed.
84
+
### Use `\dfrac` for bigger fractions
81
85
82
86
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}$`:
83
87
@@ -87,15 +91,15 @@ $\frac{3}{4} \quad$ (frac)
87
91
88
92
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.
89
93
90
-
### Use `\small`when smaller fonts or fractions are needed
94
+
### Use `\small`for a smaller font
91
95
92
96
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}$`.
93
97
94
98
$\small{\frac{1}{2}} \quad$ (small)
95
99
96
100
$\frac{1}{2}$
97
101
98
-
### Use `\begin{array}` to generate a compact table i.e.
102
+
### Use `\begin{array}` to generate a compact table
99
103
100
104
```latex
101
105
\begin{array}{|c|c|}
@@ -109,7 +113,7 @@ $\frac{1}{2}$
109
113
\end{array}
110
114
```
111
115
112
-

116
+

113
117
114
118
### Use `\begin{aligned}` to keep your working formatted nicely
115
119
@@ -121,17 +125,19 @@ $\frac{1}{2}$
121
125
\end{aligned}
122
126
```
123
127
124
-

128
+

125
129
126
130
### Use `\left` and `\right` for equations with multiple brackets
127
131
132
+
This sizes the brackets correctly to the height of the equation.
0 commit comments