[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex BridgeTask_Conditions.tex BridgeTask_EditMode.tex BridgeTask_EditModeFinishing.tex BridgeTask_EditModeIntroduction.tex BridgeTask_EditModeQuestion.tex BridgeTask_EditModeVariable.tex BridgeTask_Slot.tex BridgeTask_XML.tex BridgeTask_XMLFinishing.tex BridgeTask_XMLQuestions.tex BridgeTask_XMLVariable.tex

rezaferry lon-capa-cvs-allow@mail.lon-capa.org
Wed, 30 May 2007 15:35:15 -0000


This is a MIME encoded message

--rezaferry1180539315
Content-Type: text/plain

rezaferry		Wed May 30 11:35:15 2007 EDT

  Added files:                 
    /loncom/html/adm/help/tex	BridgeTask_Conditions.tex 
                             	BridgeTask_EditMode.tex 
                             	BridgeTask_EditModeFinishing.tex 
                             	BridgeTask_EditModeIntroduction.tex 
                             	BridgeTask_EditModeQuestion.tex 
                             	BridgeTask_EditModeVariable.tex 
                             	BridgeTask_XMLFinishing.tex 
                             	BridgeTask_XMLQuestions.tex 

  Modified files:              
    /loncom/html/adm/help/tex	BridgeTask_Slot.tex BridgeTask_XML.tex 
                             	BridgeTask_XMLVariable.tex 
  Log:
  Changed Bridge Task help files. Final version
  
  
--rezaferry1180539315
Content-Type: text/plain
Content-Disposition: attachment; filename="rezaferry-20070530113515.txt"

Index: loncom/html/adm/help/tex/BridgeTask_Slot.tex
diff -u loncom/html/adm/help/tex/BridgeTask_Slot.tex:1.1 loncom/html/adm/help/tex/BridgeTask_Slot.tex:1.2
--- loncom/html/adm/help/tex/BridgeTask_Slot.tex:1.1	Thu May 10 11:14:02 2007
+++ loncom/html/adm/help/tex/BridgeTask_Slot.tex	Wed May 30 11:35:14 2007
@@ -1,5 +1,5 @@
 \label{BridgeTask_Slot}
 
-To restrict the when and where BT's can be taken, the slots feature of Lon-Capa is used. Slots allow the instructors to specify the room, the time, the students that can take the Bridge Tasks, and finally any proctors that will authenticate the students.
+To restrict when and where BTs can be taken, the slots feature of Lon-Capa is used. Slots allow the instructors to specify the room, the time, the students that can take the Bridge Tasks, and finally any proctors that will authenticate the students.
 
 For information about creating slots see the section on Slots (\ref{Slot_About}).
Index: loncom/html/adm/help/tex/BridgeTask_XML.tex
diff -u loncom/html/adm/help/tex/BridgeTask_XML.tex:1.1 loncom/html/adm/help/tex/BridgeTask_XML.tex:1.2
--- loncom/html/adm/help/tex/BridgeTask_XML.tex:1.1	Thu May 10 11:14:02 2007
+++ loncom/html/adm/help/tex/BridgeTask_XML.tex	Wed May 30 11:35:14 2007
@@ -8,7 +8,7 @@
 \begin{itemize}
 \item The header, which contains information about the file itself. The header can be copied from this documentation as is (see .Task Headers \ref{BridgeTask_XMLHeader})
 \item Parameter information. This part consists of the possible values for various parameters in the Bridge Task (see .Task Parameter and Variable \ref{BridgeTask_XMLVariable})
-\item Questions section. This part consists of the actual text the user sees as well as all criteria and questions (see .Task Question \ref{BridgeTask_XMLQuestion})
+\item Questions section. This part consists of the actual text the user sees as well as all criteria and questions (see .Task Question \ref{BridgeTask_XMLQuestions})
 \item Footer section. This part consists of the actual text the user sees as well as all criteria and questions (see .Task Finishing Up  \ref{BridgeTask_XMLFinishing})
 \end{itemize}
 
Index: loncom/html/adm/help/tex/BridgeTask_XMLVariable.tex
diff -u loncom/html/adm/help/tex/BridgeTask_XMLVariable.tex:1.1 loncom/html/adm/help/tex/BridgeTask_XMLVariable.tex:1.2
--- loncom/html/adm/help/tex/BridgeTask_XMLVariable.tex:1.1	Thu May 10 11:14:02 2007
+++ loncom/html/adm/help/tex/BridgeTask_XMLVariable.tex	Wed May 30 11:35:14 2007
@@ -18,11 +18,11 @@
 <!-- The parameters for this instance -->
 <InstanceText>
 	<script type='loncapa/perl'>
-	/* The first line must be the instance id */
-	$entitySubject{instance} = "instanceHarry";
-	/* The two parameters. Personname = Harry and place=zoo */	
-	$entitySubject{personname} = "Harry";	
-	$entitySubject{place} = "zoo";	
+		/* The first line must be the instance id */
+		$entitySubject{instance} = "instanceHarry";
+		/* The two parameters. Personname = Harry and place=zoo */	
+		$entitySubject{personname} = "Harry";	
+		$entitySubject{place} = "zoo";	
 	</script>
 
 </InstanceText>
@@ -35,11 +35,10 @@
 <!-- The parameters for this instance -->
 <InstanceText>
 	<script type='loncapa/perl'>
-	/* The first line must be the instance id */
-$entitySubject{instance} = "instanceBetty";	
-	/* The two parameters. Personname = Betty and place=park */	$entitySubject{personname} = "Betty";	
-	$entitySubject{place} = "park";	
-
+		/* The first line must be the instance id */
+		$entitySubject{instance} = "instanceBetty";	
+		/* The two parameters. Personname = Betty and place=park */	$entitySubject{personname} = "Betty";	
+		$entitySubject{place} = "park";	
 	</script>
 </InstanceText>
 </Instance>
@@ -54,7 +53,8 @@
 The first instance of this variable is shown from lines 2 to 10. Line two $<$Instance OptionalRequired="0" id="instanceHarry"$>$ marks the beginning of the instance element named instanceHarry (based on the id attribute). The OptionalRequired is given a value of 0. Lines 3-9 determine the actual value of this variable. Lines 3 and 4 must be typed as shown. Lines 5-7 define the instance properties, which must be of the form \$ $<$variable\_name$>$ \{$<$property\_name$>$ \} = $<$value$>$. The first line of the property must be the instance property (see line 5 of example), with the value being the id of the instance. Other lines (6-7) can be used for any attributes you wish to define. The closing $<$/script$>$, $<$/InstanceText$>$ and $<$/Instance$>$ tags must be typed as shown.
 
 Line 12-21 shows the second instance with the same rules as the first instance. Line 23 $<$/Setup$>$ gives the closing Setup tag which must be as shown..
-The example of the usage of this variable inside the question is this text: :
+The example of the usage of this variable inside the question is this text: 
+
 This is a test question. \$entitySubject\{personname\}
  went to the \$entitySubject\{place\}. .
  

Index: loncom/html/adm/help/tex/BridgeTask_Conditions.tex
+++ loncom/html/adm/help/tex/BridgeTask_Conditions.tex
\label{BridgeTask_Conditions}

It is possible to configure bridge tasks such that only when a student passes a Bridge Task does the next Bridge Task appear to the student. This feature is useful in such cases as  Bridge Tasks are related to one another, and the results of one Bridge Task is needed for the next Bridge Task.    

To create configure bridge tasks these way, a sequence page must be created. A resource author starts at his/her construction space (Main menu: CSTR). Once in the construction space, the author create a new assembled sequence. See \ref{Creating_A_Course_Intro} for a more concise reference on condition and sequences. 

The author must create various conditionals to determine which resources to show. The easiest way to do this is by using advanced edit. The advanced edit visualizes the various conditions and resources. This interface needs popups, so make sure  popups are enabled in the browser.

In the main starting view of the advanced edit, there are two squares, marked start and end respectively. Start by creating a link between the start square and the end square. To do this click on the start square (on the row under the text start), select "Link Resource", then click on the end square. A link is now created between the start and the end boxes.

Once a link is created the author adds resources and conditions. Click on the link and then choose insert resource into link. This allows the placement of a resource such as a bridge task into the sequence. Once the resource is placed into the link, the author should create a mapalias. To do this, select the resource, then click on set parameters, and change the value of Custom Parameter to an alias. 

Under each square is an area of the same color as the square, these areas can be used to create conditionals to get to the next resource to the sequence. This document only discusses using conditionals to block access to the next resource (including Bridge Tasks).

Add conditionals by clicking on the area just under the squares. A popup window will appear with a condition box and some options. The condition box allows the author to enter a variety of different conditions. To block access to the next resource, select the second option "Blocking this link if false". 

The conditions used will be :
\begin{verbatim}
&EXT('user.resource.resource.0.awarded','<alias of resource>') eq '1'
\end{verbatim}
$<$alias of resource$>$ should be changed to the alias set for the previous resource that the student needs to pass before the next resource is unblocked. If the student has not passed a particular homework/problem/bridge task, the value of user.resource.resource.0.awarded is 0 otherwise the value is 1. This line checks whether the value of user.resource.resource.0.awarded for that resource is equals to 1, if not the link is blocked and the next resources are not shown to the user.

 

Index: loncom/html/adm/help/tex/BridgeTask_EditMode.tex
+++ loncom/html/adm/help/tex/BridgeTask_EditMode.tex
\label{BridgeTask_EditMode}

Another way of creating Bridge Task is via the edit mode. The edit mode allows authors to create resources (including Bridge Tasks) online. The basic idea of the this editor is the author inserts and deletes different section types into the file to build the bridge task.

If a task file has already been created, click on the file name followed by the "Edit" button to open the file in the colorful editor. 

If a task file needs to be created:
\begin{enumerate}
\item Enter the file name in the area "Create a new directory or LON-CAPA document" with the combo box at the left of this set to "New File". The file name must have a .task extension.
\item At the second screen, press continue to create a new task. At the third screen, select the blank task template and press the "Create task" button to create this blank task. 
\item To go into the the edit mode, press the "Edit" Button.
\end{enumerate}

The edit mode allows you to insert appropriate sections of a document at certain predetermined places. For example, in a bridge task document, you can insert a question section, a criteria section, and an introductory section. To insert a section, find a drop down box with the label "Insert", and select the section to insert. Then click on the "Submit Changes and Edit" button. The section you selected will be inserted in place of the pull down menu. 

Additional insert pull-downs will show up allowing you to insert sections before, inside, and after other sections. The choices on the pull down menu may differ depending on the location of the insert pull-down. For example, the insert pull down inside a question section contains question information; this option is not available anywhere else.

In the edit mode, you will see is an insert button and a optional task button. You will need to enter the number of optional tasks/questions that the student need to answer correctly to pass the bridge task. You can leave this field empty until after you have finished writing the whole bridge task.

This document discusses important sections needed to create a bridge task. These sections can be created in any order. 
\begin{enumerate}
\item The introductory and closing information \ref{BridgeTask_EditModeIntroduction}
\item Variables \ref{BridgeTask_EditModeVariable}
\item Question and criteria \ref{BridgeTask_EditModeQuestion}
\end{enumerate}

Once the document has been created, the author must publish the bridge task so it becomes available (See Edit Mode Finishing Up \ref{BridgeTask_EditModeFinishing})



Index: loncom/html/adm/help/tex/BridgeTask_EditModeFinishing.tex
+++ loncom/html/adm/help/tex/BridgeTask_EditModeFinishing.tex
\label{BridgeTask_EditModeFinishing}

Once the construction is complete, click on the "Submit Changes and View" button. Click on list to list the current author's directory. The author should now publish the file so that the domain coordinator will be able to use the file. To do this select publish (or re-publish) in the select action combo box next to the file name.

The LON CAPA interface allows you to view the bridge task from different point of views. You can see it from the student's view, the grader view, or the student's view after feedback. 
\begin{enumerate}
\item From the list of files authored, click on the bridge task that has just been created/edited. 
\item A pull-down menu with the label "Problem Status" is located just above the question. select "Answerable" to see the original view, "Criteria Grading"  to see a grader view, and "Show Feedback" to see the feedback view.
\item To see the feedback view properly, you must have graded the student with the grader view. 
\item Once you have graded using the feedback view however, the answerable view will be similar to the feedback view. To reset the view a "Reset Submissions" button is provided.
\end{enumerate}


Index: loncom/html/adm/help/tex/BridgeTask_EditModeIntroduction.tex
+++ loncom/html/adm/help/tex/BridgeTask_EditModeIntroduction.tex
\label{BridgeTask_EditModeIntroduction}

The introductory information and closing information are just text that are shown to the students but are not part of any questions. The introductory information should be placed at the beginning of the bridge task and the closing information should be placed at the end of the bridge task.

To insert these sections:
\begin{enumerate}
\item Select "Introductory Information" or "Closing Information" in the insert pull-down menu and press the submit button. 
\item A new section appears with a text box inside it. You may enter any text inside the text box and the text may be formatted with HTML tags. Everything inside the text box will be shown to the students as introductory or closing text.
\end{enumerate}



Index: loncom/html/adm/help/tex/BridgeTask_EditModeQuestion.tex
+++ loncom/html/adm/help/tex/BridgeTask_EditModeQuestion.tex
\label{BridgeTask_EditModeQuestion}

The task description should be divided into questions. Questions can also be divided into sub-questions. A question or sub-question must have one or more criteria that are the scoring rubrics used to evaluate that question.  A task may also have a criteria. Graders use these criteria to evaluate student work  Both questions and criteria are interspersed within the task description, placed where students see them when reviewing their graded bridge task.

\begin{figure}
\begin{center}\includegraphics[  width=0.80\paperwidth]{BT_ScreenshotQuestion}\end{center}

\caption{Bridge Task question creation screenshot\label{BTEdit_Question}}
\end{figure}

Figure \ref{BTEdit_Question} shows a screenshot of the question creation page. To create a question:
\begin{enumerate}
\item Select "Question" in the main insert pull-down (circled as 1). 
\item Press the submit changes and edit button. 
\item In this question create a unique id which can be any kind of text (in circle 3). 
\item Set whether a student must pass this question by setting the value of  "Passing is Mandatory" to "yes" (circle 4) or whether this question is optional by setting the value to "no". 
\item Set the number of optional subquestions/criteria that the students must get correct in order to pass this question. You can also wait until later to fill this in.
\item Create the question information by choosing Question information in the insert pull-down (circled as 2) and pressing the submit button. 
\item A text box should appear (circle 6) and you can insert any text in this text box. Anything that is typed in this text box will appear to the student as part of the question. HTML tags can also be used to format the text in the text box. Subquestions can be added by inserting a new question (circle 2).
\end{enumerate}

\begin{figure}
\begin{center}\includegraphics[  width=0.80\paperwidth]{BT_ScreenshotCriteria}\end{center}

\caption{Bridge Task criteria creation screenshot\label{BTEdit_Criteria}}
\end{figure}

To add a criteria (see Figure \ref{BTEdit_Criteria}):
\begin{enumerate}
\item Instead of choosing "Question" in the insert pull down, select "Question Criteria" (circled as 1). Pressing the submit button will bring up the Question criteria as well as the criteria information where you can write the criteria (Circled 3). The criteria is shown to the student only when the student is reading his/her feedback. The criteria is also shown to the grader in order for the grader to be able to grade the student submission.
\item In the criteria block, first create a unique id for this criteria (any text) (circle 1). 
\item Specify whether a criteria is mandatory or not, this is set in the Passing is mandatory pull-down similar to that of the question (circle 2). 
\item Text in the text block (circle 4) is shown as the criteria. The text can be formatted with HTML. 
\item You can also insert a grader note which will only be shown to the user. To do this select "Text to display to grader" in the insert pull down menu of circle number 3.
\end{enumerate}

 



Index: loncom/html/adm/help/tex/BridgeTask_EditModeVariable.tex
+++ loncom/html/adm/help/tex/BridgeTask_EditModeVariable.tex
\label{BridgeTask_EditModeVariable}

To create difference versions of Bridge Tasks for each student, parts of the questions are defined using variables. Each variable contains multiple instances of possible values and LON-CAPA randomly selects an instance to give to the student. Figure \ref{BTEdit_Variable} shows a screenshot of this process.

\begin{figure}
\begin{center}\includegraphics[  width=0.80\paperwidth]{BT_ScreenshotVariable}\end{center}

\caption{Bridge Task variable creation screenshot\label{BTEdit_Variable}}
\end{figure}

To create a variable:
\begin{enumerate}
\item Choose "Setup ..." in the insert pull-down menu (circled 1 in figure). \item Press the Submit Changes and Edit just above the work space. 
\item A new box should appear with the label "Setup ...". In this box, fill out the id box (circled 3) with any text that is unique to unique to the document. This id is the name of the variable and will be used when creating the values for the variable.
\item The setup box has an insert pull-down menu next to the label (circled 2), select "Specific Question Instance" in this pull down menu, then again press the Submit Changes and Edit button. 
\item This creates one single instance of a set of possible values. For each instance created, a new "Specific Question Instance" must be created. 
\item Right now a box should appear inside the "Setup... " box with the label "Specific Question Instance". Insert a unique id for that instance which can be any unique text (circled 4).  This id is the instance name and is used as one of the property of the variable.
\item In the question instance block, select "Information for the Instance" in the insert pull down (circled 5). Again press submit button. 
\item Add a new script (circled 6) in the insert pull down. A new text block should appear. 
\item In this text box, a perl script will be created (circled 7). A set of parameters for this variable is added. The syntax to set the parameter of a variable is '\$variableName \{fieldname\} = "fieldValue"'. The variable name is taken from the id field of the Setup block, thefield name is the name of the parameter the author sets, and the fieldValue is simply the value of the field. The first parameter that must be set is the instance field, with the value being an identifier of the instance (which is the id of the specific question instance block). 
\end{enumerate}

The example below shows two instances of this script for the variable entitySubject with two instances, 'instanceHarry' and 'instanceBetty'.

The first instance (instanceHarry) is:
\begin{verbatim}
	$entitySubject{instance} = "instanceHarry";	
	$entitySubject{personname} = "Harry";	
	$entitySubject{place} = "zoo";	
\end{verbatim}

The second instance (instanceBetty) is:
\begin{verbatim}
	$entitySubject{instance} = "instanceBetty";	
	$entitySubject{personname} = "Betty";	
	$entitySubject{place} = "park";
\end{verbatim}	

The example above describes a variable question. It has two different possible values for the entity "subject", Harry and zoo or Betty and park. Variables can be placed inside the questions by using the variable name and field name. 
The example of the usage of this variable inside the question is this text:

This is a test question. \$entitySubject\{personname\}
 went to the \$entitySubject\{place\}. .
 
The LON-CAPA engine will replace any instance of \$$<$variable\_name$>$ ($<$property\_name$>$) with the correct value, depending on the randomly chosen instance. 

Based on this code, two different questions are possible:
\begin{enumerate}
\item This is a test question. Harry went to the zoo
\item This is a test question. Betty went to the park
\end{enumerate}


Index: loncom/html/adm/help/tex/BridgeTask_XMLFinishing.tex
+++ loncom/html/adm/help/tex/BridgeTask_XMLFinishing.tex
\label{BridgeTask_XMLFinishing}

Once all questions are written, the file must be closed with the $<$/Task$>$ tag. The file must be saved with a .task extension then placed into a LON CAPA author's folder. To upload the file simply go to the construction space and simply upload the new file using the upload new document button. Once the file is uploaded to LON CAPA, the author can publish the file so that the domain coordinator will be able to use the file. To do this select publish (or re-publish) in the select action combo box next to the file name.

The LON CAPA interface allows you to view the bridge task from different point of views. You can see it from the student's view, the grader view, or the student's view after feedback:
\begin{enumerate}
\item From the list of files authored, click on the bridge task that has just been created/edited. A pull-down menu with the label "Problem Status" is located just above the question
\item Select "Answerable" to see the original view, "Criteria Grading"  to see a grader view, and "Show Feedback" to see the feedback view .To see the feedback view properly, you must have graded the student with the grader view. Once you have graded using the feedback view however, the answerable view will be similar to the feedback view. 
\item To reset the view a "Reset Submissions" button is provided.
\end{enumerate}


Index: loncom/html/adm/help/tex/BridgeTask_XMLQuestions.tex
+++ loncom/html/adm/help/tex/BridgeTask_XMLQuestions.tex
\label{BridgeTask_XMLQuestions}

The task description should be divided into questions. Questions can also be divided into sub-questions. A question or sub-question must have one or more criteria that are the scoring rubrics used to evaluate that question.  A task may also have a criteria. Graders use these criteria to evaluate student work  Both questions and criteria are interspersed within the task description, placed where students see them when reviewing their graded bridge task.

Questions are created by using the Question tag. Each question must have a unique id attribute which identifies the question, the value of the id attribute is any text that is unique in the document. Each question must also have the Mandatory attribute which can be set to "Y" if the question is mandatory or "N" otherwise. Finally the question may also have a OptionalRequired attribute, which determines how many optional criteria students must pass to pass the question. 

The question element will have the actual text of the question. The questions are created inside the QuestionText element. The question descriptions are placed inside the file by simply typing the text. The text can be marked up to have various formatting. The mark up language used is simple HTML.

Criteria are created using the Criteria tag. The attributes for the criteria tag are similar to the attributes for the questions tag. Criteria tags have id attributes as well as Mandatory attributes. Like for the question tag, the value of the id attribute is any text that is unique in the document, and the Mandatory attribute (values "Y" or "N") determines whether the criteria is mandatory or not. Criteria tags do not have OptionalRequired attributes. The criteria description is created inside the CriteriaText element and can be formatted the same way as the formatting of the questions (using HTML).

The following is an example of a question and criteria element. Question elements are placed inside the task element or inside other question elements. Text between $<!--$and $-->$ are comments and should not be typed into the editor. 

\begin{verbatim}
<!-- Beginning of question element with id q.testquestion. A mandatory question where the student must pass 1 optional question/criteria -->
<Question id='q.testquestion' Mandatory='Y' OptionalRequired='1'>
	<!--The text of the question -->
	<QuestionText>
		Some test explanation
			<!--A mandatory criteria with the id of 'criteria.overall.handin'. This criteria will not be shown to the student during the bridge task. It will be shown to the grader and on the student's feedback page -->
			<Criteria id='criteria.overall.handin' Mandatory='Y'>
				<!--The text of the criteria-->
				<CriteriaText>
			Criteria text 1
			<!--Grader Notes are not shown to the students at all -->
			<GraderNote> 
				This part cannot be seen by students but is used to give additional info to the grader to help evaluating the criteria.
					</GraderNote>
				</CriteriaText>
			</Criteria>
			<!--End of the criteria -->


			<!--An optional question named q.question1 -->
		<Question Mandatory='N' id='q.question1' OptionalRequired='0'>
				<QuestionText>
					The actual test question
					<!--A mandatory criteria -->
					<Criteria id='criteria.question1' Mandatory='Y'>
						<CriteriaText>
							Criteria text 2
						</CriteriaText>
			</Criteria>
				</QuestionText>
			</Question>
			<!--End of question q.question1-->

		
	<!--Some more question text -->
	Instructions to the student on submitting files
	</QuestionText>
</Question>
<!--End of question q.testquestion-->
\end{verbatim}

The question that the students will see is:

"Some test explanation\\
The actual test question\\
Instructions to the student on submitting files\\"

Any text inside a QuestionText element (lines 2, 14) and not inside a criteria element will be shown to the users. This example has one question, and one optional sub-question. The question element is given in line 1, the id of the question being 'q.testquestion', it is a mandatory question (Mandatory='Y') and it requires that 1 optional question/criteria be passed (OptionalRequired='1'). The sub-question is given in line 13, named 'q.question1', is not mandatory and has no optional questions or criteria that is required to be correctly answered.

The example above shows a code for the creation of criteria. There are 2 criteria in the above question (line 4 and 16). Each criteria has a name (criteria.question1 and criteria.overall.handin) which are both mandatory (the attribute Mandatory is set to 'Y'). The text of the criteria is given inside the CriteriaText element inside each CriteriaElement. The student will never see the criteria when the student is taking the test. The grader will see this on his/her screen:

"Criteria text 1. Grader Note: This part cannot be seen by the students but is used to give additional info to the grader to help evaluating the criteria.\\ 
 Pass 		 Fail\\
Comment:\\ \\ \\
Criteria text 2.\\
 Pass 		Fail \\
Comment:\\ \\ \\"

When the bridge task is graded the student will see both the questions and the criteria in his space. Anything inside the GraderNote element (line 7) is not shown to the student.

"Some test explanation\\
Criteria text 1\\
Pass\\
The actual test question\\
Criteria text 2.\\
Pass\\
Instructions to the student on submitting files\\
"


--rezaferry1180539315--