Category:Authors

From WeBWorK
(Difference between revisions)
Jump to: navigation, search
(Learning how to Author WeBWorK problems)
(reorganized page)
Line 1: Line 1:
== Learning how to Author WeBWorK problems ==
+
Authors (draft of a new page)
 
+
 
* See  '''[[Problem Authoring Background Information]]''' and '''[[:Category:Sample Problems|sample problems]]''' If you're just starting out.
+
==Templates==
* See '''[[SubjectAreaTemplates|subject area templates]]''' if you're looking for complete examples from very basic to advanced.  
+
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.
* See '''[[:Category:Problem_Techniques|index of problem techniques]]''' section if you need help with one particular construct.
+
* '''[[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]]
* See ''' [[SampleProblem4 |PGML]]''' (Template 4) to learn techniques which simplify formatting  the appearance of the questions.  
+
* '''[[: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.
 +
 
 +
==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]]''' This article 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''.
 
* See  '''[[:Category:MathObjects|MathObjects]]''' for more information on authoring problems using MathObjects.
 
* See  '''[[:Category:MathObjects|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.
 
* 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/PREP13_Problem_Authoring/Workshop2_AM/  Davide Cervone's presentation to PREP, June 11, 2013] use guest login to view
+
* '''[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
  
== Basic info and Sample Problems ==
+
== Reference documents and manuals ==
 
+
* [[:Category:Applets|'''Applets''']], how to embed Flash and Java applets into WeBWorK questions.  
* [[Problem Authoring Background Information]] (Big picture overview)
+
* '''[[SequentialProblems]]''' revealing the problem one step at a time
* '''[[:File:WeBWorK_Problem_Authoring_Tutorial.pdf|Problem Authoring Tutorial]]''' aimed at people who already know TeX, but need to learn about Perl, PG, and MathObjects.
+
* [[:Category:Sample Problems|Index of Sample Problems]]
+
** [[SampleProblem1|Template 1]] (the basic structure of a WeBWorK PG problem file)
+
** [[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)
+
** '''NEW''' --[[SampleProblem4|Template 4]] (illustrates PGML markup)
+
* More Advanced Sample Problems
+
**  ....
+
 
+
== Reference Documents ==
+
 
+
* '''[[:Category:Problem Techniques|Index of Problem Techniques]]''' ** very useful code fragments
+
* '''[[SubjectAreaTemplates | Subject Area Templates]]'''  ** complete examples for questions on various math subjects
+
 
* '''[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.
* '''[[PGLabs]]''', On-line labs for rendering of PG code. These labs allow you to interactively experiment with PG syntax online.
+
* '''[[: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).
* [https://courses.webwork.maa.org/webwork2/cervone_course/PGML-examples/?login_practice_user=true '''PGML''' ] formatting examples.
+
* '''[[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
 
* 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.)
== Manuals and HOWTOs ==
+
 
+
* '''[[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.
+
* '''[[:Category: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.
+
**[https://courses.webwork.maa.org/webwork2/cervone_course/PGML-examples/?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.
+
 
+
 
+
* [[Customize_Course]]
+
* [[:Category:Applets|'''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]]
+
* '''[[TrainingAuthors |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.
+
 
+
 
+
[[Category:Top]]
+

Revision as of 08:54, 2 July 2013

Authors (draft of a new page)

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. 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.
  • 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.
  • 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.
  • Davide Cervone's presentation to PREP, June 11, 2013 use guest login to view

Reference documents and manuals

  • 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.
  • 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

M cont.

P

  • PGML(2 C, 21 P)

S

S cont.

follow us