Skip to content

Commit 2b92afb

Browse files
committed
Add in stub for metadata documentation. #1171.
1 parent 259be97 commit 2b92afb

6 files changed

Lines changed: 15 additions & 2 deletions

File tree

doc/en/Authoring/Metadata.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Question metadata
2+
3+
STACK questions support flexible metadata.

doc/en/Authoring/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ A "question" is the basic object in the system. The following table shows the f
1717
| [Inputs](Inputs/index.md) | The inputs are the things, such as form boxes, with which the student actually interacts.
1818
| [Potential response trees](Potential_response_trees.md) | These are the algorithms which establish the mathematical properties of the students' answers and generate feedback.
1919
| [Options](Question_options.md) | Many behaviours can be changed with the options.
20+
| [Metadata](Metadata.md) | STACK questions support flexible metadata.
2021

2122
The authoring documentation also covers topics on:
2223

doc/en/Developer/Development_track.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Issues with [github milestone 4.13.0](https://github.com/maths/moodle-qtype_stac
1212
1. Remove all "cte" code from Maxima - mostly install.
1313
2. Support for Maxima 5.47.0, 5.48.0, and 5.49.0. This includes a fix for issue #1281 from 5.48.0.
1414
3. Question tests can now test the whole route through a PRT, rather than just the final node. This is a significant improvement on the ability to test questions. This is back-compatible with older questions.
15+
4. Add in flexible [question metadata](../Authoring/Metadata.md). This fixes issue #1171.
1516

1617
--------------------------------------
1718

doc/en/Developer/Future_plans.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ Basic reports now work.
137137
* Text based potential response trees (would allow for easier copying of complicated trees, etc).
138138
* Changes to preset feedback to certain answer tests which might be more appropriate for different audiences. Could a 'simplified' English language pack allow for this (future changes might allow this to be done on a question-by-question basis).
139139
* Check for potential issues with default correct/incorrect feedback for different languages (defaults can already be set on the server level by a Moodle administrator).
140-
* Metadata on language for questions.
141140
* Tools for language integrity (e.g. making it easier to identify what languages are in each question).
142141
* Making sure Maxima knows the intended language (will allow for Maxima code to choose from the available languages).
143142
* May want to have further discussions on how scores and penalties are handled (there is already a new feature in the latest version of STACK so that you can include functions in the "score" field.

doc/en/STACK_question_admin/Authoring_workflow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,11 @@ In theory one test case should be created for each anticipated response which ge
6969

7070
When updating a PRT at this stage we would _expect_ test cases added in step 2 to fail. This is reassuring as it indicates something significant has changed! You can easily confirm the new behaviour of the testcase is now what is intended.
7171

72-
### 6. Use data obtained from one cycle of attempts by students.
72+
### 6. Add accurate metadata.
73+
74+
Check and add accurate [question metadata](../Authoring/Metadata.md).
75+
76+
### 7. Use data obtained from one cycle of attempts by students.
7377

7478
Rather than second-guess what students _might_ get wrong it is more effective to look at what they _do_. See the section on [reporting](Reporting.md) for documentation on how to review students' answers. When feedback/marks are delayed (e.g. online exam) this can be done between students taking the assessment and results being released. If feedback/marks are immediate then better quality feedback can still be usefully added later.
7579

doc/meta_en.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,11 @@
463463
"description":"Information on writing STACK questions for several languages."
464464
},
465465
{
466+
"file":"Metadata.md",
467+
"title":"Question Metadata - STACK Documentation",
468+
"description":"Information on STACK question metadata."
469+
},
470+
{
466471
"file":"Question_options.md",
467472
"title":"Options - STACK Documentation",
468473
"description":"Documentation for the Option section in a STACK question."

0 commit comments

Comments
 (0)