Development:Question Engine 2:Overview - Revision history

TimHunt at 17:04, 26 April 2010

2010-04-26T17:04:56Z

TimHunt at 10:06, 8 December 2009

2009-12-08T10:06:27Z

← Older revision		Revision as of 10:06, 8 December 2009
Line 1:		Line 1:
			{{Template:Question_engine_2}}
	This page outlines how I think the question engine should work in Moodle 2.0 or 2.1.		This page outlines how I think the question engine should work in Moodle 2.0 or 2.1.

Line 205:		Line 206:

	* Back to [[Development:Question_Engine_2\|Question Engine 2]]		* Back to [[Development:Question_Engine_2\|Question Engine 2]]

	~~{{CategoryDeveloper}}~~
	~~[[Category:Quiz]]~~

TimHunt: /* What are the parts of a question? */

2009-11-05T11:24:27Z

What are the parts of a question?

← Older revision		Revision as of 11:24, 5 November 2009
Line 142:		Line 142:
	The full list of options that control which of those bits are visible at any time are:		The full list of options that control which of those bits are visible at any time are:

			; correctness : (hidden / visible) whether the student gets told whether their answer was (in/partially)correct in the status summary under the question number, or instead are told something vague like 'Finished'.
	; marks : (hidden / max only / actual mark and max / actual mark and max with explanation ) whether the student can see the number of marks available, and how many marks they got, and how much detail of the marking to display.		; marks : (hidden / max only / actual mark and max / actual mark and max with explanation ) whether the student can see the number of marks available, and how many marks they got, and how much detail of the marking to display.
	; marks d.p. : (0 .. 7) how many decimal places marks are displayed to.		; marks d.p. : (0 .. 7) how many decimal places marks are displayed to.

TimHunt: /* What are the parts of a question? */

2009-11-05T11:11:00Z

What are the parts of a question?

← Older revision		Revision as of 11:11, 5 November 2009
Line 138:		Line 138:
	# The outcome from submitting that response. This has a yellow background.		# The outcome from submitting that response. This has a yellow background.

	[[Image:Parts of a ~~question~~.png]]		[[Image:Parts of a question2.png]]

	The full list of options that control which of those bits are visible at any time are:		The full list of options that control which of those bits are visible at any time are:

			; marks : (hidden / max only / actual mark and max / actual mark and max with explanation ) whether the student can see the number of marks available, and how many marks they got, and how much detail of the marking to display.
			; marks d.p. : (0 .. 7) how many decimal places marks are displayed to.
			; flags: (hidden / visible / visible and editable) this is the feature that lets students bookmark or flag a question in an attempt for later reference.
	; read-only: Whether the question just shows the response was already entered, or whether it gives controls to the user enter/change their response.		; read-only: Whether the question just shows the response was already entered, or whether it gives controls to the user enter/change their response.
	~~; flags: (hidden / visible / visible and editable) this is the feature that lets students bookmark or flag a question in an attempt for later reference.~~
	; specific feedback: (hidden / visible) feedback that relates to the particular response the student entered.		; specific feedback: (hidden / visible) feedback that relates to the particular response the student entered.
	; ~~correct response~~: (hidden / visible) whether the ~~automatically generated message or other indication of the correct answer~~ is visible.		; general feedback : (hidden / visible) whether the general feedback (same for all students) is visible.
	; ~~correctness~~: (hidden / visible) whether the automatically generated message ~~'Your~~ answer ~~was partially correct' or similar~~ is visible.		; correct response : (hidden / visible) whether the automatically generated message or other indication of the correct answer is visible.
	; manual comment: (hidden / visible / visible and editable) whether the comment manually added by the teacher is visible and editable by the current user.		; manual comment: (hidden / visible / visible and editable) whether the comment manually added by the teacher is visible and editable by the current user.
	; marks : (hidden / max available only / actual mark and max / actual mark and max with explanation ) whether the student can see the number of marks available, and how many marks they got, and how much detail of the marking to display.
	~~; marks d.p. : (0 .. 7) how many decimal places marks are displayed to.~~
	~~; general feedback : (hidden / visible) whether the general feedback (same for all students) is visible.~~
	; response history : (hidden / visible) whether the list of steps the student went through to answer the question is displayed.		; response history : (hidden / visible) whether the list of steps the student went through to answer the question is displayed.

TimHunt: /* What are the parts of a question? */

2009-10-27T13:47:35Z

What are the parts of a question?

← Older revision		Revision as of 13:47, 27 October 2009
Line 129:		Line 129:
	# The options from the particular activity (whether any marks are available for this question, are students allowed to see their grades, how many decimal places to use to display grades, does this user have permission to make a manual comment ...)		# The options from the particular activity (whether any marks are available for this question, are students allowed to see their grades, how many decimal places to use to display grades, does this user have permission to make a manual comment ...)

	Also, we want different question type and interaction models to have the freedom to display whatever they like to the students, but we also want all the questions in a quiz to look ~~similar,~~ and ~~operate in a similar way~~, so the experience is not ~~unnecessarily~~ confusing.		Also, we want different question type and interaction models to have the freedom to display whatever they like to the students; but we also want all the questions in a quiz to look and behave consistently, so that the experience is not confusing.

	In ~~this~~ sketch, I try to summarise ~~what~~ a typical question ~~might look like~~. ~~That~~ is ~~what bits might be there~~. The flexibility comes from the question type or interaction model ~~controlling what goes~~ inside those bits. ~~Using annotation~~, ~~I indicate which display options control which bits~~ of the question ~~are visible~~.		In the sketch below, I try to summarise the bits that may be present in a typical question. If all questions can have these bits in this order, then that is probably enough consistency. The flexibility comes from allowing the question type or interaction model to put whatever it likes inside those bits.

			We can divide what you see when looking at a question is into three main parts:
			# Information (meta-data): Which question number this is, a summary of what state it is currently in, what grade you have got for it (or how many marks are available, if any), whether you have flagged it. This has a grey background in the sketch below.
			# The question and the response to it. This has a blue background in the sketch.
			# The outcome from submitting that response. This has a yellow background.

	[[Image:Parts of a question.png]]		[[Image:Parts of a question.png]]

	The full list of ~~display option settings~~ are:		The full list of options that control which of those bits are visible at any time are:

	; read-only: Whether the question just shows the response was already entered, or whether it gives controls to the user enter/change their response.		; read-only: Whether the question just shows the response was already entered, or whether it gives controls to the user enter/change their response.
Line 148:		Line 153:
	; response history : (hidden / visible) whether the list of steps the student went through to answer the question is displayed.		; response history : (hidden / visible) whether the list of steps the student went through to answer the question is displayed.

	These options are initially set by whatever it is that is using the question~~. For~~ example ~~they may initially be set by~~ the quiz. Then these options are modified by the interaction model~~, so the interaction model insures~~ that no feedback is displayed until the student has submitted ~~their~~ answer, ~~and~~ that after they have submitted their final answer, the question only appears in read-only mode~~, and so on.~~		These options are initially set by whatever it is that is using the question (for example the quiz will initialise them from the quiz settings). Then these options are modified by the interaction model. For example it should ensure that no feedback is displayed until the student has actually submitted an answer, or that after they have submitted their final answer, the question only appears in read-only mode.

	~~The major subdivision of what you see when looking at a question is into three parts:~~
	# Information (meta-data): Which question number this is, a summary of what state it is currently in, what grade you have got for it (or how many marks are available), whether you have flagged it. This has a grey background in the sketch.
	~~# The question and a the response to it. This has a blue background in the sketch.~~
	~~# The outcome from submitting that response. This has a yellow background~~.

	==Reorganise the code==		==Reorganise the code==

TimHunt: /* What are the parts of a question? */

2009-10-27T13:37:48Z

What are the parts of a question?

← Older revision		Revision as of 13:37, 27 October 2009
Line 133:		Line 133:
	In this sketch, I try to summarise what a typical question might look like. That is what bits might be there. The flexibility comes from the question type or interaction model controlling what goes inside those bits. Using annotation, I indicate which display options control which bits of the question are visible.		In this sketch, I try to summarise what a typical question might look like. That is what bits might be there. The flexibility comes from the question type or interaction model controlling what goes inside those bits. Using annotation, I indicate which display options control which bits of the question are visible.

	~~SKETCH~~: ~~TODO~~		[[Image:Parts of a question.png]]

	The full list of display option settings are:		The full list of display option settings are:

TimHunt: /* What are the parts of a question? */

2009-10-27T13:24:30Z

What are the parts of a question?

← Older revision		Revision as of 13:24, 27 October 2009
Line 127:		Line 127:
	# The interaction model (deferred feedback, interactive, CBM, ...)		# The interaction model (deferred feedback, interactive, CBM, ...)
	# What state the question is in (has the student answered yet, has it been graded, ...)		# What state the question is in (has the student answered yet, has it been graded, ...)
	# The options from the particular activity (are students allowed to see their grades, how many decimal places to use to display grades, does this user have permission to make a manual comment ...)		# The options from the particular activity (whether any marks are available for this question, are students allowed to see their grades, how many decimal places to use to display grades, does this user have permission to make a manual comment ...)

	Also, we want different question type and interaction models to have the freedom to display whatever they like to the students, but we also want all the questions in a quiz to look similar, and operate in a similar way, so the experience is not unnecessarily confusing.		Also, we want different question type and interaction models to have the freedom to display whatever they like to the students, but we also want all the questions in a quiz to look similar, and operate in a similar way, so the experience is not unnecessarily confusing.
Line 137:		Line 137:
	The full list of display option settings are:		The full list of display option settings are:

	~~public $markdp = 2~~;		; read-only: Whether the question just shows the response was already entered, or whether it gives controls to the user enter/change their response.
	~~public $~~flags ~~= QUESTION_FLAGSSHOWN~~;		; flags: (hidden / visible / visible and editable) this is the feature that lets students bookmark or flag a question in an attempt for later reference.
	~~public $readonly = false~~;		; specific feedback: (hidden / visible) feedback that relates to the particular response the student entered.
	~~public $feedback = false~~;		; correct response: (hidden / visible) whether the automatically generated message or other indication of the correct answer is visible.
	~~public $correctresponses = false~~;		; correctness: (hidden / visible) whether the automatically generated message 'Your answer was partially correct' or similar is visible.
	~~public $generalfeedback = false~~;		; manual comment: (hidden / visible / visible and editable) whether the comment manually added by the teacher is visible and editable by the current user.
	~~public $responses = true~~;		; marks : (hidden / max available only / actual mark and max / actual mark and max with explanation ) whether the student can see the number of marks available, and how many marks they got, and how much detail of the marking to display.
	~~public $~~marks ~~= true;~~		; marks d.p. : (0 .. 7) how many decimal places marks are displayed to.
	~~public $history = false~~;		; general feedback : (hidden / visible) whether the general feedback (same for all students) is visible.
	~~public $manualcommentlink = false~~; /~~/ Set~~ to ~~base URL for true~~.		; response history : (hidden / visible) whether the list of steps the student went through to answer the question is displayed.

	These options are initially set by whatever it is that is using the question. For example they may be set by the quiz. Then these options are modified by the interaction model, so the interaction model insures that no feedback is displayed until the student has submitted their answer, and that after they have submitted their final answer, the question only appears in read-only mode.		These options are initially set by whatever it is that is using the question. For example they may initially be set by the quiz. Then these options are modified by the interaction model, so the interaction model insures that no feedback is displayed until the student has submitted their answer, and that after they have submitted their final answer, the question only appears in read-only mode, and so on.

			The major subdivision of what you see when looking at a question is into three parts:
			# Information (meta-data): Which question number this is, a summary of what state it is currently in, what grade you have got for it (or how many marks are available), whether you have flagged it. This has a grey background in the sketch.
			# The question and a the response to it. This has a blue background in the sketch.
			# The outcome from submitting that response. This has a yellow background.

	==Reorganise the code==		==Reorganise the code==

TimHunt: /* Clarifying question states */

2009-10-27T11:09:55Z

Clarifying question states

← Older revision		Revision as of 11:09, 27 October 2009
Line 120:		Line 120:
	(+Correctness, +Richness).		(+Correctness, +Richness).


			==What are the parts of a question?==

			When we come to think of outputting a question on-screen, we can now see that there there are several things that affect what it will look like:
			# The question type (multichoice, shortanswer, essay, ...)
			# The interaction model (deferred feedback, interactive, CBM, ...)
			# What state the question is in (has the student answered yet, has it been graded, ...)
			# The options from the particular activity (are students allowed to see their grades, how many decimal places to use to display grades, does this user have permission to make a manual comment ...)

			Also, we want different question type and interaction models to have the freedom to display whatever they like to the students, but we also want all the questions in a quiz to look similar, and operate in a similar way, so the experience is not unnecessarily confusing.

			In this sketch, I try to summarise what a typical question might look like. That is what bits might be there. The flexibility comes from the question type or interaction model controlling what goes inside those bits. Using annotation, I indicate which display options control which bits of the question are visible.

			SKETCH: TODO

			The full list of display option settings are:

			public $markdp = 2;
			public $flags = QUESTION_FLAGSSHOWN;
			public $readonly = false;
			public $feedback = false;
			public $correctresponses = false;
			public $generalfeedback = false;
			public $responses = true;
			public $marks = true;
			public $history = false;
			public $manualcommentlink = false; // Set to base URL for true.

			These options are initially set by whatever it is that is using the question. For example they may be set by the quiz. Then these options are modified by the interaction model, so the interaction model insures that no feedback is displayed until the student has submitted their answer, and that after they have submitted their final answer, the question only appears in read-only mode.

	==Reorganise the code==		==Reorganise the code==

TimHunt: /* Delegate to a remote system */

2009-10-20T13:31:48Z

Delegate to a remote system

← Older revision		Revision as of 13:31, 20 October 2009
Line 75:		Line 75:
	The Opaque question type from contrib, which is used to run both OpenMark and [http://stack.bham.ac.uk/ STACK] questions inside a Moodle quiz was very difficult to implement within the current code. Since the remote system controls the flow of the question, it makes sense to use a custom Interaction model for this question type, and that will be possible in the new code.		The Opaque question type from contrib, which is used to run both OpenMark and [http://stack.bham.ac.uk/ STACK] questions inside a Moodle quiz was very difficult to implement within the current code. Since the remote system controls the flow of the question, it makes sense to use a custom Interaction model for this question type, and that will be possible in the new code.

			===Information item===

			Used for descriptions. There is no grade. Item gets marked as complete after the student has seen it once. Displays general feedback after the attempt is over.

	===Missing===		===Missing===

TimHunt: /* Delegate to a remote system */

2009-10-13T09:40:36Z

Delegate to a remote system

← Older revision		Revision as of 09:40, 13 October 2009
Line 74:		Line 74:

	The Opaque question type from contrib, which is used to run both OpenMark and [http://stack.bham.ac.uk/ STACK] questions inside a Moodle quiz was very difficult to implement within the current code. Since the remote system controls the flow of the question, it makes sense to use a custom Interaction model for this question type, and that will be possible in the new code.		The Opaque question type from contrib, which is used to run both OpenMark and [http://stack.bham.ac.uk/ STACK] questions inside a Moodle quiz was very difficult to implement within the current code. Since the remote system controls the flow of the question, it makes sense to use a custom Interaction model for this question type, and that will be possible in the new code.


			===Missing===

			This is like the Missing question type. This interaction model is used in the situation:
			# Admin installs some interaction model.
			# Student attempts quiz using that model.
			# Admin uninstalls that model.
			# Teacher tries to review that student's attempt.
			The missing question interaction model does the best job it can to allow the review of the attempt with the missing model, while displaying an on-screen warning.