Difference between revisions of "Learning How to Author Problems"
Jump to navigation
Jump to search
(Created page with "== Learning how to Author WeBWorK problems == * See '''Problem Authoring Background Information''' and '''sample problems''' If you're ju...") |
(→Learning how to Author WeBWorK problems: add drdrew tutorial from 2020.) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
* See ''' [[SampleProblem4 |PGML]]''' (Template 4) to learn techniques which simplify formatting the appearance of the questions. |
* 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 '''[[: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 | PG/PGML labs]]''' 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://github.com/drdrew42/WeBWorK-problem-authoring Intro to Problem Authoring]''' Introduction to the basics of Perl, MathObjects, and PGML (Nov 2020) -- includes problem templates |
||
| + | * '''[[: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. (Older -- 2010). |
||
| − | == |
+ | == Sample Problems == |
| − | * [[Problem Authoring Background Information]] (Big picture overview) |
||
| − | * '''[[: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]] |
* [[:Category:Sample Problems|Index of Sample Problems]] |
||
** [[SampleProblem1|Template 1]] (the basic structure of a WeBWorK PG problem file) |
** [[SampleProblem1|Template 1]] (the basic structure of a WeBWorK PG problem file) |
||
| Line 18: | Line 16: | ||
** [[SampleProblem3|Template 3]] (dynamically generated graphs) |
** [[SampleProblem3|Template 3]] (dynamically generated graphs) |
||
** '''NEW''' --[[SampleProblem4|Template 4]] (illustrates PGML markup) |
** '''NEW''' --[[SampleProblem4|Template 4]] (illustrates PGML markup) |
||
| − | * More Advanced Sample Problems |
||
| − | ** .... |
||
== Reference Documents == |
== Reference Documents == |
||
| − | * '''[[:Category:Problem Techniques|Index of Problem Techniques]]''' ** very useful code fragments |
+ | * '''[[:Category:Problem Techniques|Index of Problem Techniques]]''' ** very useful code fragments for embedding and creating graphics, tables, creating multiple choice and sequential problems, embedding JavaScript, Geogebra and Sage, and many, many other things. |
* '''[[SubjectAreaTemplates | Subject Area Templates]]''' ** complete examples for questions on various math subjects |
* '''[[SubjectAreaTemplates | Subject Area Templates]]''' ** complete examples for questions on various math subjects |
||
| − | * '''[http://webwork.maa.org/pod/ |
+ | * '''[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. |
| − | * '''[[PGLabs]]''', On-line labs for rendering of PG code. These labs |
+ | * '''[[PGLabs | PG/PGML labs]]''', On-line labs for rendering of PG and PGML code. These labs enable you to experiment interactively online with PG syntax. |
| − | * [ |
+ | * [http://pi.math.cornell.edu/~GoodQuestions/ The Good Questions project at Cornell University] |
| − | * The Good Questions project at Cornell University [http://www.math.cornell.edu/~GoodQuestions/] |
||
| − | |||
| − | == 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 == |
== Background information == |
||
(older reference material ) |
(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. |
* [[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]] |
**[[How BEGIN_TEXT...END_TEXT blocks work]] |
||
Latest revision as of 12:06, 21 June 2021
Contents
Learning how to Author WeBWorK problems
- See Problem Authoring Background Information and sample problems If you're just starting out.
- See subject area templates if you're looking for complete examples from very basic to advanced.
- See index of problem techniques section if you need help with one particular construct.
- See PGML (Template 4) to learn techniques which simplify formatting the appearance of the questions.
- See MathObjects for more information on authoring problems using MathObjects.
- See PG/PGML labs 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.
- Intro to Problem Authoring Introduction to the basics of Perl, MathObjects, and PGML (Nov 2020) -- includes problem templates
- Problem Authoring Tutorial aimed at people who already know TeX, but need to learn about Perl, PG, and MathObjects. (Older -- 2010).
Sample Problems
- Index of Sample Problems
- Template 1 (the basic structure of a WeBWorK PG problem file)
- SampleProblem1a (old-style, non-MathObjects example)
- Template 2 (formulas, multiple choice, and string entry problems)
- Template 3 (dynamically generated graphs)
- NEW --Template 4 (illustrates PGML markup)
Reference Documents
- Index of Problem Techniques ** very useful code fragments for embedding and creating graphics, tables, creating multiple choice and sequential problems, embedding JavaScript, Geogebra and Sage, and many, many other things.
- Subject Area Templates ** complete examples for questions on various math subjects
- 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.
- PG/PGML labs, On-line labs for rendering of PG and PGML code. These labs enable you to experiment interactively online with PG syntax.
- The Good Questions project at Cornell University
Background information
(older reference material )
- Basic Perl syntax — PG is based on Perl, so it is important to know some basic Perl syntax.
- 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.
