Difference between revisions of "New Authors landing page"

From WeBWorK_wiki
Jump to navigation Jump to search
m
 
(74 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
== Authoring WeBWorK problems ==
  
−
 
−
* If you're just starting out, see the '''[[Problem Authoring Background Information]]''' and '''[[:Category:Sample Problems|sample problems]]''' first.
  
−
* If you're working on a problem in a specific area you may find the more advanced templates useful.
  
−
* If you're working on a problem and want to find out how to do one particular look at the '''[[:Category:Problem_Techniques|index of problem techniques]]''' section.
 
−
* More information on using '''[[:Category:MathObjects|MathObjects]]''' in authoring problems.
  
−
* Use the '''[http://webwork.maa.org/wiki/PGLabs online calculators]''' to try things out.
  
   
−
== 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 Templates|Subject Area Templates]]''' Some may find it useful to use this page where templates are ordered by subject area.
  +
* '''[[:Category:Sample_Problems|Sample_Problems]]''' A third page with a collection of templates is this page of sample problems.
   
−
* [[:Category:Sample Problems|Index of Sample Problems]]
  
  +
==Basic Information==
−
** [[SampleProblem1|Template 1]] (the basic structure of a WeBWorK PG problem file)
  
  +
WeBWorK problems should be written with the use of MathObjects, PG and PGML. MathObjects package things like numbers, vectors, matrices, etc., into a convenient form that controls formatting and includes an answer checker. PG provides many macros that generate random numbers, graphics, compute statistical distributions, etc. PGML gives authors finer control over a problem's display, and helps organize code in a way that is easy to maintain. Many older problems were written without PGML, and some were written without MathObjects, but that practice is now strongly discouraged except in very specific circumstances.
−
** [[old-style example template|SampleProblem1a]] (old-style, non-MathObjects example)
  
−
** [[SampleProblem2|Template 2]] (formulas, multiple choice, and string entry problems)
  
−
** [[SampleProblem3|Template 3]] (dynamically generated graphs)
  
−
* More Advanced Sample Problems
  
−
** ....
  
−
== Manuals and HOWTOs ==
  
   
−
* [[:Category:MathObjects|MathObjects]], an object system for manipulating mathematics in WeBWorK problems.
  
  +
Most of the templates mentioned above use MathObjects and many use PGML macros (look for "MathObjects.pl" and "PGML.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:
−
** [[PGLabs]], On-line labs for rendering of PG code. These labs allow you to experiment with PG syntax online.
  
  +
* '''[[Problem Authoring Background Information]]''' -- includes a PG language overview, some comments about editing problems and ensuring server access.
−
* [[Basic Perl syntax]] {{--}} PG is based on Perl, so it is important to know some basic Perl syntax.
  
  +
* '''[[:Category:MathObjects|MathObjects]]''' -- information on authoring problems using MathObjects.
−
**[How BEGIN_TEXT...END_TEXT blocks work]]
  
  +
* '''[[:Category:PGML|PGML]]''' -- information on authoring problem using the PGML markup language.
−
* [[Problem Authoring Best Practices]] for problem authoring.
  
  +
* '''[[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.
−
** [[What to do if you find a bug in a problem]]
  
−
** [[Tagging Problems]] with metadata for indexing and searching.
  
−
* Specialized HOWTOS
  
−
** [[SequentialProblems]] revealing the problem one step at a time
  
−
** [[Converting CAPA problems for use with WeBWorK]]
  
   
−
== Reference Documents ==
  
  +
==Tutorials==
   
−
* [[:Category:Problem Techniques|Index of Problem Techniques]] ** very useful code fragments
  
  +
* '''[[Learning How to Author Problems]]'''
−
* [http://webwork.maa.org/doc/cvs/pg_CURRENT PG macro/library documentation from CVS] -- original documentation embedded in the code
  
  +
* '''[[Writing Your Own Homework Problems Using PGML]]'''
−
* [[TrainingAuthors |Notes on training authors]], and suggestions for further documentation-- Sam Hathaway
  
  +
* '''[[: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).
−
* The Good Questions project at Cornell University [http://www.math.cornell.edu/~GoodQuestions/]
  
  +
* '''[[University of Lethbridge programming examples and libraries]]'''
−
[[Category:Top]]
  
  +
* '''[[Problem Authoring Videos]]''', recordings from the PREP 2015 Problem Authoring Workshop.
  +
  +
== Reference documents and manuals ==
  +
  +
* '''[https://webwork.maa.org/pod/ POD]''' -- POD (for WeBWorK/PG 2.15) = "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.
  +
  +
* '''[[TrainingAuthors |Notes on training authors]]''', and suggestions for further documentation-- Sam Hathaway
  +
* '''[http://pi.math.cornell.edu/~GoodQuestions/ The Good Questions project at Cornell University]'''
  +
  +
[[Category:Authors]]

Latest revision as of 15:59, 16 June 2021

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.

Basic Information

WeBWorK problems should be written with the use of MathObjects, PG and PGML. MathObjects package things like numbers, vectors, matrices, etc., into a convenient form that controls formatting and includes an answer checker. PG provides many macros that generate random numbers, graphics, compute statistical distributions, etc. PGML gives authors finer control over a problem's display, and helps organize code in a way that is easy to maintain. Many older problems were written without PGML, and some were written without MathObjects, but that practice is now strongly discouraged except in very specific circumstances.

Most of the templates mentioned above use MathObjects and many use PGML macros (look for "MathObjects.pl" and "PGML.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.
  • PGML -- information on authoring problem using the PGML markup language.
  • 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.

Tutorials

Reference documents and manuals

  • POD -- POD (for WeBWorK/PG 2.15) = "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.
Retrieved from "https://webwork.maa.org/mediawiki_new/index.php?title=New_Authors_landing_page&oldid=21451"