Talk:Main Page: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
''Found on the TWiki:'' | ''Found on the TWiki:'' | ||
As far as I can tell, the "complete" set of documentation for WeBWorK should consist of the following: | As far as I can tell, the "complete" set of documentation for WeBWorK should consist of the following: | ||
| Line 31: | Line 30: | ||
(this list originally from <code>Message-ID: <20031001034004.A92569@gate.math.rochester.edu></code>) | (this list originally from <code>Message-ID: <20031001034004.A92569@gate.math.rochester.edu></code>) | ||
-- Main.SamHathaway - 10 Nov 2003 | |||
== Docs on webhost that are still valuable == | == Docs on webhost that are still valuable == | ||
| Line 38: | Line 36: | ||
''Found on the TWiki:'' | ''Found on the TWiki:'' | ||
There is quite a bit of [http://webhost.math.rochester.edu/webworkdocs/docs/ documentation written for WebWorK 1.x]. Some of it is still applicable to WeBWorK 2, including: | There is quite a bit of [http://webhost.math.rochester.edu/webworkdocs/docs/ documentation written for WebWorK 1.x]. Some of it is still applicable to WeBWorK 2, including: | ||
| Line 49: | Line 46: | ||
-- Main.SamHathaway - 24 Aug 2004 | -- Main.SamHathaway - 24 Aug 2004 | ||
Revision as of 20:45, 29 February 2008
Complete set of docs
Found on the TWiki:
As far as I can tell, the "complete" set of documentation for WeBWorK should consist of the following:
- a description of webwork for the student, professor, and administrator
- system requirements (in the installation manual)
- installation instructions (installation manual)
- configuration instructions
- basic configuration is in installation manual
- a comprehensive list of course environment variables is now in the comments of
global.confanddatabase.conf, but needs to be made accessible. convert to POD? - Constants.pm has POD docs, but they have to get put on the wiki
- the NETPBM stuff is in the installation manual (but really should go away!!!)
- task-oriented usage instructions
- admin tasks (like course creation)
- course admin tasks
- instructor tasks
- student tasks
- admin tasks (like course creation)
- command line script documentation
- library reference (this is/will be POD)
- pg language reference
- basics
- cookbook techniques
- standard macro packages and modules (some of this exists in POD form on Frontier site)
- extending pg
- how to get support
- contributing to the webwork project (patches, donations, etc)
(this list originally from Message-ID: <20031001034004.A92569@gate.math.rochester.edu>)
-- Main.SamHathaway - 10 Nov 2003
Docs on webhost that are still valuable
Found on the TWiki:
There is quite a bit of documentation written for WebWorK 1.x. Some of it is still applicable to WeBWorK 2, including:
- The educational goals of WeBWorK
- Comparing WeBWorK to CAPA
- How students use WeBWorK
- How instructors use WeBWorK
- Managing a WeBWorK course
- PG language reference
-- Main.SamHathaway - 24 Aug 2004