Set Definition Files

From WeBWorK
(Difference between revisions)
Jump to: navigation, search
Line 47: Line 47:
  
 
;<code>capTimeLimit</code>
 
;<code>capTimeLimit</code>
 +
 +
If IP restrictions are to be used, the following fields may also be present:
 +
 +
;<code>restrictIP</code>
 +
 +
;<code>restrictLocation</code>
 +
 +
;<code>relaxRestrictIP</code>
 +
 +
The meanings of these fields are described in [[Gateway Tests and Quizzes##Set_Definition_Files_for_Gateway.2FQuiz_Assignments]].
  
 
== Problem list ==
 
== Problem list ==
Line 54: Line 64:
 
  problemList =  
 
  problemList =  
  
No value should follow the <code>=</code>. The remainder of the file is interpreted as comma-separated values. Each line represents one problem in the set. The fields are as follows:
+
No value should follow the <code>=</code>. The remainder of the file is interpreted as comma-separated values. Each line represents one problem in the set. Commas are allowed in values as <code>\,</code>. The fields are as follows:
 
+
  
 +
# The path to the PG '''source file''', relative to the course <code>templates</code> directory.
 +
# The '''value''', or "weight", of the problem. If no value is given, a weight of <code>1</code> is used.
 +
# The '''maximum number of attempts''' allowed for the problem. If no value is given, unlimited attempts are allowed.
  
 
[[Category:Instructors]]
 
[[Category:Instructors]]

Revision as of 00:53, 1 March 2008

A set definition file is a text file used to transferring homework set data between WeBWorK courses. It contains all the non-user-specific data pertaining to the homework set.

A set definition file consists of two sections. The first section is a line-based list of set data. The second part is a list of problems in the problem set. Blank lines are ignored, as is anything after a #.

Set data

The set data section starts at the beginning of the file. Each line of the set data section is of the form

fieldName = field value ...

The following fields are recognized:

openDate
The open date (and time) of the set; before this time students will not be allowed to view the set.
dueDate
The due date (and time) of the set; before this time students will not be allowed to submit answers for credit.
answerDate
The answer date (and time) of the set; after this time students will be allowed to view the correct answers and solutions for the problems in the set.
paperHeaderFile
Path to a PG file to use as the hardcopy header for the set. If not present, the course or system default is used. See also: Header Files and Snippets.
screenHeaderFile
Path to a PG file to use as the set header for the set. If not present, the course or system default is used. See also: Header Files and Snippets.

If the homework set is a gateway test, the following fields may also be present:

assignmentType
attemptsPerVersion
timeInterval
versionsPerInterval
versionTimeLimit
problemRandOrder
problemsPerPage
hideScore
hideWork
capTimeLimit

If IP restrictions are to be used, the following fields may also be present:

restrictIP
restrictLocation
relaxRestrictIP

The meanings of these fields are described in Gateway Tests and Quizzes##Set_Definition_Files_for_Gateway.2FQuiz_Assignments.

Problem list

The problem list section starts with the line

problemList = 

No value should follow the =. The remainder of the file is interpreted as comma-separated values. Each line represents one problem in the set. Commas are allowed in values as \,. The fields are as follows:

  1. The path to the PG source file, relative to the course templates directory.
  2. The value, or "weight", of the problem. If no value is given, a weight of 1 is used.
  3. The maximum number of attempts allowed for the problem. If no value is given, unlimited attempts are allowed.
follow us