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
Use romanised operators such as $\sin$, $\frac{\mathrm{d}}{\mathrm{d}x}$ instead of $sin$, $\frac{d}{dx}$, etc.
5
+
### Use romanised text for operators and units
6
6
7
-
## Use empty lines
7
+
Use romanised operators and scientific units to distinguish them from variables, which are italicised.
8
8
9
-
Using empty lines can improve the readability and neatness of your content. Empty lines are often useful before and after an equation, and between paragraphs of text. An empty line in markdown requires _two spaces_ on the line, otherwise the line is ignored.
9
+
***Operators:** Use `\sin`, `\cos`, `\log`, `\det`, etc. For derivatives, use `\mathrm{d}` as in `\dfrac{\mathrm{d}y}{\mathrm{d}x}`.
***Units:** Use `\text{...}` or `\mathrm{...}` (mathrm allows for numbers in the units, i.e. $\mathrm{m^2}$). Ensure the unit's case is correct (e.g., `m` for milli, `M` for mega).
14
+
***Correct:** $5 \text{ m}$, $10 \text{ kN}$
15
+
***Incorrect:** $5 m$, $10 kN$
16
+
17
+
### Space between numbers and units
12
18
13
19
Put appropriate space between a number and its unit, such as `5 m` or `3 kg`, according to the SI conventions.
14
20
15
-
## Romanise units and check their case
21
+
e.g. `$5 \text{ m}$` to get $5 \text{ m}$
16
22
17
-
Use romanised units such as $\text{m}$, $\text{kN}$ instead of $m$, $kN$. Ensure that the case of the unit is correct.
23
+
### Use empty lines
18
24
19
-
## Add tests to response areas
25
+
Using empty lines can improve the readability and neatness of your content.
20
26
21
-
In a response area, press `configure` then `tests`.
27
+
Empty lines are often useful before and after an equation, and between paragraphs of text. An empty line in markdown requires _two spaces_ on the line, otherwise the line is ignored.
22
28
23
-
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.
29
+
Alternatively, adding empty LaTeX text, `\text{}`, can work if all else fails.
24
30
25
-
## Save and publish as you go
31
+
## Using platform features effectively
26
32
27
-
Saving and publishing work regularly is recommended to prevent accidental data loss.
33
+
### Save and publish as you go
28
34
29
-
## Use branching when relevant
35
+
Saving and publishing work regularly is recommended to prevent accidental data loss.
30
36
31
-
Branching is a feature for `worked solutions`. It allows you to have different solution pathways Usage examples:
37
+
### Add tests to response areas
32
38
33
-
- When a question can be solved via multiple different methods, branching can be used for each method.
34
-
- When a question has multiple parts, where each part involves substitution of different values, branching can be used for each part.
39
+
In a response area, press `Configure` then `Test`.
35
40
36
-
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.
37
42
38
-
## Use pre-response area text to be clear what should be entered
43
+
###Use pre-response area text to be clear what should be entered
39
44
40
-
Pre-response area text is found under `configure` - `INPUT` in the evaluation function.
45
+
Pre-response area text is found under `Configure` - `Input` in the evaluation function.
41
46
42
47
You can use LaTeX in the pre-response area text.
43
48
44
49
45
50
46
-
## Use `\dfrac` for bigger fractions when needed.
51
+
###Use live preview and permit all types of input
47
52
48
-
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}$`.
49
-
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.
53
+
Live preview is found under `Configure` - `Input` - `Display settings`.
50
54
51
-
## Use `\small` when smaller fonts or fractions are needed
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.
52
56
53
-
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}$`.
57
+
54
58
55
-
## Use audio clips
59
+
###Use branching when relevant
56
60
57
-
Just drag + drop an audio file into the milkdown editor.
61
+
Branching is a feature for `worked solutions`. It allows you to have different solution pathways Usage examples:
58
62
59
-
## Issue with input symbols
63
+
- When a question can be solved via multiple different methods, branching can be used for each method.
64
+
- When a question has multiple parts, where each part involves substitution of different values, branching can be used for each part.
60
65
61
-
For the `code` of input symbols in the response areas, the system cannot accept brackets (i.e `dot(x)` for $\dot{x}$) and response must be formatted in different ways (i.e `dot_x`).
66
+
62
67
63
-
`a_b` will render as $a_b$ without adding an input symbol, but note that `dot_x` overrides the `_` input (in this example, will render as $\dot{x}$ instead of $dot_x$)
68
+
### Use audio clips
64
69
65
-
## Use live preview and permit all types of input
70
+
Just drag + drop an audio file into the editor.
66
71
67
-
Live preview and input types are found in an evaluation function under `configure` - `INPUT`.
72
+
### Issue with input symbols
68
73
69
-
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.
74
+
When defining the `code` of an input symbol in the response areas, the system cannot accept brackets (i.e using `dot(x)`for $\dot{x}$). The response must be formatted in a different way (i.e `dot_x`).
70
75
71
-
76
+
`a_b` will render as $a_b$ without adding an input symbol, but note that `dot_x` will override the `_` input in this example (will render as $\dot{x}$ instead of $dot_x$).
72
77
73
78
## Latex help
74
79
75
-
1. Use `\begin{array}` to generate a compact table i.e.
80
+
### Use `\dfrac` for bigger fractions when needed.
81
+
82
+
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
+
84
+
$\dfrac{3}{4} \quad$ (dfrac)
85
+
86
+
$\frac{3}{4} \quad$ (frac)
87
+
88
+
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
+
90
+
### Use `\small` when smaller fonts or fractions are needed
91
+
92
+
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
+
94
+
$\small{\frac{1}{2}} \quad$ (small)
95
+
96
+
$\frac{1}{2}$
97
+
98
+
### Use `\begin{array}` to generate a compact table i.e.
76
99
77
100
```latex
78
101
\begin{array}{|c|c|}
@@ -88,7 +111,7 @@ Live preview instantly renders a student's input. This is very useful for long/c
88
111
89
112
90
113
91
-
2. Use `\begin{aligned}` to keep your working formatted nicely
114
+
###Use `\begin{aligned}` to keep your working formatted nicely
92
115
93
116
```latex
94
117
\begin{aligned}
@@ -100,7 +123,7 @@ Live preview instantly renders a student's input. This is very useful for long/c
100
123
101
124
102
125
103
-
3. Use `\left` and `\right` for equations with multiple brackets
126
+
###Use `\left` and `\right` for equations with multiple brackets
0 commit comments