Authors

From WeBWorK
(Difference between revisions)
Jump to: navigation, search
(Templates)
 
(12 intermediate revisions by 3 users not shown)
Line 7: Line 7:
 
==Basic Information==
 
==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:
 
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]]''' This article includes a PG language overview, some comments about editing problems and ensuring server access.
+
* '''[[Problem Authoring Background Information]]''' -- includes a PG language overview, some comments about editing problems and ensuring server access.
* '''[[SampleProblem4 |PGML]]''' (Template 4) shows the standard outline of a problem, which includes a ''tagging and description section'', ''an initialization section'', ''a problem set-up section'', ''a text section'', and optional ''answer and solution sections''.
+
* '''[[:Category:MathObjects|MathObjects]]''' -- information on authoring problems using MathObjects.
* See  '''[[:Category:MathObjects|MathObjects]]''' for more information on authoring problems using MathObjects. For a quick reference see '''[[MathObjects reference table]]'''.
+
**  '''[[MathObjects reference table]]''' -- a quick reference.
* '''[[Introduction to Contexts]]''' Using Numeric, Complex, Vector, Matrix, and Interval context in problems.
+
** '''[[Introduction to Contexts]]''' -- how to use Numeric, Complex, Vector, Matrix, Interval, and other contexts in problems.
* '''[[Reduction rules for MathObject Formulas]]''' Includes a table of ''The Reduction Rules and their Actions''.  
+
** '''[[Reduction rules for MathObject Formulas]]''' -- a table of ''The Reduction Rules and their Actions''.  
* 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.
+
** '''[https://testcourses.webwork.maa.org/webwork2/PREP14_Problem_Authoring/Workshop2/?login_practice_user=true Davide Cervone's presentation on MathObjects to PREP, June, 2014]'''
* '''[https://testcourses.webwork.maa.org/webwork2/PREP13_Problem_Authoring/Workshop2_AM/ Davide Cervone's presentation to PREP, June 11, 2013]''' use guest login to view
+
* '''[[:Category:PGML|PGML]]''' -- 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 set-up section'', ''a text section'', and optional ''answer and solution sections''.
 +
** '''[https://testcourses.webwork.maa.org/webwork2/PREP14_Problem_Authoring/Workshop3-PGML/?login_practice_user=true Davide Cervone's presentation on PGML to PREP, June, 2014]'''
 +
* '''[[PGLabs|PG-Labs]]''' -- 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.
  
 
== Reference documents and manuals ==
 
== Reference documents and manuals ==
 +
* '''[[Problem Authoring Videos]]''' Complete course of streamed recordings from the PREP 2015 Workshop on Problem Authoring
 
* [[: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.  
 
* '''[[SequentialProblems]]''' revealing the problem one step at a time
 
* '''[[SequentialProblems]]''' revealing the problem one step at a time
 
* '''[http://webwork.maa.org/pod/pg_TRUNK/ 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.
 
* '''[http://webwork.maa.org/pod/pg_TRUNK/ 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.
* '''[[: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).
+
* '''[[Doxygen]] Doxygen compiles a list of all the subroutines occurring in all the files from the webwork2 and pg directories. Can be used to find where a macro command is defined.
 +
* '''[[: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) -- (by Paul Pearson).
 
* '''[[Customize_Course|Customize Course]]''' This page includes a bit of code that allows student to obtain a new version of a problem.
 
* '''[[Customize_Course|Customize 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/]
 
* The Good Questions project at Cornell University [http://www.math.cornell.edu/~GoodQuestions/]
 
* '''[[Converting CAPA problems for use with WeBWorK]]''' (This article has been retained as a historical document.)
 
* '''[[Converting CAPA problems for use with WeBWorK]]''' (This article has been retained as a historical document.)
 
  
 
==Other==
 
==Other==

Latest revision as of 11:08, 6 May 2016

Contents

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
  • 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. These are very basic examples that illustrate the structure of a WeBWorK problem.

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:

Reference documents and manuals

  • Problem Authoring Videos Complete course of streamed recordings from the PREP 2015 Workshop on Problem Authoring
  • Applets, how to embed Flash and Java applets into WeBWorK questions.
  • SequentialProblems 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.
  • Doxygen Doxygen compiles a list of all the subroutines occurring in all the files from the webwork2 and pg directories. Can be used to find where a macro command is defined.
  • WeBWorK Problem Authoring Tutorial aimed at people who already know TeX, but need to learn about Perl, PG, and MathObjects (pdf file) -- (by Paul Pearson).
  • 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.)

Other

Echo-ambass-48px.png
Developers
Become a WeBWorK Developer
Gartoon-credits-48px.png
Contributors
WeBWorK Contributors - join us! (blog posts)
Echo-ambass-48px.png
Learning How to Author Problems
Various tools and tricks for writing problems
follow us