Skip to content

Latest commit

 

History

History
178 lines (114 loc) · 6.42 KB

xml_schema.md

File metadata and controls

178 lines (114 loc) · 6.42 KB

Group Project XBlock Xml Schema Information

<group_project>

Top level node

Attributes

schema_version Optional - currently supporting only the value '1' while under development

Child Nodes

resources Optional

submissions Optional

dates Optional

projectcomponent Required

<resources>

Node defining which external resources (authored by instructor or others) provide useful information about the project

Attributes

None

Child Nodes

document Required

<submissions>

Node defining which documents are required to be uploaded by the group in order to complete the project

Attributes

None

Child Nodes

document Required

<dates>

Node highlighting the important dates for this project

Attributes

None

Child Nodes

milestone Required

<projectcomponent>

Node defining a stage for a group project

Attributes

name Required - Stage Name: This is displayed as the name of the item within the application

id Required - Stage id: This is used to uniquely identify the stage

open Optional - Refers to a milestone date defined within dates. This is considered the date at which this content is available to be viewed by the end user

close Optional - Refers to a milestone date defined within dates. This is considered the date at which this content is considered to be closed, and will accept no more input

Child Nodes

section Optional - Defines a section within the page

peerreview Optional - Wrapper around section nodes that are designed to be shown for peer review

projectreview Optional - Wrapper around section nodes that are designed to be shown for project review

peerassessment Optional - Wrapper around section nodes that are designed to be shown for peer assessment

projectassessment Optional - Wrapper around section nodes that are designed to be shown for project assessment

<document>

A document definition, for either an existing document or a document to be provided by the group

Attributes

title Required - Title of document

description Optional - Description of document

grading_criteria Optional - a value of "true" indicates that this document is also considered to hold information about the criteria used to grade the project

Child Nodes

Content represents the url from which the document may be downloaded. Note that submissions documents will have not text content

<milestone>

Node defining a significant date during the course of running the group project

Attributes

name Required - Name of the milestone that this date represents

Child Nodes

Content represents the milestone date Using the US format of m/d/y

<section>

Node describing content to display within the page

Attributes

title Optional - Title to display above the section within the browser

file_links Optional - file links to display after the section content has been displayed: value is one of resources, submissions or grading_criteria (Note that resources include grading criteria, and grading_criteria displays only the resource(s) that is marked as such)

Child Nodes

content Optional - contains HTML to include within the document (Note that XHTML syntax should be used to allow Xml document to be validated as Xml)

question Optional - question to ask for review target (only valid within peerreview and projectreview nodes

assessment Optional - location to show review results from feedback

<peerreview>

Node to define sections to be associated with specific peer selection Note that it is important to provide a node with class "peers" in a section/content node within the same projectcomponent, but outside of the scope of this peerreview node - this node is injected with the peers within the user's group

Attributes

None

Child Nodes

section - Required - section(s) to display peer review questions

<projectreview>

Node to define sections to be associated with specific group review selection Note that it is important to provide a node with class "other_groups" in a section/content node within the same projectcomponent, but outside of the scope of this projectreview node - this node is injected with the groups for whom the user has been chosen to provide feedback

Attributes

None

Child Nodes

section - Required - section(s) to display project review questions

<peerassessment>

Node to define sections to display the feedback that the user has recieved from her/his peers. Note that it is important to provide a link with the following definition in a section/content node within the same projectcomponent, but outside of the scope of this peerassessment node - this link tells the xblock to show/hide the peer assessments (You can provide custom content):

<a data-showid="team_feedback" class="view_feedback">Team Feedback</a>

Attributes

None

Child Nodes

section - Required - section(s) to display peer review assessments from others

<projectassessment>

Node to define sections to display the feedback that the group has recieved from others about their project. Note that it is important to provide a link with the following definition in a section/content node within the same projectcomponent, but outside of the scope of this projectassessment node - this link tells the xblock to show/hide the project assessments (You can provide custom content):

<a data-showid="cohort_feedback" class="view_feedback">Cohort Feedback</a>

Attributes

None

Child Nodes

section - Required - section(s) to display peer review assessments from others

<content>

Node to contain HTML content to be displayed within the page

Attributes

None

Child Nodes

Content contains HTML - Note that XHTML syntax will ensure that xml document validation passes

<question>

Node to represent a question to be asked of a peer or of anohter groups' project

Attributes

id - Required - small string stored alongside answer data

Child Nodes

label - Required - Text (html) for the question being asked

answer - Required - HTML for form element in which to collect information

<assessment>

Node for user to see the feedback given from peers and project reviewers

Attributes

id Required - Must match id of question prefixed with assess_

Child Nodes

label - Required - Text (html) for the question that was asked

answer - Required - HTML in which to inject data