Category:Authors

From WeBWorK
(Difference between revisions)
Jump to: navigation, search
(Undo revision 13006 by Anneke Bart (talk))
(Templates, programming examples, and problem libraries from the University of Lethbridge)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Learning how to Author WeBWorK problems ==
 
 
 
* See  '''[[Problem Authoring Background Information]]''' and '''[[:Category:Sample Problems|sample problems]]''' If you're just starting out.
 
* See '''[[SubjectAreaTemplates|subject area templates]]''' if you're looking for complete examples from very basic to advanced.
 
* See '''[[:Category:Problem_Techniques|index of problem techniques]]''' section if you need help with one particular construct.
 
* See ''' [[SampleProblem4 |PGML]]''' (Template 4) to learn techniques which simplify formatting  the appearance of the questions.
 
* 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.
 
  
== Basic info and 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.
  
* [[Problem Authoring Background Information]] (Big picture overview)
+
==Basic Information==
* '''[[: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.
+
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:
* [[:Category:Sample Problems|Index of Sample Problems]]
+
* '''[[Problem Authoring Background Information]]''' -- includes a PG language overview, some comments about editing problems and ensuring server access.
** [[SampleProblem1|Template 1]] (the basic structure of a WeBWorK PG problem file)
+
* '''[[:Category:MathObjects|MathObjects]]''' -- information on authoring problems using MathObjects.
** [[old-style example template|SampleProblem1a]] (old-style, non-MathObjects example)
+
** '''[[MathObjects reference table]]''' -- a quick reference.
** [[SampleProblem2|Template 2]] (formulas, multiple choice, and string entry problems)
+
** '''[[Introduction to Contexts]]''' -- how to use Numeric, Complex, Vector, Matrix, Interval, and other contexts in problems.
** [[SampleProblem3|Template 3]] (dynamically generated graphs)
+
** '''[[Reduction rules for MathObject Formulas]]''' -- a table of ''The Reduction Rules and their Actions''.
** '''NEW''' --[[SampleProblem4|Template 4]] (illustrates PGML markup)
+
** '''[https://testcourses.webwork.maa.org/webwork2/PREP14_Problem_Authoring/Workshop2/?login_practice_user=true Davide Cervone's presentation on MathObjects to PREP, June, 2014]'''
* More Advanced Sample Problems
+
* '''[[:Category:PGML|PGML]]''' -- information on authoring problem using the PGML markup language.
*....
+
** '''[[SampleProblem4 |Template 4]]''' -- the standard outline of a problem using PGML, which includes a ''tagging and description section'', ''an initialization section'', ''a problem set-up section'', ''a text section'', and optional ''answer and solution sections''.
 +
** '''[https://testcourses.webwork.maa.org/webwork2/PREP14_Problem_Authoring/Workshop3-PGML/?login_practice_user=true Davide Cervone's presentation on PGML to PREP, June, 2014]'''
 +
* '''[[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.
  
== Reference Documents ==
+
==Templates, programming examples, and problem libraries from the University of Lethbridge==
  
* '''[[:Category:Problem Techniques|Index of Problem Techniques]]''' ** very useful code fragments
+
Sean Fitzpatrick (sean.fitzpatrick@uleth.ca) contributed the following:
* '''[[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.
+
* '''[[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''' ] formatting examples.
+
* The Good Questions project at Cornell University [http://www.math.cornell.edu/~GoodQuestions/]
+
  
== Manuals and HOWTOs ==
+
This summer, one of my colleagues hired a student to help her go through all of the libraries, marcos, contexts, etc. and put together a collection
 +
of templates and programming examples. I got permission from her to put everything on a public GitHub repository; you can find the fruits of their
 +
efforts here:
  
* '''[[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.
+
https://github.com/ULeth-Math-CS/WeBWorK
* '''[[: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.
+
  
 +
The programming examples are not questions. They're an attempt at producing an exhaustive list of every possible way of inputting and evaluating
 +
something using the various contexts.
 +
In the documentation there's a nice flowchart for deciding which context to use for a given problem.
  
* [[Customize_Course]]
+
I hope this is useful. It's the beginnings of what will hopefully be a longer project (done mostly over summers), so it's not yet as polished as it
 +
could be.
 +
 
 +
== Reference documents and manuals ==
 +
* '''[[Problem Authoring Videos]]''', recordings from the PREP 2015 Problem Authoring Workshop.
 
* [[:Category:Applets|'''Applets''']], how to embed Flash and Java applets into WeBWorK questions.  
 
* [[:Category:Applets|'''Applets''']], how to embed Flash and Java applets into WeBWorK questions.  
* Specialized HOWTOS
+
* '''[[SequentialProblems]]''' revealing the problem one step at a time
** [[SequentialProblems]] revealing the problem one step at a time
+
* '''[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.
** [[Converting CAPA problems for use with WeBWorK]]
+
* '''[[: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
 
* '''[[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/]
== Background information ==
+
* '''[[Converting CAPA problems for use with WeBWorK]]''' (This article has been retained as a historical document.)
(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]]
+

Latest revision as of 08:15, 3 October 2017

Contents

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:

Templates, programming examples, and problem libraries from the University of Lethbridge

Sean Fitzpatrick (sean.fitzpatrick@uleth.ca) contributed the following:

This summer, one of my colleagues hired a student to help her go through all of the libraries, marcos, contexts, etc. and put together a collection of templates and programming examples. I got permission from her to put everything on a public GitHub repository; you can find the fruits of their efforts here:

https://github.com/ULeth-Math-CS/WeBWorK

The programming examples are not questions. They're an attempt at producing an exhaustive list of every possible way of inputting and evaluating something using the various contexts. In the documentation there's a nice flowchart for deciding which context to use for a given problem.

I hope this is useful. It's the beginnings of what will hopefully be a longer project (done mostly over summers), so it's not yet as polished as it could be.

Reference documents and manuals

  • Problem Authoring Videos, recordings from the PREP 2015 Problem Authoring Workshop.
  • 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