Difference between revisions of "Autonomous solution sketch Flash Applet Sample Problem"

From WeBWorK_wiki
Jump to navigation Jump to search
Line 285: Line 285:
 
|- style=" background-color:#ccffff;"
 
|- style=" background-color:#ccffff;"
 
| <pre>
 
| <pre>
###################################
 
# Configure applet
 
###################################
 
# configuration consists of
 
# hintState, question type, and
 
# random seed, and x-coordinates of
 
# four points where jumps,
 
# discontinuities or cusps
 
# occur.
 
$applet->configuration(qq{<xml>
 
<hintState>$hintState</hintState>
 
<qtype>limits</qtype>
 
<seed>$problemSeed</seed>
 
<xlist x1='$x1' x2='$x2'
 
x3='$x3' x4='$x4' /></xml>});
 
$applet->initialState(qq{<xml>
 
<hintState>$hintState</hintState>
 
<qtype>limits</qtype>
 
<seed>$problemSeed</seed>
 
<xlist x1='$x1' x2='$x2'
 
x3='$x3' x4='$x4' /></xml>});
 
   
TEXT( MODES(TeX=>'object code',
 
HTML=>$applet->insertAll(
 
debug=>0,
 
includeAnswerBox=>0,
 
)));
 
 
TEXT(MODES(TeX=>"", HTML=><<'END_TEXT'));
 
<input type="hidden"
 
name="func" id="func" />
 
<input type="hidden"
 
name="llimit" id="llimit" />
 
<input type="hidden"
 
name="rlimit" id="rlimit" />
 
<input type="hidden"
 
name="limit" id="limit" />
 
END_TEXT
 
 
$answerString1 =
 
$inputs_ref->{func};
 
my $correctAnswer1 =
 
Compute("$answerString1");
 
 
$answerString2 =
 
$inputs_ref->{rlimit};
 
my $correctAnswer2 =
 
Compute("$answerString2");
 
 
$answerString3 =
 
$inputs_ref->{llimit};
 
my $correctAnswer3 =
 
Compute("$answerString3");
 
 
$answerString4 =
 
$inputs_ref->{limit};
 
my $correctAnswer4 =
 
Compute("$answerString4");
 
   
   
 
</pre>
 
</pre>
| <p> The lines <code>$applet->configuration</code>
 
  +
| <p>
<code>(qq{<xml><hintState>$hintState</hintState></code>
 
<code><qtype>$qtype</qtype></code>
 
<code><seed>$problemSeed</seed></code>
 
<code><xlist x1='$x1' x2='$x2'</code>
 
<code> x3='$x3' x4='$x4' /></code>
 
<code></xml>});</code> and <code>$applet</code>
 
<code>->initialState</code><code>(qq{<xml></code>
 
<code><hintState>$hintState</hintState></code>
 
<code><qtype>$qtype</qtype></code><code><seed>$problemSeed</seed></code>
 
<code><xlist x1='$x1' x2='$x2'</code><code> x3='$x3' x4='$x4' /></code>
 
<code></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><br>
 
<p>
 
The hidden form fields are created in the code block:
 
<code>
 
TEXT(MODES(TeX=>"", HTML=><<'END_TEXT'));
 
<input type="hidden"</code>
 
<code> name="func" id="func" /></code>
 
<code>
 
<input type="hidden"</code>
 
<code> name="llimit" id="llimit" /></code>
 
<code>
 
<input type="hidden"</code>
 
<code> name="rlimit" id="rlimit" /></code>
 
<code>
 
<input type="hidden"</code>
 
<code> name="limit" id="limit" /></code>
 
<code>
 
END_TEXT
 
</code>
 
The line <code>TEXT(MODES(TeX=>"", HTML=><<'END_TEXT'));</code>
 
prevents the hidden fields from becoming part of the hard copy.
 
</p><br>
 
 
<p>
 
<code>TEXT( MODES(TeX=>'object code',</code>
 
<code> HTML=>$applet->insertAll(</code>
 
<code>
 
debug=>0,</code>
 
<code>
 
includeAnswerBox=>0,</code>
 
<code>
 
reinitialize_button=>$permissionLevel>=10,</code>
 
<code>
 
)));</code> actually embeds the applet
 
in the WeBWorK problem.
 
</p><br>
 
<p>When the submit button is pressed, the
 
hidden form fields defined in this block are
 
filled with information from the applet.
 
 
</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>
 
<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>
 
 
|- style=" background-color:#ccffff;"
 
|- style=" background-color:#ccffff;"
 
| <pre>
 
| <pre>

Revision as of 10:00, 10 August 2013

Flash Applets embedded in WeBWorK questions Autonomous solution sketch Example

Sample Problem with sketch_3.swf embedded

This sample problem shows how to use this versatile applet.

This applet and WeBWorK problem are based upon work supported by the National Science Foundation under Grant Number DUE-0941388.

Click here to see a problem like this in action: [1]

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. A screenshot of the applet embedded in this WeBWorK problem is shown below:
Sketch WWprob.png
There are other problems using applets:
Derivative Graph Matching Flash Applet Sample Problem
GraphSketch Flash Applet Sample Problem 1
USub Applet Sample Problem
trigwidget Applet Sample Problem
solidsWW Flash Applet Sample Problem 1
solidsWW Flash Applet Sample Problem 2
solidsWW Flash Applet Sample Problem 3
Hint Applet (Trigonometric Substitution) Sample Problem
phasePortrait Flash Applet Sample Problem 1
Other useful links:
Flash Applets Tutorial
Things to consider in developing WeBWorK problems with embedded Flash applets

PG problem file Explanation
##DESCRIPTION
##  Sketch autonomous solutions to polynomial differential equation
##ENDDESCRIPTION

##KEYWORDS('logistic', 'population')

## DBsubject('Differential Equations')
## DBchapter('Introduction')
## DBsection('Autonomous Differential Equations')
## Date('8/9/2013')
## Author('L. Felipe Martins')
## Author('Barbara Margolius')
## Institution('Cleveland State University')
## TitleText1('Differential Equations')
## EditionText1('2')
## AuthorText1('Ricardo')
## Chapter('1')
## Problem1('1_1')
###########################################
# 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();      

loadMacros(
   "PGstandard.pl",     # Standard macros for PG language
   "MathObjects.pl",
   "parserPopUp.pl",
   "AppletObjects.pl",
   "AnswerFormatHelp.pl",
   "PGasu.pl",
);

sub BPINK { 
  MODES(TeX => '{\\color{pink} ', HTML => '<span style="color:pink">'); 
};
sub EPINK { 
  MODES( TeX => '}', HTML => '</span>'); 
};
sub BBLUE { 
  MODES(TeX => '{\\color{blue} ', HTML => '<span style="color:blue">'); 
};
sub EBLUE { 
  MODES( TeX => '}', HTML => '</span>'); 
};
sub BYELLOW { 
  MODES(TeX => '{\\color{yellow} ', HTML => '<span style="color:yellow">'); 
};
sub EYELLOW { 
  MODES( TeX => '}', HTML => '</span>'); 
};

# Print problem number and point value (weight) for the problem
TEXT(beginproblem());

# Show which answers are correct and which ones are incorrect
$showPartialCorrectAnswers = 1;

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.

##############################################################
#
#  Setup
#
#
Context("Numeric");
Context()->variables->add(y=>"Real");
$a = -random(1,4,1);
$expr = Formula("y*(y+$a)")->reduce();
$ymax = Compute("-$a+4");

$I1=Compute("(-infinity,0)");
$I2=Compute("(0,-$a)");
$I3=Compute("(-$a,infinity)");
$cup = Compute("(0,-$a/2)U(-$a,infinity)");
$cdown = Compute("(-infinity,0)U(-$a/2,-$a)");
$lim1 = Compute("0");
$popup1 = PopUp(["?", "extinction", "equilibrium", 
   "explosive growth"], "extinction");
$popup2 = PopUp(["?", "extinction", "equilibrium", 
   "explosive growth"], "explosive growth");
$popup3 = PopUp(["?", "extinction", "equilibrium", 
   "explosive growth"], "equilibrium");

$inc = Compute("$I1 U $I3");

$lim2 = Compute("infinity");

$boardMessage = "Sketch three solutions to this 
   differential equation using the information 
   given in the problem.";
# applet adds a point for each error it detects.  
# It records 100 if the graphs are not drawn
$ans = Compute("0");

#+++++++++++++++++++++++++++++++++++++++++++++
# Designate characteristics of pink curve
# min is IC, max is ymax; concave up on ($IC,ymax); 
# increasing on ($IC,ymax)
# note intervals are in y not t
$pinkICy = Compute("-$a+1");
$pinkIntervalsIncLow = $pinkICy;
$pinkIntervalsIncHigh = $ymax;
$pinkIntervalsCupLow = $pinkICy;
$pinkIntervalsCupHigh = $ymax;
$pinkMin = $pinkICy;
#+++++++++++++++++++++++++++++++++++++++++++++
# Designate characteristics of blue curve
# min is IC, max is ymax; concave down on (0,$IC); 
# decreasing on (0,$IC) 
# note intervals are in y not t
$blueICy = Compute("-$a/2");
$blueIntervalsDecLow = 0;
$blueIntervalsIncHigh = $blueICy;
$blueIntervalsCupLow = 0;
$blueIntervalsCupHigh = $blueICy;
$blueMax = $blueICy;
$blueMin = 0;
#+++++++++++++++++++++++++++++++++++++++++++++
# Designate characteristics of blue curve
# min is IC, max is IC; horizontal line
# note intervals are in y not t
$yellowICy = Compute("-$a");
$yellowMax = $yellowICy;
$yellowMin = $yellowICy;

The sketch_3.swf applet requires the student to sketch three solution curves. The problem author specifies initial conditions, intervals of increase, intervals of decrease, intervals of concavity, and the maximum and minimum possible values of the curves.

###################################
# Create  link to applet 
###################################
    $appletName = "sketch_3";
    $applet =  FlashApplet(
       codebase              => findAppletCodebase("$appletName.swf"),
       appletName            => $appletName,
       appletId              => $appletName,
       setStateAlias         => 'setXML',
       getStateAlias         => 'getXML',
       setConfigAlias        => 'setConfig',
       getConfigAlias        => 'getConfig',
       maxInitializationAttempts => 5,   # number of attempts to initialize applet
       answerBoxAlias        => 'answerBox',
       height                => '500',
       width                 => '650',
       bgcolor               => '#ededed',
       debugMode             =>  0,
       submitActionScript  =>  
  qq{getQE("answerBox").value=getApplet("$appletName").getAnswer() },
     );

This is the Applet link section of the problem.


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

$config_string = <<"ENDCONFIG";
<XML>
    <boardMessage>$boardMessage</boardMessage>
    <xmin>0</xmin><xmax>13</xmax><ymin>-2</ymin><ymax>$ymax</ymax>
    <depVar>y</depVar><indVar>t</indVar>
    <showSolution>false</showSolution>
    <blueIntervalsCup>
      <interval left='0' right='$blueICy'></interval></blueIntervalsCup>
    <blueIntervalsDec>
      <interval left='0' right='$blueICy'></interval>
    </blueIntervalsDec>
    <pinkIntervalsInc>
      <interval left='$pinkICy' right='$ymax'></interval>
    </pinkIntervalsInc>
    <pinkIntervalsCup>
      <interval left='$pinkICy' right='$ymax'></interval>
    </pinkIntervalsCup>
    <blueMax>$blueMax</blueMax>
    <blueMin>$blueMin</blueMin>
    <pinkMin>$pinkMin</pinkMin>
    <yellowMin>$yellowMin</yellowMin>
    <yellowMax>$yellowMax</yellowMax>
    <pinkICy>$pinkICy</pinkICy>
    <blueICy>$blueICy</blueICy>
    <yellowICy>$yellowICy</yellowICy>
    <pinkMaxX>0.2</pinkMaxX>
</XML>
ENDCONFIG

$applet->configuration($config_string);
$applet->initialState($config_string);

The XML here conveys to the applet what each curve should look like. The code <pinkMaxX>0.2</pinkMaxX> specifies that the pink curve should cover at least 20% of the domain. The default is 100% and so is not specified for the blue or yellow curves which should go all the way across the graph.





TEXT(MODES(TeX=>"", HTML=><<'END_TEXT'));
<script>
if (navigator.appVersion.indexOf("MSIE") > 0) {
    document.write("<div width='3in' 
    align='center' style='background:yellow'>
    You seem to be using Internet Explorer.
    <br/>It is recommended that another 
    browser be used to view this page.</div>");
}
</script>
END_TEXT

The text between the <script> tags detects whether the student is using Internet Explorer. If the student is using this browser, a warning is issued and the student is advised to use another browser. IE mis-sizes the applets. Some will work correctly when displayed at the wrong size, but others will fail. We do not recommend using IE with WeBWorK problems with Flash embedded.

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.