Difference between revisions of "SampleProblem1"
(New page: <h2>A First WeBWorK Sample Problem</h2> <p style="backgroundcolor:#eeeeee;border:black solid 1px;padding:3px;"> <em>This sample problem shows the basic structure of a WeBWorK PG problem f...) 
(Update BEGIN_SOLUTION syntax) 

(14 intermediate revisions by 8 users not shown)  
Line 24:  Line 24:  
<td style="backgroundcolor:#ddddff;border:black 1px dashed;"> 
<td style="backgroundcolor:#ddddff;border:black 1px dashed;"> 

<pre> 
<pre> 

−  +  # DESCRIPTION 

−  +  # A simple sample problem that asks students to 

−  +  # differentiate a trigonometric function. 

−  +  # WeBWorK problem written by Gavin LaRose, 

−  +  # <glarose(at)umich(dot)edu> 

−  +  # ENDDESCRIPTION 

−  +  ## DBsubject('WeBWorK') 

−  +  ## DBchapter('Demos') 

−  +  ## DBsection('Problem') 

−  +  ## KEYWORDS('') 

−  +  ## TitleText1('') 

−  +  ## EditionText1('') 

−  +  ## AuthorText1('') 

−  +  ## Section1('') 

−  +  ## Problem1('') 

−  +  ## Author('Gavin LaRose') 

−  +  ## Institution('UMich') 

</pre> 
</pre> 

</td> 
</td> 

Line 54:  Line 54:  
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 online 
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 online 

[http://hobbes.la.asu.edu/Holt/chapsandsecs.html list of current chapter and section names] and a similar 
[http://hobbes.la.asu.edu/Holt/chapsandsecs.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')). 
+  [http://hobbes.la.asu.edu/Holt/keywords.html list of keywords], as well as a page of [[Tagging_Problemsbest practices for tagging problems]]. The list of keywords should be comma separated and quoted (e.g., <code>KEYWORDS('calculus','derivatives')</code>). 
</p> 
</p> 

</td> 
</td> 

Line 61:  Line 61:  
<td style="backgroundcolor:#ddffdd;border:black 1px dashed;"> 
<td style="backgroundcolor:#ddffdd;border:black 1px dashed;"> 

<pre> 
<pre> 

−  +  DOCUMENT(); 

−  +  loadMacros( 

−  +  "PGstandard.pl", 

−  +  "MathObjects.pl", 

−  +  "PGcourse.pl", 

−  +  ); 

</pre> 
</pre> 

</td> 
</td> 

Line 81:  Line 81:  
<td style="backgroundcolor:#ffffdd;border:black 1px dashed;"> 
<td style="backgroundcolor:#ffffdd;border:black 1px dashed;"> 

<pre> 
<pre> 

−  +  # make sure we're in the context we want 

−  +  Context("Numeric"); 

−  +  $a = random(2,9,1); 

−  +  $trigFunc = Formula("sin($a x)"); 

−  +  $trigDeriv = $trigFunc>D(); 

</pre> 
</pre> 

</td> 
</td> 

Line 101:  Line 101:  
<td style="backgroundcolor:#ffdddd;border:black 1px dashed;"> 
<td style="backgroundcolor:#ffdddd;border:black 1px dashed;"> 

<pre> 
<pre> 

−  +  TEXT(beginproblem()); 

−  +  Context()>texStrings; 

−  +  BEGIN_TEXT 

−  +  Find the derivative of the function \(f(x) = $trigFunc\). 

−  +  $PAR 

−  +  \(\frac{df}{dx} = \) \{ ans_rule(35) \} 

−  +  END_TEXT 

−  +  Context()>normalStrings; 

</pre> 
</pre> 

<td style="backgroundcolor:#ffcccc;padding:7px;"> 
<td style="backgroundcolor:#ffcccc;padding:7px;"> 

<p> 
<p> 

−  This is the <strong>text section</strong> of the problem. The <code>TEXT( 
+  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()>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> 

<p> 
<p> 

−  Mathematical equations are delimited by <code>\( 
+  Mathematical equations are delimited by <code class="tex2math_ignore">\( \)</code> (for inline equations) or <code class="tex2math_ignore">\[ \]</code> (for displayed equations); in these contexts inserted text is assumed to be TeX code. 
</p> 
</p> 

<p> 
<p> 

There are a number of variables that set formatting: <code>$PAR</code> is a paragraph break (like <code>\par</code> in TeX). 
There are a number of variables that set formatting: <code>$PAR</code> is a paragraph break (like <code>\par</code> in TeX). 

−  [[FormatVariableListThis page]] gives a list of variables like this. Finally, <code>\{ \}</code> sets off <em>code that will be executed in the problem text</em>. Here, <code>ans_rule(35)</code> is a function that inserts an answer blank 35 characters 
+  [[FormatVariableListThis page]] gives a list of variables like this. Finally, <code>\{ \}</code> sets off <em>code that will be executed in the problem text</em>. Here, <code>ans_rule(35)</code> is a function that inserts an answer blank 35 characters wide. 
</p> 
</p> 

</td> 
</td> 

Line 126:  Line 126:  
<td style="backgroundcolor:#eeddff;border:black 1px dashed;"> 
<td style="backgroundcolor:#eeddff;border:black 1px dashed;"> 

<pre> 
<pre> 

−  +  ANS( $trigDeriv>cmp() ); 

−  +  Context()>texStrings; 

−  +  BEGIN_SOLUTION 

−  +  We find the derivative to this using the 

−  +  chain rule. The inside function is \($a x\), 

−  +  so that its derivative is \($a\), and the 

−  +  outside function is \(\sin(x)\), which has 

−  +  derivative \(\cos(x)\). Thus the solution is 

−  +  \[ \frac{d}{dx} $trigFunc = $trigDeriv. \] 

−  +  END_SOLUTION 

−  +  Context()>normalStrings; 

−  Context()>normalStrings; 

−  +  ENDDOCUMENT(); 

</pre> 
</pre> 

<td style="backgroundcolor:#eeccff;padding:7px;"> 
<td style="backgroundcolor:#eeccff;padding:7px;"> 

Line 146:  Line 146:  
</p> 
</p> 

<p> 
<p> 

−  Then, we explain the solution to the student. This solution will show up when the student clicks 
+  Then, we explain the solution to the student. This solution will show up when the student clicks "show solution" after they've finished the problem set. 
</p> 
</p> 

<p> 
<p> 

Line 154:  Line 154:  
</tr> 
</tr> 

</table> 
</table> 

+  
+  [[Category:Sample Problems]] 
Latest revision as of 11:40, 15 June 2021
A First WeBWorK Sample Problem
This sample problem shows the basic structure of a WeBWorK PG problem file and how it is constructed.
A standard WeBWorK PG file has five sections:
 A tagging and description section, that describes the problem for future users and authors,
 An initialization section, that loads required macros for the problem,
 A problem setup section that sets variables specific to the problem,
 A text section, that gives the text that is shown to the student, and
 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.
PG problem file  Explanation 

# DESCRIPTION # A simple sample problem that asks students to # differentiate a trigonometric function. # WeBWorK problem written by Gavin LaRose, # <glarose(at)umich(dot)edu> # ENDDESCRIPTION ## DBsubject('WeBWorK') ## DBchapter('Demos') ## DBsection('Problem') ## KEYWORDS('') ## TitleText1('') ## EditionText1('') ## AuthorText1('') ## Section1('') ## Problem1('') ## Author('Gavin LaRose') ## Institution('UMich') 
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 online
list of current chapter and section names and a similar
list of keywords, as well as a page of best practices for tagging problems. The list of keywords should be comma separated and quoted (e.g., 
DOCUMENT(); loadMacros( "PGstandard.pl", "MathObjects.pl", "PGcourse.pl", ); 
This is the initialization section of the problem. The first executed line of the problem must be the
The 
# make sure we're in the context we want Context("Numeric"); $a = random(2,9,1); $trigFunc = Formula("sin($a x)"); $trigDeriv = $trigFunc>D(); 
This is the problem setup section of the problem.
The bulk of the setup section defines variables that we use in the rest of the problem. All scalar variables are prefaced with a dollar sign: thus 
TEXT(beginproblem()); Context()>texStrings; BEGIN_TEXT Find the derivative of the function \(f(x) = $trigFunc\). $PAR \(\frac{df}{dx} = \) \{ ans_rule(35) \} END_TEXT Context()>normalStrings; 
This is the text section of the problem. The
Mathematical equations are delimited by
There are a number of variables that set formatting: 
ANS( $trigDeriv>cmp() ); Context()>texStrings; BEGIN_SOLUTION We find the derivative to this using the chain rule. The inside function is \($a x\), so that its derivative is \($a\), and the outside function is \(\sin(x)\), which has derivative \(\cos(x)\). Thus the solution is \[ \frac{d}{dx} $trigFunc = $trigDeriv. \] END_SOLUTION Context()>normalStrings; ENDDOCUMENT(); 
This is the answer and solution section of the problem. The problem answer is set by the Then, we explain the solution to the student. This solution will show up when the student clicks "show solution" after they've finished the problem set.
The 