Difference between revisions of "Category:Authors"
(→Reference documents and manuals: put a working link to POD docs  current "temporary" location) 

(32 intermediate revisions by 8 users not shown)  
Line 1:  Line 1:  
−  == Learning how to Author WeBWorK problems == 

−  
−  * See '''[[Problem Authoring Background Information]]''' and '''[[:Category:Sample Problemssample problems]]''' If you're just starting out. 

−  * See '''[[:Category:Problem_Techniquesindex of problem techniques]]''' section If you need help with one particular construct. 

−  * See ''' [[SampleProblem4 PGML]]''' (Template 4) to learn techniques which simplify formatting the appearance of the questions. 

−  * See '''[[:Category:MathObjectsMathObjects]]''' for more information on authoring problems using MathObjects. 

−  * See '''[[ PGLabs]]''' to try out code fragments on line  including code fragments containing MathObjects. This is a quick way to learn the fine points of the MathObject syntax. 

−  == Basic info and Sample Problems == 

+  ==Templates== 

+  Most people write problems starting from templates. Problems from the OPL can be modified to suit individual needs, or existing problem templates can be used to create new problems. 

+  * '''[[Problem Techniques]]''' This page lists templates for WeBWorK problems in alphabetical order. This collection of templates can also be accessed through the associated category page: [[:Category:Problem Techniques]] 

+  * '''[[:Category:Subject Area TemplatesSubject Area Templates]]''' Some may find it useful to use this page where templates are ordered by subject area. 

+  * '''[[:Category:Sample_ProblemsSample_Problems]]''' A third page with a collection of templates is this page of sample problems. 

−  +  ==Basic Information== 

+  WeBWorK problems should be written with the use of MathObjects. Most of the templates mentioned above will include the MathObject Macros (recognizable by the line "MathObjects.pl" in the LoadMacros section of the code). For those who would like to read up on the basics of coding problems the following pages are recommended: 

+  * '''[[Problem Authoring Background Information]]'''  includes a PG language overview, some comments about editing problems and ensuring server access. 

+  * '''[[:Category:MathObjectsMathObjects]]'''  information on authoring problems using MathObjects. 

+  ** '''[[MathObjects reference table]]'''  a quick reference. 

+  ** '''[[Introduction to Contexts]]'''  how to use Numeric, Complex, Vector, Matrix, Interval, and other contexts in problems. 

+  ** '''[[Reduction rules for MathObject Formulas]]'''  a table of ''The Reduction Rules and their Actions''. 

+  ** '''[https://testcourses.webwork.maa.org/webwork2/PREP14_Problem_Authoring/Workshop2/?login_practice_user=true Davide Cervone's presentation on MathObjects to PREP, June, 2014]''' 

+  * '''[[:Category:PGMLPGML]]'''  information on authoring problem using the PGML markup language. 

+  ** '''[[SampleProblem4 Template 4]]'''  the standard outline of a problem using PGML, which includes a ''tagging and description section'', ''an initialization section'', ''a problem setup section'', ''a text section'', and optional ''answer and solution sections''. 

+  ** '''[https://testcourses.webwork.maa.org/webwork2/PREP14_Problem_Authoring/Workshop3PGML/?login_practice_user=true Davide Cervone's presentation on PGML to PREP, June, 2014]''' 

+  * '''[[PGLabsPGLabs]]'''  try out code fragments on line including code fragments containing MathObjects and PGML. This is a quick way to learn the fine points of the MathObject and PGML syntax. 

−  * [[:Category:Sample ProblemsIndex of Sample Problems]] 

+  ==Templates, programming examples, and problem libraries from the University of Lethbridge== 

−  ** [[SampleProblem1Template 1]] (the basic structure of a WeBWorK PG problem file) 

−  ** [[oldstyle example templateSampleProblem1a]] (oldstyle, nonMathObjects example) 

−  ** [[SampleProblem2Template 2]] (formulas, multiple choice, and string entry problems) 

−  ** [[SampleProblem3Template 3]] (dynamically generated graphs) 

−  ** '''NEW''' [[SampleProblem4Template 4]] (illustrates PGML markup) 

−  * More Advanced Sample Problems 

−  ** .... 

−  == Reference Documents == 

+  Sean Fitzpatrick (sean.fitzpatrick@uleth.ca) contributed the following: 

−  * '''[[:Category:Problem TechniquesIndex of Problem Techniques]]''' ** very useful code fragments 

+  This summer, one of my colleagues hired a student to help her go through all of the libraries, marcos, contexts, etc. and put together a collection 

−  * '''[http://webwork.maa.org/pod/pg_TRUNK/ POD]'''  POD = "plain old documentation"  original documentation embedded in the code files. 

+  of templates and programming examples. I got permission from her to put everything on a public GitHub repository; you can find the fruits of their 

−  * '''[[PGLabs]]''', Online labs for rendering of PG code. These labs allow you to interactively experiment with PG syntax online. 

+  efforts here: 

−  * [http://hosted2.webwork.rochester.edu/webwork2/cervone_course/PGMLexamples/?login_practice_user=true '''PGML''' ] formatting examples. 

−  * The Good Questions project at Cornell University [http://www.math.cornell.edu/~GoodQuestions/] 

−  == Manuals and HOWTOs == 

+  https://github.com/ULethMathCS/WeBWorK 

−  * '''[[:Category:MathObjectsMathObjects]]''', an object system for manipulating mathematics in WeBWorK questions. 

+  The programming examples are not questions. They're an attempt at producing an exhaustive list of every possible way of inputting and evaluating 

−  ** '''[[PGLabs]]''', Online labs for rendering of PG code. These labs allow you to interactively experiment with PG syntax online. 

+  something using the various contexts. 

−  **[http://hosted2.webwork.rochester.edu/webwork2/cervone_course/PGMLexamples/?login_practice_user=true '''PGML''' ] Davide Cervone's newest addition to the PG authoring language makes it easier to describe the layout of a question. The new commands and an interactive environment for experimenting with them are available on the [[PGLabs]] page. 

+  In the documentation there's a nice flowchart for deciding which context to use for a given problem. 

+  
+  I hope this is useful. It's the beginnings of what will hopefully be a longer project (done mostly over summers), so it's not yet as polished as it 

+  could be. 

+  
+  == Reference documents and manuals == 

+  * '''[[Problem Authoring Videos]]''', recordings from the PREP 2015 Problem Authoring Workshop. 

* [[:Category:Applets'''Applets''']], how to embed Flash and Java applets into WeBWorK questions. 
* [[:Category:Applets'''Applets''']], how to embed Flash and Java applets into WeBWorK questions. 

−  * Specialized HOWTOS 

+  * '''[[SequentialProblems]]''' now replaced by [[Scaffold]] revealing the problem one step at a time 

−  ** [[SequentialProblems]] revealing the problem one step at a time 

+  * '''[https://demo.webwork.rochester.edu/wwdocs/ POD]'''  POD = "plain old documentation"  original documentation embedded in the code files  this is the place to find the most complete and most technical description of macro behaviors. (Old, currently broken link [http://webwork.maa.org/pod/pg_TRUNK/ POD]) 

−  ** [[Converting CAPA problems for use with WeBWorK]] 

+  * '''[[:File:WeBWorK_Problem_Authoring_Tutorial.pdf WeBWorK Problem Authoring Tutorial]]''' aimed at people who already know TeX, but need to learn about Perl, PG, and MathObjects (pdf file). 

+  * '''[[Customize_CourseCustomize Course]]''' This page includes a bit of code that allows student to obtain a new version of a problem. 

* '''[[TrainingAuthors Notes on training authors]]''', and suggestions for further documentation Sam Hathaway 
* '''[[TrainingAuthors Notes on training authors]]''', and suggestions for further documentation Sam Hathaway 

−  
+  * The Good Questions project at Cornell University [http://www.math.cornell.edu/~GoodQuestions/] 

−  == Background information == 

+  * '''[[Converting CAPA problems for use with WeBWorK]]''' (This article has been retained as a historical document.) 

−  
−  * [[Basic Perl syntax]] {{}} PG is based on Perl, so it is important to know some basic Perl syntax. 

−  **[How BEGIN_TEXT...END_TEXT blocks work]] 

−  * [[Problem Authoring Best Practices]] for problem authoring. 

−  ** [[What to do if you find a bug in a problem]] 

−  ** [[Tagging Problems]] with metadata for indexing and searching. 

−  
−  
−  [[Category:Top]] 
Latest revision as of 04:25, 8 November 2020
Contents
Templates[edit]
Most people write problems starting from templates. Problems from the OPL can be modified to suit individual needs, or existing problem templates can be used to create new problems.
 Problem Techniques This page lists templates for WeBWorK problems in alphabetical order. This collection of templates can also be accessed through the associated category page: Category:Problem Techniques
 Subject Area Templates Some may find it useful to use this page where templates are ordered by subject area.
 Sample_Problems A third page with a collection of templates is this page of sample problems.
Basic Information[edit]
WeBWorK problems should be written with the use of MathObjects. Most of the templates mentioned above will include the MathObject Macros (recognizable by the line "MathObjects.pl" in the LoadMacros section of the code). For those who would like to read up on the basics of coding problems the following pages are recommended:
 Problem Authoring Background Information  includes a PG language overview, some comments about editing problems and ensuring server access.
 MathObjects  information on authoring problems using MathObjects.
 MathObjects reference table  a quick reference.
 Introduction to Contexts  how to use Numeric, Complex, Vector, Matrix, Interval, and other contexts in problems.
 Reduction rules for MathObject Formulas  a table of The Reduction Rules and their Actions.
 Davide Cervone's presentation on MathObjects to PREP, June, 2014
 PGML  information on authoring problem using the PGML markup language.
 Template 4  the standard outline of a problem using PGML, which includes a tagging and description section, an initialization section, a problem setup section, a text section, and optional answer and solution sections.
 Davide Cervone's presentation on PGML to PREP, June, 2014
 PGLabs  try out code fragments on line including code fragments containing MathObjects and PGML. This is a quick way to learn the fine points of the MathObject and PGML syntax.
Templates, programming examples, and problem libraries from the University of Lethbridge[edit]
Sean Fitzpatrick (sean.fitzpatrick@uleth.ca) contributed the following:
This summer, one of my colleagues hired a student to help her go through all of the libraries, marcos, contexts, etc. and put together a collection of templates and programming examples. I got permission from her to put everything on a public GitHub repository; you can find the fruits of their efforts here:
https://github.com/ULethMathCS/WeBWorK
The programming examples are not questions. They're an attempt at producing an exhaustive list of every possible way of inputting and evaluating something using the various contexts. In the documentation there's a nice flowchart for deciding which context to use for a given problem.
I hope this is useful. It's the beginnings of what will hopefully be a longer project (done mostly over summers), so it's not yet as polished as it could be.
Reference documents and manuals[edit]
 Problem Authoring Videos, recordings from the PREP 2015 Problem Authoring Workshop.
 Applets, how to embed Flash and Java applets into WeBWorK questions.
 SequentialProblems now replaced by Scaffold revealing the problem one step at a time
 POD  POD = "plain old documentation"  original documentation embedded in the code files  this is the place to find the most complete and most technical description of macro behaviors. (Old, currently broken link POD)
 WeBWorK Problem Authoring Tutorial aimed at people who already know TeX, but need to learn about Perl, PG, and MathObjects (pdf file).
 Customize Course This page includes a bit of code that allows student to obtain a new version of a problem.
 Notes on training authors, and suggestions for further documentation Sam Hathaway
 The Good Questions project at Cornell University [1]
 Converting CAPA problems for use with WeBWorK (This article has been retained as a historical document.)
Subcategories
This category has the following 7 subcategories, out of 7 total.
A
M
P
S
Pages in category "Authors"
The following 22 pages are in this category, out of 22 total.