Difference between revisions of "SampleProblem4"
(Remove solution header in solution block, since this is now automatically inserted by WW) |
|||
(17 intermediate revisions by 5 users not shown) | |||
Line 2: | Line 2: | ||
<p style="background-color:#eeeeee;border:black solid 1px;padding:3px;"> |
<p style="background-color:#eeeeee;border:black solid 1px;padding:3px;"> |
||
<em>This sample problem illustrates the basics of how to use PGML commands to layout a question.</em> |
<em>This sample problem illustrates the basics of how to use PGML commands to layout a question.</em> |
||
+ | </p> |
||
+ | <p style="background-color:#eeeeee;border:black solid 1px;padding:3px;"> |
||
+ | This sample just scratches the surface of what is possible using these mark up commands. Page through the |
||
+ | [https://courses1.webwork.maa.org/webwork2/cervone_course/PGML-examples/?login_practice_user=true sample questions] |
||
+ | to see what can be done and click on the "show problem source" button to see how to accomplish it. |
||
</p> |
</p> |
||
<p> |
<p> |
||
Line 17: | Line 22: | ||
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. |
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. |
||
</p> |
</p> |
||
+ | |||
<table cellspacing="0" cellpadding="2" border="0"> |
<table cellspacing="0" cellpadding="2" border="0"> |
||
<tr valign="top"> |
<tr valign="top"> |
||
− | <th> |
+ | <th>PG problem file</th> |
− | <th> |
+ | <th>Explanation</th> |
</tr> |
</tr> |
||
+ | |||
+ | <!--================ Tagging ================--> |
||
+ | |||
<tr valign="top"> |
<tr valign="top"> |
||
<td style="background-color:#ddddff;border:black 1px dashed;"> |
<td style="background-color:#ddddff;border:black 1px dashed;"> |
||
Line 27: | Line 36: | ||
# DESCRIPTION |
# DESCRIPTION |
||
# A simple sample problem that asks students to |
# A simple sample problem that asks students to |
||
− | # differentiate a trigonometric function. |
||
+ | # enter a bunch of different types of answers |
||
# WeBWorK problem written by Gavin LaRose |
# WeBWorK problem written by Gavin LaRose |
||
# <glarose(at)umich(dot)edu> |
# <glarose(at)umich(dot)edu> |
||
− | # and modified by Mike Gage |
+ | # and modified by Mike Gage gage(at)math(dot)rochester(dot)edu |
# ENDDESCRIPTION |
# ENDDESCRIPTION |
||
Line 46: | Line 55: | ||
</pre> |
</pre> |
||
</td> |
</td> |
||
+ | |||
+ | <!---------------------------------------------> |
||
+ | |||
<td style="background-color:#ccccff; padding:7px;"> |
<td style="background-color:#ccccff; padding:7px;"> |
||
<p> |
<p> |
||
− | This is the <strong>tagging and description</strong> section of the problem. Note that any line that begins with a |
+ | This is the <strong>tagging and description</strong> section of the problem. Note that any line that begins with a <code>#</code> character is a <em>comment</em> for other authors who read the problem, and is not interpreted by WeBWorK. |
</p> |
</p> |
||
<p> |
<p> |
||
Line 56: | Line 68: | ||
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 |
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/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')). |
+ | [http://hobbes.la.asu.edu/Holt/keywords.html list of keywords], as well as a page of [[Tagging_Problems|best 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> |
||
</tr> |
</tr> |
||
+ | |||
+ | <!--================ Initialization ================--> |
||
+ | |||
<tr valign="top"> |
<tr valign="top"> |
||
<td style="background-color:#ddffdd;border:black 1px dashed;"> |
<td style="background-color:#ddffdd;border:black 1px dashed;"> |
||
Line 66: | Line 81: | ||
loadMacros( |
loadMacros( |
||
"PGstandard.pl", |
"PGstandard.pl", |
||
− | "PGML.pl", |
||
"MathObjects.pl", |
"MathObjects.pl", |
||
+ | "PGML.pl", |
||
"PGcourse.pl", |
"PGcourse.pl", |
||
); |
); |
||
</pre> |
</pre> |
||
</td> |
</td> |
||
+ | |||
+ | <!---------------------------------------------> |
||
+ | |||
<td style="background-color:#ccffcc;padding:7px;"> |
<td style="background-color:#ccffcc;padding:7px;"> |
||
<p> |
<p> |
||
Line 78: | Line 96: | ||
<p> |
<p> |
||
The <code>loadMacros</code> command loads information that works behind the scenes. We load the <code>PGML.pl</code> file to load the PGML formatting |
The <code>loadMacros</code> command loads information that works behind the scenes. We load the <code>PGML.pl</code> file to load the PGML formatting |
||
− | commands (similar to markDown) and the <code>PGcourse.pl<code> file to provide any local course customizations. The<code> |
+ | commands (similar to markDown) and the <code>PGcourse.pl</code> file to provide any local course customizations. The <code>PGcourse.pl</code> file is usually placed in the course's <code>templates/macros</code> directory |
</p> |
</p> |
||
</td> |
</td> |
||
</tr> |
</tr> |
||
+ | |||
+ | <!--================ Set Up ================--> |
||
+ | |||
<tr valign="top"> |
<tr valign="top"> |
||
<td style="background-color:#ffffdd;border:black 1px dashed;"> |
<td style="background-color:#ffffdd;border:black 1px dashed;"> |
||
Line 91: | Line 112: | ||
</pre> |
</pre> |
||
</td> |
</td> |
||
+ | |||
+ | <!---------------------------------------------> |
||
+ | |||
<td style="background-color:#ffffcc;padding:7px;"> |
<td style="background-color:#ffffcc;padding:7px;"> |
||
<p> |
<p> |
||
− | This is the <strong>problem set-up section</strong> of the problem. <code>Context("Numeric");</code> sets the "context", which determines how variables are interpreted. Contexts and context explanations are given on [[ContextList|this help page]]. Setting <code>showpartialCorrectAnswers</code> to 1 means that feedback as to which sub-questions have been correctly answered in the problem, otherwise the feedback indicates that there is a wrong answer somewhere. (Use the latter mode for multiple choice or true false questions.) |
||
+ | This is the <strong>problem set-up section</strong> of the problem. |
||
</p> |
</p> |
||
<p> |
<p> |
||
− | The bulk of the set-up section defines variables that we use in the rest of the problem. All <em>scalar variables</em> are prefaced with a dollar sign: thus <code>$a</code> is a variable that has a (non-vector, non-array) value. </code>. |
||
+ | <code>Context("Numeric");</code> sets the "context", which determines how variables are interpreted. Contexts and context explanations are given on [[ContextList|this help page]]. |
||
+ | </p> |
||
+ | <p> |
||
+ | Setting <code>showpartialCorrectAnswers</code> to 1 means that feedback as to which sub-questions have been correctly answered in the problem will be given, otherwise the feedback indicates that there is a wrong answer somewhere. (Use the latter mode for multiple choice or true/false questions.) |
||
+ | </p> |
||
+ | <p> |
||
+ | The bulk of the set-up section defines variables that we use in the rest of the problem. All <em>scalar variables</em> are prefaced with a dollar sign: thus <code>$a</code> is a variable that has a (non-array, non-associative-array) value. |
||
</p> |
</p> |
||
</td> |
</td> |
||
</tr> |
</tr> |
||
+ | |||
+ | <!--================ Text ================--> |
||
+ | |||
<tr valign="top"> |
<tr valign="top"> |
||
<td style="background-color:#ffdddd;border:black 1px dashed;"> |
<td style="background-color:#ffdddd;border:black 1px dashed;"> |
||
<pre> |
<pre> |
||
TEXT(beginproblem()); |
TEXT(beginproblem()); |
||
− | #TEXT(PGML::Format2(<<'END_PGML')); |
||
BEGIN_PGML |
BEGIN_PGML |
||
The number twelve is [_______]{12} |
The number twelve is [_______]{12} |
||
Type the formula [`1+\frac{x}{2}`] [__________]{"1+x/2"} |
Type the formula [`1+\frac{x}{2}`] [__________]{"1+x/2"} |
||
− | |||
Twelve is [______]{Real(12)} |
Twelve is [______]{Real(12)} |
||
Line 119: | Line 150: | ||
</pre> |
</pre> |
||
+ | </td> |
||
+ | |||
+ | <!---------------------------------------------> |
||
+ | |||
<td style="background-color:#ffcccc;padding:7px;"> |
<td style="background-color:#ffcccc;padding:7px;"> |
||
<p> |
<p> |
||
− | This is the <strong>text section</strong> of |
+ | This is the <strong>text section</strong> of the problem. |
+ | </p> |
||
+ | <p> |
||
+ | The <code>TEXT(beginproblem());</code> line displays a header for the problem. |
||
+ | </p> |
||
+ | <p> |
||
Everything between the <code>BEGIN_PGML</code> and <code>END_PGML</code> lines (each of which must appear alone on a line) is shown to the student. |
Everything between the <code>BEGIN_PGML</code> and <code>END_PGML</code> lines (each of which must appear alone on a line) is shown to the student. |
||
− | <code>BEGIN_PGML</code> and <code>END_PGML</code> replace the <code>BEGIN_TEXT/END_TEXT</code> structure used in the other template samples. |
||
+ | </p> |
||
− | The <code>Context()->texStrings</code> line is not needed. (If you are not using the latest version of pg you may need to replace <code>BEGIN_PGML</code> with its expanded version <code>TEXT(PGML::Format2(<<'END_PGML'));</code> |
||
+ | <p> |
||
− | which is |
||
+ | <code>BEGIN_PGML</code> and <code>END_PGML</code> replace the <code>BEGIN_TEXT/END_TEXT</code> structure used in older-style template samples. |
||
+ | The <code>Context()->texStrings</code> seen in those samples line is not needed when using PGML. |
||
</p> |
</p> |
||
<p> |
<p> |
||
Answer blanks are indicated by <code>[______]</code> where the number of blanks indicates the width of the answer blank. The correct answer can be given |
Answer blanks are indicated by <code>[______]</code> where the number of blanks indicates the width of the answer blank. The correct answer can be given |
||
− | in curly braces immediately afterward <code>{"1+x/2"}</code>. |
+ | in curly braces immediately afterward <code>{"1+x/2"}</code>. |
− | notation as <code>[:1+x/2:} </code> <code>[`[$f]`] </code> typesets the formula $f in inline math mode. |
||
</p> |
</p> |
||
<p> |
<p> |
||
− | A link to an interactive online calculator and to several dozens examples of using PGML is on the''' [[PGLabs]] ''' page. |
||
+ | TeX formulas within the text of the problem can be entered as <code>[``1+\frac{x}{2}``]</code> or in calculator |
||
− | Here is the [http://hosted2.webwork.rochester.edu/webwork2/cervone_course/PGML-examples/4?login_practice_user=true typeset version] of this sample problem |
||
+ | notation as <code>[:1+x/2:]</code>. A variable substitution would be given as <code>[$a]</code>, while <code>[`[$f]`] </code> typesets the formula for $f in inline math mode. |
||
+ | </p> |
||
+ | <p> |
||
+ | A link to an interactive online test framework and to several dozens examples of using PGML is on the''' [[PGLabs]] ''' page. |
||
+ | Here is the [https://courses1.webwork.maa.org/webwork2/cervone_course/PGML-examples/4?login_practice_user=true active version] of this sample problem. |
||
+ | |||
</p> |
</p> |
||
</td> |
</td> |
||
</tr> |
</tr> |
||
+ | |||
+ | <!--================ Answers ================--> |
||
+ | |||
<tr valign="top"> |
<tr valign="top"> |
||
<td style="background-color:#eeddff;border:black 1px dashed;"> |
<td style="background-color:#eeddff;border:black 1px dashed;"> |
||
<pre> |
<pre> |
||
− | SOLUTION(PGML::Format2(<<'END_SOLUTION')) |
||
+ | BEGIN_PGML_SOLUTION |
||
− | $PAR SOLUTION $PAR |
||
− | |||
You can use PGML in your solution if you use the structure |
You can use PGML in your solution if you use the structure |
||
above. There is currently no short cut. |
above. There is currently no short cut. |
||
− | END_SOLUTION |
||
+ | END_PGML_SOLUTION |
||
− | Context()->normalStrings; |
||
ENDDOCUMENT(); |
ENDDOCUMENT(); |
||
</pre> |
</pre> |
||
+ | </td> |
||
+ | |||
+ | <!---------------------------------------------> |
||
+ | |||
<td style="background-color:#eeccff;padding:7px;"> |
<td style="background-color:#eeccff;padding:7px;"> |
||
<p> |
<p> |
||
− | This is the <strong>answer and solution</strong> section of the problem. |
+ | This is the <strong>answer and solution</strong> section of the problem. Since the answers were given alongside the problems when you use |
− | PGML |
+ | PGML, the answer section is not needed, although it is allowed. |
</p> |
</p> |
||
<p> |
<p> |
||
− | Then, we explain the solution to the student. |
+ | Then, we explain the solution to the student. You can use <code>BEGIN_PGML_SOLUTION/END_PGML_SOLUTION</code> just as you would |
+ | <code>BEGIN_SOLUTION/END_SOLUTION</code> if you were not using PGML. There is also <code>BEGIN_PGML_HINT/END_PGML_HINT</code> for providing a hint to the student. |
||
</p> |
</p> |
||
<p> |
<p> |
||
Line 163: | Line 208: | ||
</td> |
</td> |
||
</tr> |
</tr> |
||
+ | |||
+ | <!--================================--> |
||
+ | |||
</table> |
</table> |
||
Latest revision as of 10:25, 15 June 2021
A PGML WeBWorK Sample Problem
This sample problem illustrates the basics of how to use PGML commands to layout a question.
This sample just scratches the surface of what is possible using these mark up commands. Page through the sample questions to see what can be done and click on the "show problem source" button to see how to accomplish it.
As usual 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 set-up section that sets variables specific to the problem,
- A text section, that gives the text that is shown to the student, and
- OPTIONAL --An answer , 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. As you will see this section can be used but are not necessary when using PGML commands.
- A solution section
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 # enter a bunch of different types of answers # WeBWorK problem written by Gavin LaRose # <glarose(at)umich(dot)edu> # and modified by Mike Gage gage(at)math(dot)rochester(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 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, 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", "PGML.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"); $showPartialCorrectAnswers = 1; $f = Formula("cos^2(x)+sin^2(x)"); |
This is the problem set-up section of the problem.
Setting
The bulk of the set-up section defines variables that we use in the rest of the problem. All scalar variables are prefaced with a dollar sign: thus |
TEXT(beginproblem()); BEGIN_PGML The number twelve is [_______]{12} Type the formula [`1+\frac{x}{2}`] [__________]{"1+x/2"} Twelve is [______]{Real(12)} 2 mod 10 is [______]{Real(2)->with(period=>10)} [`[$f]`] is equal to [_______]{Real(1)} Twelve is [______]{num_cmp(12)} The number 12 is [____]{answer=>12,width=>10} END_PGML |
This is the text section of the problem.
The
Everything between the
Answer blanks are indicated by
TeX formulas within the text of the problem can be entered as A link to an interactive online test framework and to several dozens examples of using PGML is on the PGLabs page. Here is the active version of this sample problem. |
BEGIN_PGML_SOLUTION You can use PGML in your solution if you use the structure above. There is currently no short cut. END_PGML_SOLUTION ENDDOCUMENT(); |
This is the answer and solution section of the problem. Since the answers were given alongside the problems when you use PGML, the answer section is not needed, although it is allowed.
Then, we explain the solution to the student. You can use
The |