diff --git a/doc/en/AbInitio/Authoring_quick_start_2.md b/doc/en/AbInitio/Authoring_quick_start_2.md index fb78fab49317846e69292610ab694df8f6a7206c..a9cba7b6014cf5e0d5c707b4bb813f4134bde79b 100644 --- a/doc/en/AbInitio/Authoring_quick_start_2.md +++ b/doc/en/AbInitio/Authoring_quick_start_2.md @@ -20,7 +20,7 @@ Let us focus on the problem of finding \(\int 3(x-1)^{-4} \mathrm{d}x\). Create ### Using question variables -The next steps would be to add question text, and then to add the teacher's answer `-1*(x-1)^(-3)+c` to the `model answer` field and the `potential response tree`. However, the expression and model answer will normally be referred to more than once, so it is usually easiest to assign them to "question variables" using the optional [question variables](/Authoring/Variables.md#Question_variables) field. +The next steps would be to add question text, and then to add the teacher's answer `-1*(x-1)^(-3)+c` to the `model answer` field and the `potential response tree`. However, the expression and model answer will normally be referred to more than once, so it is usually easiest to assign them to "question variables" using the optional [question variables](../Authoring/Variables.md#Question_variables) field. Add the following to the question variables @@ -38,7 +38,7 @@ Now it will be a lot faster to fill out the rest of the question. Add the follow Find \(\int{@exp@} \mathrm{d}x\) [[input:ans1]] [[validation:ans1]] -Notice that we have defined a local variable `exp`, and used the value of this in the Question text. There is a difference between mathematics enclosed between `\(..\)` symbols and `{@..@}` symbols. All the text-based fields in the question, including feedback, are [CAS text](/Authoring/CASText.md). This is HTML into which mathematics can be inserted. LaTeX is placed between `\(..\)`s, and CAS expressions (including your variables) between matching `{@..@}` symbols. The CAS expressions are evaluated in the context of the question variables and displayed as LaTeX. +Notice that we have defined a local variable `exp`, and used the value of this in the Question text. There is a difference between mathematics enclosed between `\(..\)` symbols and `{@..@}` symbols. All the text-based fields in the question, including feedback, are [CAS text](../Authoring/CASText.md). This is HTML into which mathematics can be inserted. LaTeX is placed between `\(..\)`s, and CAS expressions (including your variables) between matching `{@..@}` symbols. The CAS expressions are evaluated in the context of the question variables and displayed as LaTeX. Since we have used `{@exp@}` here, the user will not see a \(exp\) on the screen when the question is instantiated, but the _displayed value_ of `exp`: \(\frac{3}{(x-1)^{-4}}\) diff --git a/doc/en/AbInitio/Authoring_quick_start_3.md b/doc/en/AbInitio/Authoring_quick_start_3.md index 8f8b23a1d601c85c3a3a4c9b79ad31a6fbe6616d..e4d5265a4481e2e55ad3f68e09d706d975f2f451 100644 --- a/doc/en/AbInitio/Authoring_quick_start_3.md +++ b/doc/en/AbInitio/Authoring_quick_start_3.md @@ -15,7 +15,7 @@ Try previewing this question and typing in `-1*(x-1)^(-3)+c`. The system should ## Answer test: Int -We will need to edit the potential response tree to use a better [answer test](/Authoring/Answer_Tests/Calculus.md). Return to the page "Editing a STACK question". Find your potential response tree settings, click on the drop-down menu where we selected `AlgEquiv` and select `Int` from the list. Type `x` (the variable) into the Test options setting. Now press the `[Save changes and continue editing]` button and once more click the preview button. We have just selected a special [answer test](/Authoring/Answer_Tests/Calculus.md) for dealing with integration questions. +We will need to edit the potential response tree to use a better [answer test](../Authoring/Answer_Tests/Calculus.md). Return to the page "Editing a STACK question". Find your potential response tree settings, click on the drop-down menu where we selected `AlgEquiv` and select `Int` from the list. Type `x` (the variable) into the Test options setting. Now press the `[Save changes and continue editing]` button and once more click the preview button. We have just selected a special [answer test](../Authoring/Answer_Tests/Calculus.md) for dealing with integration questions. The _Int_ answer test will accept any variable name for the constant of integration. For example, try typing in `-(x-1)^(-3)+k`. The system should accept this as correct. It will also give standard feedback if the student forgets a constant of integration or accidentally differentiates instead. To try this, type `-12*(x-1)^(-5)`. If you don't want students to see the automatic feedback, select the _Quiet_ option in the potential response node. @@ -38,7 +38,7 @@ For each mistake we think students might make, we can create an answer test. For  -Go to the potential response tree and click `[Add another node]` . Then under Node 1's `True` branch change `Next` to `Node 2`. If we enter Node 2, we know the student has the correct answer and just need to establish if it is factored or not. To establish this we need to use the [FacForm answer test](/Authoring/Answer_Tests/index.md). This tests both that SAns and TAns are equivalent, and that SAns is factored. In this case we already know that the student's answer is equivalent to the teacher's answer (using *Int*'s better tailored algorithm). Hence we can just test the student's answer against itself. +Go to the potential response tree and click `[Add another node]` . Then under Node 1's `True` branch change `Next` to `Node 2`. If we enter Node 2, we know the student has the correct answer and just need to establish if it is factored or not. To establish this we need to use the [FacForm answer test](../Authoring/Answer_Tests/index.md). This tests both that SAns and TAns are equivalent, and that SAns is factored. In this case we already know that the student's answer is equivalent to the teacher's answer (using *Int*'s better tailored algorithm). Hence we can just test the student's answer against itself. Update the form so that Node 2 has @@ -59,7 +59,7 @@ FacForm gives automatic feedback, but if you want to write your own you can set Your answer is not factored. Well done for getting the correct answer, but remember that there is no need to expand out the brackets. ``` -You can continue to expand your potential response tree, checking for as many common mistakes as you would like to. See the [documentation](/Authoring/Answer_Tests/index.md) for information on more answer tests. +You can continue to expand your potential response tree, checking for as many common mistakes as you would like to. See the [documentation](../Authoring/Answer_Tests/index.md) for information on more answer tests. ## Adding general feedback diff --git a/doc/en/AbInitio/Authoring_quick_start_4.md b/doc/en/AbInitio/Authoring_quick_start_4.md index 2b911008ce2346c430779ae11212217ddca8b06d..506d416571afe442e2ac2847770672c3a4d8daa5 100644 --- a/doc/en/AbInitio/Authoring_quick_start_4.md +++ b/doc/en/AbInitio/Authoring_quick_start_4.md @@ -21,7 +21,7 @@ ta: int(exp,x)+c; We defined two local variables `exp` and `ta`, and used these values in other places such as the question text, input and potential response tree. -We are now in a position to generate a random question. To do this, modify the [question variables](/Authoring/Variables.md#Question_variables) to be +We are now in a position to generate a random question. To do this, modify the [question variables](../Authoring/Variables.md#Question_variables) to be ``` a1 : 1+rand(6); diff --git a/doc/en/AbInitio/Authoring_quick_start_5.md b/doc/en/AbInitio/Authoring_quick_start_5.md index 7b752f95f80d7923c69816ac834bfd5c25f37076..8e7e40673c5750dc63e80d916787bfe116624183 100644 --- a/doc/en/AbInitio/Authoring_quick_start_5.md +++ b/doc/en/AbInitio/Authoring_quick_start_5.md @@ -68,7 +68,7 @@ We are testing that if we multiply by \(-nn+1\) instead of dividing, we should b You will see that not all deployed versions pass all tests, and if you click on a variant that failed a test, you will see why! Essentially, when \(nn=2\), \(-nn+1=-1\) multiplication and division are equivalent. Essentially, these random variants are "easier" than the others. This illustrates another key use of question tests - ensuring that all variants are the same difficulty and test the knowledge they are supposed to. In light of this, you may want to change `nn` again to ` 3+rand(4)` . Now all variants should pass all question tests. -Quality control is essential, and more information is given in the page on [testing](/Authoring/Testing.md). +Quality control is essential, and more information is given in the page on [testing](../Authoring/Testing.md). ## Aside: forbidden words diff --git a/doc/en/AbInitio/Authoring_quick_start_8.md b/doc/en/AbInitio/Authoring_quick_start_8.md index c2d0462d2907bfbe88e887f35e59c2a8f08f2dca..09850107cca7f8ba47061934da7349a2ad06471e 100644 --- a/doc/en/AbInitio/Authoring_quick_start_8.md +++ b/doc/en/AbInitio/Authoring_quick_start_8.md @@ -96,10 +96,10 @@ You should now be able to work with quizzes in Moodle. This concludes the authoring quick start guide. The STACK documentation is comprehensive, and there are many things you might want to look at next. For example, you can -- learn about more [input types](/Authoring/Inputs.md), -- learn about more [answer tests](/Authoring/Answer_Tests/index.md), -- add [plots](../Plots/Plots.md) to your [CASText](/Authoring/CASText.md) fields, -- add support for [multiple languages](/Authoring/Languages.md), -- learn about using [equivalence reasoning](/Authoring/Equivalence_reasoning.md), -- read about [Curve sketching](/Topics/Curve_sketching.md). +- learn about more [input types](../Authoring/Inputs.md), +- learn about more [answer tests](../Authoring/Answer_Tests/index.md), +- add [plots](../Plots/Plots.md) to your [CASText](../Authoring/CASText.md) fields, +- add support for [multiple languages](../Authoring/Languages.md), +- learn about using [equivalence reasoning](../Authoring/Equivalence_reasoning.md), +- read about [Curve sketching](../Topics/Curve_sketching.md). - look at more information on [Maxima](../CAS/index.md), particularly the Maxima documentation if you are not very familiar with Maxima's syntax and function names. A graphical Maxima interface like [wxMaxima](http://andrejv.github.com/wxmaxima/) can also be very helpful for finding the appropriate Maxima commands easily. diff --git a/doc/en/AbInitio/index.md b/doc/en/AbInitio/index.md index 176c1e714d3bfef7056d9f603ee231eacca97a1b..84438d247e3e9d9df88c2a159180eb0428dc35ea 100644 --- a/doc/en/AbInitio/index.md +++ b/doc/en/AbInitio/index.md @@ -13,4 +13,4 @@ Those new to STACK will probably prefer to begin with the [authoring quick start ## See also -* [Authoring](/Authoring/index.md) +* [Authoring](../Authoring/index.md) diff --git a/doc/en/Authoring/Potential_response_trees.md b/doc/en/Authoring/Potential_response_trees.md index fee478e5d740d3f90350af24307b79c8d66c5bb4..8218ada90511d5587d0ec121ae13b56748930593 100644 --- a/doc/en/Authoring/Potential_response_trees.md +++ b/doc/en/Authoring/Potential_response_trees.md @@ -1,6 +1,6 @@ # Potential response trees -The potential response tree is the algorithm which establishes the mathematical properties of the student's answer and assigns outcomes. For examples of how to use this, see the entry on [improving feedback](/AbInitio/Authoring_quick_start_3.md) in the quick start guide. +The potential response tree is the algorithm which establishes the mathematical properties of the student's answer and assigns outcomes. For examples of how to use this, see the entry on [improving feedback](../AbInitio/Authoring_quick_start_3.md) in the quick start guide. ## When is the tree used? ## diff --git a/doc/en/Authoring/Sample_questions.md b/doc/en/Authoring/Sample_questions.md index 368b3e6320ca178e35d8ca2e2792a6a8a17fc1ec..9146f07e87c8133fe9849d5e35d1755a33cbb0cf 100644 --- a/doc/en/Authoring/Sample_questions.md +++ b/doc/en/Authoring/Sample_questions.md @@ -38,7 +38,7 @@ This question creates two random matrices and asks students to multiply them tog Given a complex number \(z=ae^{ib}\) determine \(|z^{n}|\) and \(\arg(z^{n})\). Where \(a\), \(b\) and \(n\) are randomly generated numbers. -See the [authoring quick start 7](/AbInitio/Authoring_quick_start_7.md). +See the [authoring quick start 7](../AbInitio/Authoring_quick_start_7.md). ### `test_5_cubic-spline` ### diff --git a/doc/en/Authoring/index.md b/doc/en/Authoring/index.md index 4aff6eb6b9be570100f7199cd25e25c8977ab5f1..1d07ef018759ef5f5e5f4f5462fe6147b3462ad7 100644 --- a/doc/en/Authoring/index.md +++ b/doc/en/Authoring/index.md @@ -62,7 +62,7 @@ The authoring documentation also covers topics on: If you cannot find documentation on the topic you are looking for, it may be located in the [CAS](../CAS/index.md) section of the documentation. This includes documentation on working with Maxima in a question, and so covers topics like -* [Inequalities](/CAS/Inequalities.md), -* [Randomisation](/CAS/Random.md), -* [Plotting graphs../Plots/Plots.md), -* [Simplification](/CAS/Simplification.md). +* [Inequalities](../CAS/Inequalities.md), +* [Randomisation](../CAS/Random.md), +* [Plotting graphs](../Plots/Plots.md), +* [Simplification](../CAS/Simplification.md). diff --git a/doc/en/CAS/Simplification.md b/doc/en/CAS/Simplification.md index 38afe46a300ccf5ee58de9c21cddb88b0b1a6503..254f094dd1e84da178ade8aed98c8bef701073fa 100644 --- a/doc/en/CAS/Simplification.md +++ b/doc/en/CAS/Simplification.md @@ -283,7 +283,7 @@ See the page on [propositional logic](../Topics/Propositional_Logic.md). Some further examples are given elsewhere: * Matrix examples in [showing working](Matrix.md#Showing-working). -* An example of a question with `simp:false` is discussed in [authoring quick start 7](/AbInitio/Authoring_quick_start_7.md). +* An example of a question with `simp:false` is discussed in [authoring quick start 7](../AbInitio/Authoring_quick_start_7.md). * Generating [random algebraic expressions](Random.md) which need to be "gathered and sorted". Note also that [question tests](../Authoring/Testing.md#Simplification) do not simplify test inputs. diff --git a/doc/en/index.md b/doc/en/index.md index a653c2a3b99f7a58a2d01fa1e6a3c8d177108f24..0867581b74b68f8d9ffd2b8f93a6c84a8f698b3e 100644 --- a/doc/en/index.md +++ b/doc/en/index.md @@ -20,7 +20,7 @@ This is the official user documentation for STACK. Documentation for question authors, including: * An [authoring quick start guide](Authoring/Authoring_quick_start.md), which can be used in conjunction with the "Getting started with STACK" [guide](../content/2019-STACK-Guide.pdf). -* Information on various [authoring topics](Authoring/index.md), such as [answer tests](Authoring/Answer_Tests/index.md), [inputs](/Authoring/Inputs.md), [potential response trees](Authoring/Potential_response_trees.md) and [translations](Authoring/Languages.md). +* Information on various [authoring topics](Authoring/index.md), such as [answer tests](Authoring/Answer_Tests/index.md), [inputs](Authoring/Inputs.md), [potential response trees](Authoring/Potential_response_trees.md) and [translations](Authoring/Languages.md). * [Frequently asked questions](Authoring/Author_FAQ.md). * Information on using the [CAS Maxima](CAS/index.md) for question authoring, including [randomisation](CAS/Random.md), [plotting graphs](Plots/index.md), and expression [simplification](CAS/Simplification.md).