Things to consider in developing WeBWorK problems with embedded Flash applets

From WeBWorK
(Difference between revisions)
Jump to: navigation, search
 
Line 13: Line 13:
 
[http://creativecommons.org/licenses/by-nc/3.0/ Creative Commons Attribution-NonCommercial 3.0 Unported License].
 
[http://creativecommons.org/licenses/by-nc/3.0/ Creative Commons Attribution-NonCommercial 3.0 Unported License].
  
 
{|style=" background-color:#ffffff;" cellpadding="10" cellspacing="0" border="1"
 
! scope="col"  width="50%"| PG problem file
 
! scope="col"  width="50%"| Explanation
 
|- style=" background-color:#ddddff;"
 
| <pre>
 
 
##DESCRIPTION
 
##  understanding derivatives graphically
 
##ENDDESCRIPTION
 
 
##KEYWORDS('derivatives', 'graph')
 
 
## DBsubject('Calculus')
 
## DBchapter('Limits and Derivatives')
 
## DBsection('Derivatives')
 
## Date('7/25/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.
 
###################################################
 
</pre>
 
|
 
<p>
 
This is the <strong>tagging and description</strong> section of the problem.  Note that any line that begins with a "#" character is a <em>comment</em> for other authors who read the problem, and is not interpreted by WeBWorK. 
 
</p>
 
<p>
 
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.
 
</p>
 
<p>
 
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
 
[http://hobbes.la.asu.edu/Holt/chaps-and-secs.html list of current chapter and section names] and a similar
 
[http://hobbes.la.asu.edu/Holt/keywords.html list of keywords].  The list of keywords should be comma separated and quoted (e.g., KEYWORDS('calculus','derivatives')).
 
</p>
 
|- style=" background-color:#ddffdd;"
 
| <pre>
 
DOCUMENT();     
 
 
loadMacros(
 
"PGanswermacros.pl",
 
  "PGstandard.pl",
 
  "AppletObjects.pl",
 
  "MathObjects.pl",
 
);
 
</pre>
 
| <p>
 
This is the <strong>initialization section</strong> of the problem.  The first executed line of the problem <strong>must</strong> be the <code>DOCUMENT();</code> command.  Note that every command <em>must end with a semicolon</em>.
 
</p>
 
<p>
 
The <code>loadMacros</code> 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.
 
</p>
 
|- style=" background-color:#ffffdd;"
 
| <pre>
 
# Set up problem
 
TEXT(beginproblem());
 
$showPartialCorrectAnswers = 1;
 
Context("Numeric");
 
 
$ans =Compute("1");
 
 
$showSolution = 0;
 
if(time>$dueDate){
 
  $showSolution = 1;
 
}
 
 
$isit2der = 1; #match first and second derivatives
 
</pre>
 
| <p>
 
This is the <strong>problem set-up section</strong> of the problem. 
 
</p>
 
<p>
 
The derGraphMatchWW.swf applet requires the student to match three sets of graphs.  If <code>$isit2der</code> is set to zero, the student must match three pairs of graphs of functions and their derivatives.  If <code>$isit2der</code> is set to one, the student must match three triples of graphs of functions and their first and second derivatives.  The screenshot above shows the applet with <code>$isit2der=1</code>.  <code>$showSolutions</code> is turned on when the due date is passed.  The solutions are shown within the applet.  The problem author can add some explanatory text in the pg file.  The applet shows the graphs in the correct positions with shading turned on so that the student can see the function is concave up where its derivative is increasing and the second derivative is positive.
 
</p>
 
|- style=" background-color:#ccffff;"
 
| <pre>
 
###################################
 
# Create  link to applet
 
###################################
 
    $appletName = "derGraphMatchWW";
 
    $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                => '600',
 
      width                => '550',
 
      bgcolor              => '#ffffff',
 
      debugMode            =>  0,
 
      submitActionScript  => 
 
  qq{getQE("answerBox").value=getApplet("$appletName").getAnswer() },
 
    );
 
###################################
 
# Configure applet
 
###################################
 
 
#initialization data - problem setup
 
#  $problemSeed - random seed used to setup problem
 
#  $isit2der - set to 1 if student must match function
 
#            to first and second derivate
 
#          - set to 0 if student must match function
 
#            to first derivative
 
#  $showSolution - set to 1 if $dueDate is passed, 0 otherwise
 
#  success - 0 if work not complete yet
 
 
$applet->configuration(qq{<xml><seed>$problemSeed</seed><isit2der>$isit2der</isit2der>
 
<showSolution>$showSolution</showSolution><stat success="0"/></xml>});
 
$applet->initialState(qq{<xml><seed>$problemSeed</seed><isit2der>$isit2der</isit2der>
 
<showSolution>$showSolution</showSolution><stat success="0"/></xml>});
 
 
 
TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
 
  debug=>0,
 
  includeAnswerBox=>1,
 
#  reinitialize_button=>$permissionLevel>=10,
 
  )));
 
</pre>
 
| <p>
 
This is the <strong>Applet link section</strong> of the problem. 
 
</p><br>
 
<p>
 
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>You must include the section that follows <code># Create  link to applet</code>.  If you are embedding a different applet, from the derGraphMatchWW applet, put your applet name in place of 'derGraphMatchWW' in the line <code>$appletName = "derGraphMatchWW";</code>.  Enter the height of the applet in the line <code>height => '600',</code> in place of 600 and the width in the line  <code>width => '550',</code> in place of 550.
 
</p><br>
 
<p>  The lines <code>$applet->configuration(qq{<xml><seed>$problemSeed</seed><isit2der>$isit2der</isit2der>
 
<showSolution>$showSolution</showSolution><stat success="0"/></xml>});
 
</code> and <code>$applet->initialState(qq{<xml><seed>$problemSeed</seed><isit2der>$isit2der</isit2der>
 
<showSolution>$showSolution</showSolution><stat success="0"/></xml>});</code> configure the applet.  The configuration of the applet is done in xml.  The <code>$showSolution</code> variable is set zero initially and to one after the due date, the problem seed is the WeBWorK environmental variable <code>$problemSeed</code>. Success is set to zero until the student solves the problem.  <code>$isit2der</code> records whether the student is to match one or two derivatives.  If <code>$isit2der=1</code>, then the student must match the graph of the function with the graphs of its first two derivatives.
 
</p><br>
 
<p>The code <code>qq{getQE("answerBox").value=getApplet("$appletName").getAnswer()}</code>
 
is called when the 'Submit Answers' button in the problem is pressed.  This code queries the applet as to whether the student has succeeded in matching the graphs.  A "1" is returned if the graphs are matched. "0" is returned otherwise.</p>
 
<br>
 
<p>
 
<code>TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
 
  debug=>0,
 
  includeAnswerBox=>0,
 
reinitialize_button=>$permissionLevel>=10,
 
  )));</code> actually embeds the applet in the WeBWorK problem.
 
</p><br>
 
<p>When the submit button is pressed the work in the applet is checked via the WeBWorK answer checker.
 
</p>
 
|- style=" background-color:#ffdddd;"
 
|  <pre>
 
BEGIN_TEXT
 
 
$BR
 
 
 
$BR Put the tiles into place, then press 'submit answers'.
 
 
END_TEXT
 
Context()->normalStrings;
 
</pre>
 
| <p>
 
This is the <strong>text section</strong> of the problem.  The <code>TEXT(beginproblem());</code> line displays a header for the problem, and the <code>Context()-&gt;texStrings</code> line sets how formulas are displayed in the text, and we reset this after the text section.  Everything between the <code>BEGIN_TEXT</code> and <code>END_TEXT</code> lines (each of which must appear alone on a line) is shown to the student.
 
</p>
 
<p>
 
Since the student answers the question within the applet, no answer blank is provided here.
 
</p>
 
|- style=" background-color:#eeccff;"
 
|  <pre>
 
##############################################################
 
#
 
#  Answers
 
#
 
## answer evaluators
 
 
NAMED_ANS('answerBox'=>$ans->cmp());
 
 
 
ENDDOCUMENT();   
 
</pre>
 
| <p>
 
This is the <strong>answer</strong> section of the problem.  The pg file compares the answer returned from the applet (either a "0" or a "1") to the correct answer (a "1") and grades the question accordingly.
 
</p>
 
<p>
 
The solution is embedded in the applet and becomes available when the due date has passed.
 
</p>
 
<p>
 
The <code>ENDDOCUMENT();</code> command is the last command in the file.
 
</p>
 
|}
 
 
Useful links:
 
Useful links:
 
[[GraphLimit Flash Applet Sample Problem]]<br>
 
[[GraphLimit Flash Applet Sample Problem]]<br>

Latest revision as of 10:09, 10 August 2011

Contents

Applets in the body of a WeBWorK problem

Where is the solution computed?

In WeBWorK

In the applet

Applets in Hints and Solutions

For many types of problems, you may not need an applet in the main part of the problem, but you may want to use one to provide the student with a hint or to help the student understand the solution.
Sinxoverx.jpg


The Flash applets are protected under the following license: Creative Commons Attribution-NonCommercial 3.0 Unported License.

Useful links: GraphLimit Flash Applet Sample Problem
GraphLimit Flash Applet Sample Problem 2
Derivative Graph Matching Flash Applet Sample Problem
trigwidget Applet Sample Problem
uSub Applet Sample Problem

follow us