View source for GraphSketch Flash Applet Sample Problem 2

== Flash Applets embedded in WeBWorK questions GraphSketch Example ==

<h2>Sample Problem with graphSketch.swf embedded</h2>
<p style="background-color:#eeeeee;border:black solid 1px;padding:3px;">
<em>This sample problem shows how to use this versatile applet.</em>
</p>
<p>
A standard WeBWorK PG file with an embedded applet has six sections:
</p>
<ol>
<li> A <em>tagging and description section</em>, that describes the problem for future users and authors,</li>
<li> An <em>initialization section</em>, that loads required macros for the problem,</li>
<li> A <em>problem set-up section</em> that sets variables specific to the problem,</li>
<li> An <em>Applet link section</em> that inserts the applet and configures it, (this section is not present in WeBWorK problems without an embedded applet)</li>
<li> A <em>text section</em>, that gives the text that is shown to the student, and</li>
<li> An <em>answer and solution section</em>, 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. </li>
</ol>
<p>
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:<br>
[[File:GraphSketch2.jpg]]
<br>
There are other example problems using this applet:  <br>
[[GraphSketch Flash Applet Sample Problem 1]]<br>
[[GraphSketch Flash Applet Sample Problem 3]]<br>
And other problems using applets:<br>
[[Derivative Graph Matching Flash Applet Sample Problem]]<br>
[[USub Applet Sample Problem]]<br>
[[trigwidget Applet Sample Problem]]<br>
[[solidsWW Flash Applet Sample Problem 1]]<br>
[[solidsWW Flash Applet Sample Problem 2]]<br>
[[solidsWW Flash Applet Sample Problem 3]]<br>
[[Hint Applet (Trigonometric Substitution) Sample Problem]]<br>
Other useful links:<br>
[[Flash Applets Tutorial]]<br>
[[Things to consider in developing WeBWorK problems with embedded Flash applets]]
</p>

{| style=" background-color:#ffffff;" cellpadding="5" 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','Flash applets','NSF-0941388')

## DBsubject('Calculus')
## DBchapter('Limits and Derivatives')
## DBsection('Derivatives')
## Date('6/12/2012')
## Author('Barbara Margolius')
## Institution('Cleveland State University')
## TitleText1('')
## EditionText1('2012')
## 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(
  "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");

$pos = 2; #don't care whether positive or negative
$inc = 1; #function should be decreasing
$cup = 0; #don't care whether concave up or down

$boardMessage = "Sketch a function with a positive 
first derivative and negative second derivative.";

$showMM = 'false';   # don't display x and y ranges
</pre>
| <p>
The graphSketch.swf applet will accept settings for whether the function is to be positive or negative, increasing or decreasing, or concave up or concave down.  A setting of '1' indicates it must have this behavior, a setting of '0' indicates it must have the opposite of this behavior and a setting of '2' indicates that this behavior is not required.  <code>$pos = 2</code> indicates we don't care whether the function is positive or negative.  <code>$inc=1</code> indicates the function must be increasing. <code>$cup=0</code> indicates the function must be concave down.   <code>$boardMessage</code> is a pg variable that places a message to the student in the applet generally used to tell them what kind of function to draw.  It is a good idea to also provide this information in the pg file text area since help within the applet is context sensitive and the message will not display at all times.
</p>
<p>
<code>$showMM = 'false';</code> tells the applet to suppress display of the minimum and maximum values for x and y within the graph window.  This information is usually not needed to sketch the type of function specified.  The x- and y-ranges are fixed from -5 to 5.  Display of the ranges may be helpful if the student is asked to sketch a curve through a given point.  This behavior is described in another graphSketch example.
</p>
|- style=" background-color:#ccffff;"
| <pre>
###################################
# Create  link to applet 
###################################
    $appletName = "graphSketch";
    $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                => '550',
       width                 => '550',
       bgcolor               => '#ededed',
       debugMode             =>  0,
       submitActionScript  =>  
  qq{getQE("answerBox").value=getApplet("$appletName").getAnswer() },
     );
</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>
|- style=" background-color:#ccffff;"
| <pre>
###################################
# Configure applet
###################################
 
#initialization data - problem setup
#  $pos - 0 to require negative function
#	  1 to require positive function
#         2 to not require the function to 
#           be either positive or negative
#  $inc - 0 to require decreasing function
#	  1 to require increasing function
#         2 to not require the function to 
#           be either increasing or decreasing
#  $cup - 0 to require concave down function
#	  1 to require concave up function
#         2 to not require the function to 
#           be either concave up or concave down
#  the student can also be required to have the 
#  curve go through one or two points.  Syntax is
#  <pts><pt xval='1' yval='2' showIt='true'/></pts> 
#  to display the point (1,2) and require the 
#  function to go through it
#  
#   $boardMessage - instructions to 
#           display in applet.
#   $showMM - displays x and y ranges.  
#           Not usually needed.  Might be 
#           helpful if curve is to go through 
#           particular points.

</pre>
| <p>You must include the section that 
follows <code># Create  link to 
applet</code>.  If you are embedding 
a different applet, from the graphSketch 
applet, put your applet name in place of 
'graphSketch' in the line <code>$appletName =</code>
<code> "graphSketch";</code>.  
Enter the height of the applet 
in the line <code>height => '550',</code> 
in place of 550 and the width in the line  
<code>width => '550',</code> in place of 550.
</p><br>

|- style=" background-color:#ccffff;"
| <pre>
$applet->configuration(qq{<xml>
   <pos>$pos</pos><inc>$inc</inc>
   <cup>$cup</cup>
   <boardMessage>$boardMessage</boardMessage>
   <showMM>$showMM</showMM>
   <bland>true</bland></xml>});
$applet->initialState(qq{<xml>
   <pos>$pos</pos><inc>$inc</inc>
   <cup>$cup</cup>
   <boardMessage>$boardMessage</boardMessage>
   <showMM>$showMM</showMM>
   <bland>true</bland></xml>});;

TEXT( MODES(TeX=>'object code', 
  HTML=>$applet->insertAll(
  debug=>0,
  includeAnswerBox=>0,
   )));
END_TEXT

</pre>
| <p>  The lines <code>$applet->configuration</code>
<code>(qq{<xml><pos>$pos</pos></code>
<code><inc>$inc</inc></code>
<code><cup>$cup</cup></code>
<code><boardMessage>$boardMessage</boardMessage></code>
<code><showMM>$showMM</showMM></code>
<code><bland>true</bland></xml></xml>});</code> and <code>$applet</code>
<code>->initialState</code><code>(qq{<xml></code>
<code>(qq{<xml><pos>$pos</pos></code>
<code><inc>$inc</inc></code>
<code><cup>$cup</cup></code>
<code><boardMessage>$boardMessage</boardMessage></code>
<code><showMM>$showMM</showMM></code>
<code><bland>true</bland></xml></xml>});</code> configure the applet.  
The configuration of the applet is done in xml.  
<code>$pos</code>, <code>$inc</code>, and <code>$cup</code>,
variables are explained above.  
</p><br>
END_TEXT
</code>
</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>
|- style=" background-color:#ccffff;"
| <pre>
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
</pre>
| <p>
The text between the <code><script></code> 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.  Older versions of 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.</p>
|- style=" background-color:#ffdddd;"
| <pre>
BEGIN_TEXT

$BR  $boardMessage

$BR Press 'score' to check your work.  
When it is correct, press 'submit answers'.  

$BR  If your graph is close to correct 
(not much marked red) pressing the 'SMOOTH' 
button may help.

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.  
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>
|- 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 applet returns a value of '1' if 
the students sketch is close enough.  The sketch will
appear in the applet with the incorrect areas marked in red.  
The screenshot shows a correct sketch.  The smooth button 
was used to get the curve to be as smooth as it is.  The 
applet displays the word success several places across the screen
if the student's sketch is close enough.  Some red markings
may still appear if it is a small portion of the sketch.  The
student will still need to press 'submit answers' to get 
credit.
</p>

<p>
The <code>ENDDOCUMENT();</code> command is the 
last command in the file.
</p>
|}
== License ==

The Flash applets developed under DUE-0941388 are protected under the following license:  
[http://creativecommons.org/licenses/by-nc/3.0/ Creative Commons Attribution-NonCommercial 3.0 Unported License].

[[Category:Sample Problems]]
[[Category:Applets]]
[[Category:Problem_Techniques]]
[[Category:Flash Applets]]