Learning How to Author Problems

Learning how to Author WeBWorK problems

• See Problem Authoring Background Information and sample problems If you're just starting out.
• See subject area templates if you're looking for complete examples from very basic to advanced.
• See index of problem techniques section if you need help with one particular construct.
• See PGML (Template 4) to learn techniques which simplify formatting the appearance of the questions.
• See MathObjects 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

• Problem Authoring Tutorial aimed at people who already know TeX, but need to learn about Perl, PG, and MathObjects.
• Index of Sample Problems
  • Template 1 (the basic structure of a WeBWorK PG problem file)
  • SampleProblem1a (old-style, non-MathObjects example)
  • Template 2 (formulas, multiple choice, and string entry problems)
  • Template 3 (dynamically generated graphs)
  • NEW --Template 4 (illustrates PGML markup)

Reference Documents

• Index of Problem Techniques ** very useful code fragments
• Subject Area Templates ** complete examples for questions on various math subjects
• 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.
• PGLabs, On-line labs for rendering of PG code. These labs allow you to interactively experiment with PG syntax online.
• PGML formatting examples.
• The Good Questions project at Cornell University [1]

Manuals and HOWTOs

• File:WeBWorK Problem Authoring Tutorial.pdf aimed at people who already know TeX, but need to learn about Perl, PG, and MathObjects.
• MathObjects, an object system for manipulating mathematics in WeBWorK questions.
  • PGLabs, On-line labs for rendering of PG code. These labs allow you to interactively experiment with PG syntax online.
  • 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.

• Customize_Course
• Applets, how to embed Flash and Java applets into WeBWorK questions.
• Specialized HOWTOS
  • SequentialProblems revealing the problem one step at a time
  • Converting CAPA problems for use with WeBWorK
• Notes on training authors, and suggestions for further documentation-- Sam Hathaway

Background information

(older reference material )

• Problem Authoring Background Information
• 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.