Difference between revisions of "User:Anneke Bart/sandbox3-Authorpage"

From WeBWorK_wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by one other user not shown)
Line 2: Line 2:
   
 
==Templates==
 
==Templates==
Most people write problems starting from templates. We can find problems in the OPL we like and modify those to suit our individual needs, or we can use templates we have collected here on this documentation Wiki.
+
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]]
+
* '''[[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: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|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 '''[[ 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
  +
  +
== Reference documents and manuals ==
  +
* [[:Category:Applets|'''Applets''']], how to embed Flash and Java applets into WeBWorK questions.
  +
* '''[[SequentialProblems]]''' revealing the problem one step at a time
  +
* '''[http://webwork.maa.org/pod/pg 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).
  +
* '''[[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/]
  +
* '''[[Converting CAPA problems for use with WeBWorK]]''' (This article has been retained as a historical document.)

Latest revision as of 16:27, 7 April 2021

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