Deployed 6c2a176 with MkDocs version: 1.6.1

search/search_index.json

@@ -1143,9 +1143,9 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#use-romanised-text-for-operators-and-units" class="md-nav__link">
+  <a href="#romanised-text-for-operators-and-units" class="md-nav__link">
     <span class="md-ellipsis">
-      Use romanised text for operators and units
+      Romanised text for operators and units
     </span>
   </a>
 
@@ -1161,9 +1161,9 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-empty-lines" class="md-nav__link">
+  <a href="#empty-lines" class="md-nav__link">
     <span class="md-ellipsis">
-      Use empty lines
+      Empty lines
     </span>
   </a>
 
@@ -1203,36 +1203,36 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-pre-response-area-text-to-be-clear-what-should-be-entered" class="md-nav__link">
+  <a href="#pre-response-area-text" class="md-nav__link">
     <span class="md-ellipsis">
-      Use pre-response area text to be clear what should be entered
+      Pre-response area text
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-live-preview-and-permit-all-types-of-input" class="md-nav__link">
+  <a href="#live-preview" class="md-nav__link">
     <span class="md-ellipsis">
-      Use live preview and permit all types of input
+      Live preview
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-branching-when-relevant" class="md-nav__link">
+  <a href="#branching" class="md-nav__link">
     <span class="md-ellipsis">
-      Use branching when relevant
+      Branching
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-audio-clips" class="md-nav__link">
+  <a href="#audio-clips" class="md-nav__link">
     <span class="md-ellipsis">
-      Use audio clips
+      Audio clips
     </span>
   </a>
 
@@ -1263,27 +1263,27 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#use-dfrac-for-bigger-fractions-when-needed" class="md-nav__link">
+  <a href="#use-dfrac-for-bigger-fractions" class="md-nav__link">
     <span class="md-ellipsis">
-      Use \dfrac for bigger fractions when needed.
+      Use \dfrac for bigger fractions
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-small-when-smaller-fonts-or-fractions-are-needed" class="md-nav__link">
+  <a href="#use-small-for-a-smaller-font" class="md-nav__link">
     <span class="md-ellipsis">
-      Use \small when smaller fonts or fractions are needed
+      Use \small for a smaller font
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-beginarray-to-generate-a-compact-table-ie" class="md-nav__link">
+  <a href="#use-beginarray-to-generate-a-compact-table" class="md-nav__link">
     <span class="md-ellipsis">
-      Use \begin{array} to generate a compact table i.e.
+      Use \begin{array} to generate a compact table
     </span>
   </a>
 
@@ -3004,9 +3004,9 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#use-romanised-text-for-operators-and-units" class="md-nav__link">
+  <a href="#romanised-text-for-operators-and-units" class="md-nav__link">
     <span class="md-ellipsis">
-      Use romanised text for operators and units
+      Romanised text for operators and units
     </span>
   </a>
 
@@ -3022,9 +3022,9 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-empty-lines" class="md-nav__link">
+  <a href="#empty-lines" class="md-nav__link">
     <span class="md-ellipsis">
-      Use empty lines
+      Empty lines
     </span>
   </a>
 
@@ -3064,36 +3064,36 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-pre-response-area-text-to-be-clear-what-should-be-entered" class="md-nav__link">
+  <a href="#pre-response-area-text" class="md-nav__link">
     <span class="md-ellipsis">
-      Use pre-response area text to be clear what should be entered
+      Pre-response area text
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-live-preview-and-permit-all-types-of-input" class="md-nav__link">
+  <a href="#live-preview" class="md-nav__link">
     <span class="md-ellipsis">
-      Use live preview and permit all types of input
+      Live preview
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-branching-when-relevant" class="md-nav__link">
+  <a href="#branching" class="md-nav__link">
     <span class="md-ellipsis">
-      Use branching when relevant
+      Branching
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-audio-clips" class="md-nav__link">
+  <a href="#audio-clips" class="md-nav__link">
     <span class="md-ellipsis">
-      Use audio clips
+      Audio clips
     </span>
   </a>
 
@@ -3124,27 +3124,27 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#use-dfrac-for-bigger-fractions-when-needed" class="md-nav__link">
+  <a href="#use-dfrac-for-bigger-fractions" class="md-nav__link">
     <span class="md-ellipsis">
-      Use \dfrac for bigger fractions when needed.
+      Use \dfrac for bigger fractions
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-small-when-smaller-fonts-or-fractions-are-needed" class="md-nav__link">
+  <a href="#use-small-for-a-smaller-font" class="md-nav__link">
     <span class="md-ellipsis">
-      Use \small when smaller fonts or fractions are needed
+      Use \small for a smaller font
     </span>
   </a>
 
 </li>
 
           <li class="md-nav__item">
-  <a href="#use-beginarray-to-generate-a-compact-table-ie" class="md-nav__link">
+  <a href="#use-beginarray-to-generate-a-compact-table" class="md-nav__link">
     <span class="md-ellipsis">
-      Use \begin{array} to generate a compact table i.e.
+      Use \begin{array} to generate a compact table
     </span>
   </a>
 
@@ -3207,7 +3207,7 @@
 
 <h1 id="good-practice">Good practice<a class="headerlink" href="#good-practice" title="Permanent link">&para;</a></h1>
 <h2 id="formatting-style-for-readability">Formatting &amp; style for readability<a class="headerlink" href="#formatting-style-for-readability" title="Permanent link">&para;</a></h2>
-<h3 id="use-romanised-text-for-operators-and-units">Use romanised text for operators and units<a class="headerlink" href="#use-romanised-text-for-operators-and-units" title="Permanent link">&para;</a></h3>
+<h3 id="romanised-text-for-operators-and-units">Romanised text for operators and units<a class="headerlink" href="#romanised-text-for-operators-and-units" title="Permanent link">&para;</a></h3>
 <p>Use romanised operators and scientific units to distinguish them from variables, which are italicised.</p>
 <ul>
 <li>
@@ -3228,47 +3228,49 @@ <h3 id="use-romanised-text-for-operators-and-units">Use romanised text for opera
 <h3 id="space-between-numbers-and-units">Space between numbers and units<a class="headerlink" href="#space-between-numbers-and-units" title="Permanent link">&para;</a></h3>
 <p>Put appropriate space between a number and its unit, such as <code>5 m</code> or <code>3 kg</code>, according to the SI conventions.</p>
 <p>e.g. <code>$5 \text{ m}$</code> to get <span class="arithmatex">\(5 \text{ m}\)</span></p>
-<h3 id="use-empty-lines">Use empty lines<a class="headerlink" href="#use-empty-lines" title="Permanent link">&para;</a></h3>
+<h3 id="empty-lines">Empty lines<a class="headerlink" href="#empty-lines" title="Permanent link">&para;</a></h3>
 <p>Using empty lines can improve the readability and neatness of your content.</p>
 <p>Empty lines are often useful before and after an equation, and between paragraphs of text. An empty line in markdown requires <em>two spaces</em> on the line, otherwise the line is ignored.</p>
 <p>Alternatively, adding empty LaTeX text, <code>\text{}</code>, can work if all else fails.</p>
 <h2 id="using-platform-features-effectively">Using platform features effectively<a class="headerlink" href="#using-platform-features-effectively" title="Permanent link">&para;</a></h2>
 <h3 id="save-and-publish-as-you-go">Save and publish as you go<a class="headerlink" href="#save-and-publish-as-you-go" title="Permanent link">&para;</a></h3>
 <p>Saving and publishing work regularly is recommended to prevent accidental data loss.</p>
 <h3 id="add-tests-to-response-areas">Add tests to response areas<a class="headerlink" href="#add-tests-to-response-areas" title="Permanent link">&para;</a></h3>
-<p>In a response area, press <code>Configure</code> then <code>Test</code>.</p>
 <p>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.</p>
-<h3 id="use-pre-response-area-text-to-be-clear-what-should-be-entered">Use pre-response area text to be clear what should be entered<a class="headerlink" href="#use-pre-response-area-text-to-be-clear-what-should-be-entered" title="Permanent link">&para;</a></h3>
+<p>In a response area, press <code>Configure</code> then <code>Test</code>.</p>
+<h3 id="pre-response-area-text">Pre-response area text<a class="headerlink" href="#pre-response-area-text" title="Permanent link">&para;</a></h3>
+<p>Use pre-response area text to make clear what students should write.</p>
 <p>Pre-response area text is found under <code>Configure</code> - <code>Input</code> in the evaluation function.</p>
 <p>You can use LaTeX in the pre-response area text.</p>
 <p><img alt="Image showing a pre-response area" src="../images/pre_response_area.png" /></p>
-<h3 id="use-live-preview-and-permit-all-types-of-input">Use live preview and permit all types of input<a class="headerlink" href="#use-live-preview-and-permit-all-types-of-input" title="Permanent link">&para;</a></h3>
-<p>Live preview is found under <code>Configure</code> - <code>Input</code> - <code>Display settings</code>.</p>
+<h3 id="live-preview">Live preview<a class="headerlink" href="#live-preview" title="Permanent link">&para;</a></h3>
 <p>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.</p>
+<p>Live preview is found under <code>Configure</code> - <code>Input</code> - <code>Display settings</code>.</p>
 <p><img alt="Image showing a live-preview to a student's response" src="../images/live_preview.png" /></p>
-<h3 id="use-branching-when-relevant">Use branching when relevant<a class="headerlink" href="#use-branching-when-relevant" title="Permanent link">&para;</a></h3>
-<p>Branching is a feature for <code>worked solutions</code>. It allows you to have different solution pathways Usage examples:</p>
+<h3 id="branching">Branching<a class="headerlink" href="#branching" title="Permanent link">&para;</a></h3>
+<p>Branching is a feature for <code>worked solutions</code>. It allows you to have different solution pathways</p>
+<p>Usage examples:</p>
 <ul>
 <li>When a question can be solved via multiple different methods, branching can be used for each method.</li>
 <li>When a question has multiple parts, where each part involves substitution of different values, branching can be used for each part.</li>
 </ul>
 <p><img alt="gif showing the branching feature" src="../images/branching.gif" /></p>
-<h3 id="use-audio-clips">Use audio clips<a class="headerlink" href="#use-audio-clips" title="Permanent link">&para;</a></h3>
+<h3 id="audio-clips">Audio clips<a class="headerlink" href="#audio-clips" title="Permanent link">&para;</a></h3>
 <p>Just drag + drop an audio file into the editor.</p>
 <h3 id="issue-with-input-symbols">Issue with input symbols<a class="headerlink" href="#issue-with-input-symbols" title="Permanent link">&para;</a></h3>
 <p>When defining the <code>code</code> of an input symbol in the response areas, the system cannot accept brackets (i.e using <code>dot(x)</code> for <span class="arithmatex">\(\dot{x}\)</span>). The response must be formatted in a different way (i.e <code>dot_x</code>). </p>
 <p><code>a_b</code> will render as <span class="arithmatex">\(a_b\)</span> without adding an input symbol, but note that <code>dot_x</code> will override the <code>_</code> input in this example (will render as <span class="arithmatex">\(\dot{x}\)</span> instead of <span class="arithmatex">\(dot_x\)</span>).</p>
 <h2 id="latex-help">Latex help<a class="headerlink" href="#latex-help" title="Permanent link">&para;</a></h2>
-<h3 id="use-dfrac-for-bigger-fractions-when-needed">Use <code>\dfrac</code> for bigger fractions when needed.<a class="headerlink" href="#use-dfrac-for-bigger-fractions-when-needed" title="Permanent link">&para;</a></h3>
+<h3 id="use-dfrac-for-bigger-fractions">Use <code>\dfrac</code> for bigger fractions<a class="headerlink" href="#use-dfrac-for-bigger-fractions" title="Permanent link">&para;</a></h3>
 <p>Use <code>$\dfrac{numerator}{denominator}$</code> for bigger fractions when you need to display them more clearly or emphasize them. For example, <code>$\dfrac{3}{4}$</code> will produce a bigger fraction than <code>$\frac{3}{4}$</code>:</p>
 <p><span class="arithmatex">\(\dfrac{3}{4} \quad\)</span>    (dfrac)</p>
 <p><span class="arithmatex">\(\frac{3}{4} \quad\)</span>    (frac)</p>
 <p>Alternatively, you can use <code>$\displaystyle$</code> at the start of an inline equation to render everything afterwards full-size (as in display maths mode), this is especially helpful for integrals.</p>
-<h3 id="use-small-when-smaller-fonts-or-fractions-are-needed">Use <code>\small</code> when smaller fonts or fractions are needed<a class="headerlink" href="#use-small-when-smaller-fonts-or-fractions-are-needed" title="Permanent link">&para;</a></h3>
+<h3 id="use-small-for-a-smaller-font">Use <code>\small</code> for a smaller font<a class="headerlink" href="#use-small-for-a-smaller-font" title="Permanent link">&para;</a></h3>
 <p>Use <code>$\small{text}$</code> when you need to display smaller fonts or fractions in your LaTeX expressions. For example, <code>$\small{\frac{1}{2}}$</code> will produce a smaller fraction than <code>$\frac{1}{2}$</code>.</p>
 <p><span class="arithmatex">\(\small{\frac{1}{2}} \quad\)</span> (small)</p>
 <p><span class="arithmatex">\(\frac{1}{2}\)</span></p>
-<h3 id="use-beginarray-to-generate-a-compact-table-ie">Use <code>\begin{array}</code> to generate a compact table i.e.<a class="headerlink" href="#use-beginarray-to-generate-a-compact-table-ie" title="Permanent link">&para;</a></h3>
+<h3 id="use-beginarray-to-generate-a-compact-table">Use <code>\begin{array}</code> to generate a compact table<a class="headerlink" href="#use-beginarray-to-generate-a-compact-table" title="Permanent link">&para;</a></h3>
 <div class="highlight"><pre><span></span><code>```latex
 \begin{array}{|c|c|}
 \hline
@@ -3280,9 +3282,8 @@ <h3 id="use-beginarray-to-generate-a-compact-table-ie">Use <code>\begin{array}</
 \hline
 \end{array}
 ```
-
-![Image showing a example of a table](images/table.png)
 </code></pre></div>
+<p><img alt="Image showing a example of a table" src="../images/table.png" /></p>
 <h3 id="use-beginaligned-to-keep-your-working-formatted-nicely">Use <code>\begin{aligned}</code> to keep your working formatted nicely<a class="headerlink" href="#use-beginaligned-to-keep-your-working-formatted-nicely" title="Permanent link">&para;</a></h3>
 <div class="highlight"><pre><span></span><code>```latex
 \begin{aligned}
@@ -3291,18 +3292,16 @@ <h3 id="use-beginaligned-to-keep-your-working-formatted-nicely">Use <code>\begin
 &amp; =\begin{pmatrix} 4 &amp; 4\\ 4 &amp; -11 \end{pmatrix}
 \end{aligned}
 ```
-
-![Image showing a example of a algined working](images/aligned.png)
 </code></pre></div>
+<p><img alt="Image showing a example of a algined working" src="../images/aligned.png" /></p>
 <h3 id="use-left-and-right-for-equations-with-multiple-brackets">Use <code>\left</code> and <code>\right</code> for equations with multiple brackets<a class="headerlink" href="#use-left-and-right-for-equations-with-multiple-brackets" title="Permanent link">&para;</a></h3>
+<p>This sizes the brackets correctly to the height of the equation.</p>
 <div class="highlight"><pre><span></span><code>```latex
 f(x)=\left (\frac{(\cos (x) -x) + i(\sin (x) - x)}{wi} \right)
 ```
-
-![Image showing a example of a brackets](images/bracket.png)
-
-This also works for `[ ]` and `\{ \}`
 </code></pre></div>
+<p><img alt="Image showing a example of a brackets" src="../images/bracket.png" /></p>
+<p>This also works for <code>[ ]</code> and <code>\{ \}</code></p>
 <h3 id="shortcut-for-romanised-operators">Shortcut for romanised operators<a class="headerlink" href="#shortcut-for-romanised-operators" title="Permanent link">&para;</a></h3>
 <p>Use <code>\sin</code>, <code>\cos</code>, etc. as a shortcut for <code>\text{sin }</code>, <code>\text{cos }</code>, etc.</p>