Difference between revisions of "Authors"

From WeBWorK_wiki
Jump to navigation Jump to search
 
(39 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
{|width = "100%" align="center"
  
  +
==Templates==
−
|style="width: 33%; border-width: 0px;"|{{projectline|WeBWorK_Sites|WeBWorK Sites|Map of known WeBWorK Sites|gartoon-globe-48px.svg}}
  
  +
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.
−
|style="width: 33%; border-width: 0px;"|{{projectline|extlink=false|Events|Events|Upcoming WeBWorK Events (JMM-Jan 3-7) |echo-calendar-48px.png}}
  
  +
* '''[https://openwebwork.github.io/pg-docs/sample-problems/techniques.html Problem Techniques]''' listed alphabetically.
−
|-
  
  +
* '''[[Problem Techniques]]''' This page lists old templates for WeBWorK problems in alphabetical order. ''The problems on this link are out of date and should only be accessed for historical reasons.''
−
|style="width: 33%; border-width: 0px;"|{{projectline|extlink=true|http://webwork.maa.org/moodle/mod/forum/index.php{{?}}id{{=}}3|Forums|WeBWorK Discussion Forums|quote-48px.png}}
  
  +
* '''[[:Category:Subject Area Templates|Subject Area Templates]]''' Some may find it useful to use this page where templates are ordered by subject area.
−
|style="width: 34%; border-width: 0px;"|{{projectline|IRC|IRC|IRC chat support channel for WeBWorK Instructors, Developers, and Admins|gartoon-irc-48px.svg}}
  
  +
* '''[[:Category:Sample_Problems|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.
−
|-
  
−
|style="width: 33%; border-width: 0px;"|{{projectline|Video conferences|Web-Conferences|Information about WeBWorK Web-Conferences|gartoon-video-48px.svg}}
  
−
|style="width: 33%; border-width: 0px;"|{{projectline|Mailing Lists|Mailing Lists|WeBWorK Development Email Lists|gartoon-mail-48px.svg}}
  
−
|-
  
−
|style="width: 33%; border-width: 0px;"|{{projectline|WeBWorK_Consultants,_Workshops_and_Training_Sessions|Consultants|Information for and about WeBWorK Consultants|echo-ambass-48px.png}}
  
−
|style="width: 33%; border-width: 0px;"|{{projectline|Contributors|Contributors|WeBWorK Contributors - join us! [http://webwork.maa.org/planet (blog posts)]|gartoon-credits-48px.svg}}
  
−
|}
  
   
−
[[Learning How to Author 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. 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 learning 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.
  +
* '''[[:Category:MathObjects|MathObjects]]''' -- information on authoring problems using MathObjects.
  +
* '''[[:Category:PGML|PGML]]''' -- information on authoring problem using the PGML markup language.
  +
* '''[[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.
  +
  +
==Tutorials==
  +
  +
* '''[[Learning How to Author Problems]]'''
  +
* '''[[Writing Your Own Homework Problems Using PGML]]'''
  +
* '''[[: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).
  +
* '''[[University of Lethbridge programming examples and libraries]]'''
  +
* '''[https://demo.webwork.rochester.edu/webwork2/2017_Davide_Cervone_PREP_course PREP 2017 WeBWorK Problem Authoring Workshop]''' text, some exercises. Use the '''Guest Login'''.
  +
* '''[[Problem Authoring Videos]]''', recordings from the PREP 2015 Problem Authoring Workshop.
  +
  +
== Reference documents and manuals ==
  +
  +
* '''[https://webwork.maa.org/pod 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.
  +
* '''[[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 10:01, 28 June 2023

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 listed alphabetically.
  • Problem Techniques This page lists old templates for WeBWorK problems in alphabetical order. The problems on this link are out of date and should only be accessed for historical reasons.
  • 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, 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. 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 learning 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

Retrieved from "https://webwork.maa.org/mediawiki_new/index.php?title=Authors&oldid=23674"