Editing Category:Authors

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
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.
   
==Templates==
 
  +
== Basic info and Sample Problems ==
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.
 
   
==Basic Information==
 
  +
* [[Problem Authoring Background Information]] (Big picture overview)
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:
 
  +
* '''[[: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.
* '''[[Problem Authoring Background Information]]''' -- includes a PG language overview, some comments about editing problems and ensuring server access.
 
  +
* [[:Category:Sample Problems|Index of Sample Problems]]
* '''[[:Category:MathObjects|MathObjects]]''' -- information on authoring problems using MathObjects.
 
  +
** [[SampleProblem1|Template 1]] (the basic structure of a WeBWorK PG problem file)
** '''[[MathObjects reference table]]''' -- a quick reference.
 
  +
** [[old-style example template|SampleProblem1a]] (old-style, non-MathObjects example)
** '''[[Introduction to Contexts]]''' -- how to use Numeric, Complex, Vector, Matrix, Interval, and other contexts in problems.
 
  +
** [[SampleProblem2|Template 2]] (formulas, multiple choice, and string entry problems)
** '''[[Reduction rules for MathObject Formulas]]''' -- a table of ''The Reduction Rules and their Actions''.
 
  +
** [[SampleProblem3|Template 3]] (dynamically generated graphs)
** '''[https://testcourses.webwork.maa.org/webwork2/PREP14_Problem_Authoring/Workshop2/?login_practice_user=true Davide Cervone's presentation on MathObjects to PREP, June, 2014]'''
 
  +
** '''NEW''' --[[SampleProblem4|Template 4]] (illustrates PGML markup)
* '''[[:Category:PGML|PGML]]''' -- information on authoring problem using the PGML markup language.
 
  +
* More Advanced Sample Problems
** '''[[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.
 
   
==Templates, programming examples, and problem libraries from the University of Lethbridge==
 
  +
== Reference Documents ==
   
Sean Fitzpatrick (sean.fitzpatrick@uleth.ca) contributed the following:
 
  +
* '''[[: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.
  +
* '''[[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/]
   
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
 
  +
== Manuals and HOWTOs ==
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
 
  +
* '''[[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.
   
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
 
  +
* [[Customize_Course]]
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.
* '''[[SequentialProblems]]''' now replaced by [[Scaffold]] revealing the problem one step at a time
 
  +
* Specialized HOWTOS
* '''[https://demo.webwork.rochester.edu/wwdocs/ 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. (Old, currently broken link [http://webwork.maa.org/pod/pg_TRUNK/ POD])
 
  +
** [[SequentialProblems]] revealing the problem one step at a time
* '''[[: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).
 
  +
** [[Converting CAPA problems for use with WeBWorK]]
* '''[[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/]
 
  +
* '''[[Converting CAPA problems for use with WeBWorK]]''' (This article has been retained as a historical document.)
 
  +
== 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]]

Please note that all contributions to WeBWorK_wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see The WeBWorK Project wiki:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)