Difference between revisions of "Trigwidget Applet Sample Problem"

From WeBWorK_wiki
Jump to navigation Jump to search
Line 169: Line 169:
 
Those portions of the code that begin the line with <code>#</code> are comments and can be omitted or replaced with comments appropriate to your particular problem.
 
Those portions of the code that begin the line with <code>#</code> are comments and can be omitted or replaced with comments appropriate to your particular problem.
 
</p>
 
</p>
<p>You must include the section that follows <code># Create link to applet</code>. If you are embedding a different applet, from the Graph_Limit applet, put your applet name in place of 'Graph_Limit' in the line <code>$appletName = "Graph_Limit";</code>. Enter the height of the applet in the line <code>height => '475',</code> in place of 475 and the width in the line <code>width => '425',</code> in place of 425.
+
<p>You must include the section that follows <code># Create link to applet</code>. If you are embedding a different applet, from the trigwidget applet, put your applet name in place of 'trigwidget' in the line <code>$appletName = "trigwidget";</code>. Enter the height of the applet in the line <code>height => '700',</code> in place of 700 and the width in the line <code>width => '1100',</code> in place of 1100.
 
</p><br>
 
</p><br>
<p> The lines <code>$applet->configuration(qq{<xml><hintState>$hintState</hintState><qtype>$qtype</qtype><seed>$problemSeed</seed><xlist x1='$x1' x2='$x2' x3='$x3' x4='$x4' /></xml>});</code> and <code>$applet->initialState(qq{<xml><hintState>$hintState</hintState><qtype>$qtype</qtype><seed>$problemSeed</seed><xlist x1='$x1' x2='$x2' x3='$x3' x4='$x4' /></xml>});</code> configure the applet. The configuration of the applet is done in xml. The hintState is set to the variable <code>$hintState</code>, the question type is set to <code>$qtype</code> and the problem seed is the WeBWorK environmental variable <code>$problemSeed</code>. The variables <code>$x1</code>, <code>$x2</code>, <code>$x3</code> and <code>$x4</code> are also passed to the applet.
 
  +
<p> The lines <code>$applet->configuration(qq{<XML><stat success="0"/></XML>});</code> and <code>$applet->initialState(qq{<XML><stat success="0"/></XML>});</code> configure the applet. The only information here is that the applet initially has not been completed. Compare this with some of the other Flash applet embedded WeBWorK problems: [[GraphLimit Flash Applet Sample Problem]]<br>
  +
[[GraphLimit Flash Applet Sample Problem 2]]<br>
  +
[[Derivative Graph Matching Flash Applet Sample Problem]]<br>
  +
[[USub Applet Sample Problem]] which set several variables to configure the applet.
 
</p><br>
 
</p><br>
<p>The code <code>qq{ </code><code>
+
<p>The code <code>qq{getQE("answerBox").value=getApplet("$appletName").getAnswer() }</code>
getQE("func").value=getApplet("$appletName").getf_list($x1,"function");</code><code>
+
is called when the 'Submit Answers' button in the problem is pressed. The applet saves any work that has been done to the point when the 'Submit Answers' button was pressed and checks to see if the applet is done.</p>
getQE("rlimit").value=getApplet("$appletName").getf_list($x2,"rightlimit");</code><code>
+
<br>
getQE("llimit").value=getApplet("$appletName").getf_list($x3,"leftlimit");</code><code>
+
<p> The lines
getQE("limit").value=getApplet("$appletName").getf_list($x4,"limit");</code><code>
 
}</code>
 
is called when the 'Submit Answers' button in the problem is pressed. There is an external interface function designed inside the applet. The function name is 'getf_list'. These lines of code call the function with javascript. <code>getf_list</code>, takes two arguments: the x-coordinate of a point, and a string value. The string may be any of the following four alternatives: "function", "rightlimit", "leftlimit", "limit". <code>getf_list</code> returns either the value of the function at the x-coordinate, or the specified limit. The line <code>
 
getQE("func").value=getApplet("$appletName").getf_list($x1,"function");</code> gets the value of the function at <code>$x1</code> and stores this value in the hidden javascript form field named "func".</p>
 
<p>
 
The hidden form fields are created in the code block:
 
<code>
 
BEGIN_TEXT</code><code>
 
<input type="hidden" name="func" id="func" /></code><code>
 
<input type="hidden" name="llimit" id="llimit" /></code><code>
 
<input type="hidden" name="rlimit" id="rlimit" /></code><code>
 
<input type="hidden" name="limit" id="limit" /></code><code>
 
END_TEXT
 
</code>
 
</p><br>
 
<p>
 
The applet is configured in the code line:
 
<code>$applet->configuration(qq{<xml><hintState>$hintState</hintState><qtype>limits</qtype>
 
<seed>$problemSeed</seed><xlist x1='$x1' x2='$x2' x3='$x3' x4='$x4' /></xml>});</code> and the similar line below it.
 
The variables $hintState, $problemSeed, and $x1, $x2, $x3, and $x4 are defined within WeBWorK and used by the applet to set the problem up.
 
</p><br>
 
<p>
 
 
<code>TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
 
<code>TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
 
debug=>0,
 
debug=>0,
Line 182: Line 185:
 
reinitialize_button=>$permissionLevel>=10,
 
reinitialize_button=>$permissionLevel>=10,
 
)));</code> actually embeds the applet in the WeBWorK problem.
 
)));</code> actually embeds the applet in the WeBWorK problem.
</p><br>
+
<br>
<p>When the submit button is pressed, the hidden form fields defined in this block are filled with information from the applet.
+
actually insert the applet in the WeBWorK problem.
 
</p>
 
</p>
<p>
 
The data from the hidden form fields is used in these simple perl subroutines to define the correct answers to the four questions that are part of this WeBWorK problem.</p><br>
 
<p>The WeBWorK variable $answerString1 is the content of the hidden form field "func". $correctAnswer1 is the solution to the first question. The solutions for the next two questions are defined in a similar way. The final question also has 'DNE' as a possible correct answer for the student to enter. The way that the applet is designed, the left and right limits always exist.</p>
 
 
</td>
 
</td>
 
</tr>
 
</tr>

Revision as of 15:39, 26 July 2011

Flash Applets embedded in WeBWorK questions trigwidget Example

Sample Problem with trigwidget.swf embedded

This sample problem shows how to use the trigwidget applet.

A standard WeBWorK PG file with an embedded applet has six sections:

  1. A tagging and description section, that describes the problem for future users and authors,
  2. An initialization section, that loads required macros for the problem,
  3. A problem set-up section that sets variables specific to the problem,
  4. An Applet link section that inserts the applet and configures it, (this section is not present in WeBWorK problems without an embedded applet)
  5. A text section, that gives the text that is shown to the student, and
  6. An answer and solution section, that specifies how the answer(s) to the problem is(are) marked for correctness, and gives a solution that may be shown to the student after the problem set is complete.

The sample file attached to this page shows this; below the file is shown to the left, with a second column on its right that explains the different parts of the problem that are indicated above. Two screenshots of the applet embedded in this WeBWorK problem are shown below:
Trigwidget1.jpg
The screenshot above shows the applet with just a few of the label cards in place. The student must drag the labels of the basic angles into position in order for the axis labels and the labels on the unit circle to appear. The student can turn one of the label cards over by clicking the down arrow after clicking the card. The reverse side of the card provides a decimal approximation in place of the exact value on its flip side.
Trigwidget2.jpg
The screen shot above shows the applet more nearly complete. All of the labels are in place, but very few of the cosine, sine and tangent cards have been placed. The WeBWorK problem only gives credit when the entire table is completed, but it will save the student's progress if the 'Submit answer' button is pressed. It is not possible to place a card incorrectly, however, cards must be close to the correct location to snap into place.
There are other example problems using applets:
GraphLimit Flash Applet Sample Problem
GraphLimit Flash Applet Sample Problem 2
Derivative Graph Matching Flash Applet Sample Problem
USub Applet Sample Problem

PG problem file Explanation
##DESCRIPTION
##  Trigonometry review 
##ENDDESCRIPTION

##KEYWORDS('trigonometry', 'basic angles')

## DBsubject('Calculus')
## DBchapter('Review')
## DBsection('Trigonometry')
## Date('7/11/2011')
## Author('Barbara Margolius')
## Institution('Cleveland State University')
## TitleText1('')
## EditionText1('2011')
## AuthorText1('')
## Section1('')
## Problem1('')

########################################################################
# This work is supported in part by the National Science Foundation 
# under the grant DUE-0941388.
########################################################################

This is the tagging and description section of the problem. Note that any line that begins with a "#" character is a comment for other authors who read the problem, and is not interpreted by WeBWorK.

The description is provided to give a quick summary of the problem so that someone reading it later knows what it does without having to read through all of the problem code.

All of the tagging information exists to allow the problem to be easily indexed. Because this is a sample problem there isn't a textbook per se, and we've used some default tagging values. There is an on-line list of current chapter and section names and a similar list of keywords. The list of keywords should be comma separated and quoted (e.g., KEYWORDS('calculus','derivatives')).

DOCUMENT();        # This should be the first executable line in the problem.

loadMacros(
  "PGbasicmacros.pl",
  "extraAnswerEvaluators.pl",
  "AppletObjects.pl",
); 

This is the initialization section of the problem. The first executed line of the problem must be the DOCUMENT(); command. Note that every command must end with a semicolon.

The loadMacros command loads information that works behind the scenes. For our purposes we can usually just load the macros shown here and not worry about things further.

# Set up problem
TEXT(beginproblem());
$showPartialCorrectAnswers = 1;
Context("Numeric"); 

$ans =Compute("1");

This is the problem set-up section of the problem.

The trigwidget.swf applet is either completed or not. The applet returns a "1" when the student has completed the work and pressed the "Submit answer" button. Note that any work is lost if the student does not press the "Submit answer" button even if the applet has been completed.

###################################
# Create  link to applet 
###################################
    $appletName = "trigwidget";
    $applet =  FlashApplet(
       codebase              => findAppletCodebase("$appletName.swf"),
       appletName            => $appletName,
       appletId              => $appletName,
       setStateAlias         => 'setXML',
       getStateAlias         => 'getXML',
       setConfigAlias        => 'setConfig',
       getConfigAlias        => 'getConfig',
       #initializeActionAlias => 'setXML',
       maxInitializationAttempts => 5,   # number of attempts to initialize applet
       #submitActionAlias     =>  'getXML',
       answerBoxAlias        => 'answerBox',
       height                => '700',
       width                 => '1100',
       bgcolor               => '#ffffff',
       debugMode             =>  0,
       submitActionScript  =>  
  qq{getQE("answerBox").value=getApplet("$appletName").getAnswer() },
     );
###################################
# Configure applet
###################################
 
    #no initialization data
    $applet->configuration(qq{<XML><stat success="0"/></XML>});
    #no initialization data
    $applet->initialState(qq{<XML><stat success="0"/></XML>});

TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
  debug=>0,
  includeAnswerBox=>1,
#   reinitialize_button=>$permissionLevel>=10,
   )));

This is the Applet link section of the problem.


Those portions of the code that begin the line with # are comments and can be omitted or replaced with comments appropriate to your particular problem.

You must include the section that follows # Create link to applet. If you are embedding a different applet, from the trigwidget applet, put your applet name in place of 'trigwidget' in the line $appletName = "trigwidget";. Enter the height of the applet in the line height => '700', in place of 700 and the width in the line width => '1100', in place of 1100.


The lines $applet->configuration(qq{<XML><stat success="0"/></XML>}); and $applet->initialState(qq{<XML><stat success="0"/></XML>}); configure the applet. The only information here is that the applet initially has not been completed. Compare this with some of the other Flash applet embedded WeBWorK problems: GraphLimit Flash Applet Sample Problem
GraphLimit Flash Applet Sample Problem 2
Derivative Graph Matching Flash Applet Sample Problem
USub Applet Sample Problem which set several variables to configure the applet.


The code qq{getQE("answerBox").value=getApplet("$appletName").getAnswer() } is called when the 'Submit Answers' button in the problem is pressed. The applet saves any work that has been done to the point when the 'Submit Answers' button was pressed and checks to see if the applet is done.


The lines TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll( debug=>0, includeAnswerBox=>0, reinitialize_button=>$permissionLevel>=10, ))); actually embeds the applet in the WeBWorK problem.
actually insert the applet in the WeBWorK problem.

BEGIN_TEXT

$BR
The graph shown is for the function \(f(x)\).  
$BR Compute the following quantities:
$BR
a)
\(f($x1)=\)
\{ans_rule(35) \}
$BR
b)
\(\lim_{x\to {$x2}^+}f(x)=\)
\{ans_rule(35) \}

$BR
c)
\(\lim_{x\to {$x3}^-}f(x)=\)
\{ans_rule(35) \}

$BR
d)
\(\lim_{x\to {$x4}}f(x)=\)
\{ans_rule(35) \}

$BR
END_TEXT
Context()->normalStrings;

This is the text section of the problem. The TEXT(beginproblem()); line displays a header for the problem, and the Context()->texStrings line sets how formulas are displayed in the text, and we reset this after the text section. Everything between the BEGIN_TEXT and END_TEXT lines (each of which must appear alone on a line) is shown to the student.

Mathematical equations are delimited by \( \) (for inline equations) or \[ \] (for displayed equations); in these contexts inserted text is assumed to be TeX code.

There are a number of variables that set formatting: $PAR is a paragraph break (like \par in TeX). This page gives a list of variables like this. Finally, \{ \} sets off code that will be executed in the problem text. Here, ans_rule(35) is a function that inserts an answer blank 35 characters wide.

##############################################################
#
#  Answers
#
## answer evaluators

ANS( $correctAnswer1->cmp() );   #checks AnSwEr00001
ANS( $correctAnswer2->cmp() );   #checks AnSwEr00002
ANS( $correctAnswer3->cmp() );   #checks AnSwEr00003
ANS(num_cmp($correctAnswer4,strings=>['DNE']));   #checks AnSwEr00004


ENDDOCUMENT();     

This is the answer section of the problem. The problem answer is set by the ANS( $correctAnswer1->cmp() );, ANS( $correctAnswer2->cmp() );, ANS( $correctAnswer3->cmp() );, and ANS(num_cmp($correctAnswer4,strings=>['DNE'])); lines. These compare the student's answer with the answers returned from the applet. Answers 1-3 follow the same basic structure. The fourth answer allows for either a numeric answer or the string 'DNE' for limits that do not exist.

The solution is embedded in the applet and becomes available when the due date has passed.

The ENDDOCUMENT(); command is the last command in the file.