diff --git a/doc/public/course_xml.rst b/doc/public/course_xml.rst index 148bb4491c..5cab3c6c1d 100644 --- a/doc/public/course_xml.rst +++ b/doc/public/course_xml.rst @@ -365,32 +365,56 @@ Available metadata Not Inherited -------------- -* `display_name` - name that will appear when this content is displayed in the courseware. Useful for all tag types. -* `format` - subheading under display name -- currently only displayed for chapter sub-sections. Also used by the the grader to know how to process students assessments that the - section contains. New formats can be defined as a 'type' in the GRADER variable in course_settings.json. Optional. (TODO: double check this--what's the current behavior?) -* `hide_from_toc` -- If set to true for a chapter or chapter subsection, will hide that element from the courseware navigation accordion. This is useful if you'd like to link to the content directly instead (e.g. for tutorials) -* `ispublic` -- specify whether the course is public. You should be able to use start dates instead (?) +`display_name` + Name that will appear when this content is displayed in the courseware. Useful for all tag types. + +`format` + Subheading under display name -- currently only displayed for chapter sub-sections. Also used by the the grader to know how to process students assessments that the section contains. New formats can be defined as a 'type' in the GRADER variable in course_settings.json. Optional. (TODO: double check this--what's the current behavior?) + +`hide_from_toc` + If set to true for a chapter or chapter subsection, will hide that element from the courseware navigation accordion. This is useful if you'd like to link to the content directly instead (e.g. for tutorials) + +`ispublic` + Specify whether the course is public. You should be able to use start dates instead (?) Inherited --------- -* `start` -- when this content should be shown to students. Note that anyone with staff access to the course will always see everything. -* `showanswer` - When to show answer. For 'attempted', will show answer after first attempt. Values: never, attempted, answered, closed. Default: closed. Optional. -* `graded` - Whether this section will count towards the students grade. "true" or "false". Defaults to "false". -* `rerandomize` - Randomize question on each attempt. Values: 'always' (students see a different version of the problem after each attempt to solve it) - 'onreset' (randomize question when reset button is pressed by the student) - 'never' (all students see the same version of the problem) - 'per_student' (individual students see the same version of the problem each time the look at it, but that version is different from what other students see) - Default: 'always'. Optional. -* `due` - Due date for assignment. Assignment will be closed after that. Values: valid date. Default: none. Optional. -* attempts: Number of allowed attempts. Values: integer. Default: infinite. Optional. -* `graceperiod` - A default length of time that the problem is still accessible after the due date in the format "2 days 3 hours" or "1 day 15 minutes". Note, graceperiods are currently the easiest way to handle time zones. Due dates are all expressed in UCT. -* `xqa_key` -- for integration with Ike's content QA server. -- should typically be specified at the course level. +`start` + When this content should be shown to students. Note that anyone with staff access to the course will always see everything. + +`showanswer` + When to show answer. For 'attempted', will show answer after first attempt. Values: never, attempted, answered, closed. Default: closed. Optional. + +`graded` + Whether this section will count towards the students grade. "true" or "false". Defaults to "false". + +`rerandomize` + Randomize question on each attempt. Optional. Possible values: + + `always` (default) + Students see a different version of the problem after each attempt to solve it. + `onreset` + Randomize question when reset button is pressed by the student. + `never` + All students see the same version of the problem. + `per_student` + Individual students see the same version of the problem each time the look at it, but that version is different from what other students see. + `due` + Due date for assignment. Assignment will be closed after that. Values: valid date. Default: none. Optional. + `attempts` + Number of allowed attempts. Values: integer. Default: infinite. Optional. + `graceperiod` + A default length of time that the problem is still accessible after the due date in the format `"2 days 3 hours"` or `"1 day 15 minutes"`. Note, graceperiods are currently the easiest way to handle time zones. Due dates are all expressed in UTC. + `xqa_key` + For integration with Ike's content QA server. -- should typically be specified at the course level. Inheritance example ------------------- This is a sketch ("tue" is not a valid start date), that should help illustrate how metadata inheritance works. + .. code-block:: xml + -- start tue --- start tue @@ -404,10 +428,12 @@ This is a sketch ("tue" is not a valid start date), that should help illustrate Specifying metadata in the XML file ----------------------------------- -Metadata can also live in the xml files, but anything defined in the policy file overrides anything in the xml. This is primarily for backwards compatibility, and you should probably not use both. If you do leave some metadata tags in the xml, you should be consistent (e.g. if `display_name`s stay in xml, they should all stay in xml. Note `display_name` should be specified in the problem xml definition itself, ie, Problem Text , in file ProblemFoo.xml). - - note, some xml attributes are not metadata. e.g. in `