MoodleDocs - User contributions [en]

Assignment

2011-11-23T00:12:16Z

Ghenrick:

{{Work in progress}}
{{Infobox Project
|name = Assignment module
|state = Scoping
|tracker = TBA
|discussion = TBA
|assignee = Netspot
}}
{{Moodle 2.3}}

== Project goals ==
To redevelop the Moodle Assignment Module to address common problems around usability and extensibility and to implement web services to ease integration with third party tools, and address common needs of the user community which are currently not met.

The following four problems have been highlighted requiring attention:
* The four core subtypes are confusing to new users, and are in fact all very similar.
* There is no good support for team-based assignments.
* The support of subtypes makes it slightly easier to write new assignment types but also makes them less flexible, and so people tend to create hacks
* Third party tools such as Lightwork and the Moodle mobile app require the use of web services to be able to access all functionality of Moodle

== Scope ==
* resolution of the four problems identified by HQ
* implementing features desired by the Electronic Assignment Management (EAM) Consortium and the Moodle community as time and funding permits. The project may be split into phases to allow prioritisation of development work.

These four problems may be addressed by collapsing the four assignment subtypes into one assignment type which supports:
* Teacher-written text to students
* Teacher-supplied files to students
* Student-written text for teacher
* Student-supplied files for teacher

The assignment activity should support groups and groupings not just from the teacher perspective (for grading purposes) but also for students, such that, if desired, teams of students can submit assignments by sharing uploading to a common file area and entering text into a shared text response. A grade for a group submission would apply to all students but would allow manual overriding for individual students. This may be achieved though a new setting in the assignment module.

Logging of activity in the assignment module will be even more important than previously if multiple students can modify each others' (common) work.

The framework of the assignment module should allow for other activity modules to declare themselves "Assignments" such that they can be grouped in the UI if required.

A facility will need to be provided (through lib/assignmentlib.php) to convert assignment from the old four-pronged Assignment module to the new Assignment module with the appropriate settings.

The Assignment module needs to provide web services which allow other tools to view, contribute, submit and grade assignments.

== Use Cases ==
=== Use Case 1: File Upload Assignment ===
In a traditional use case a teacher may require the students to write an essay and submit the file to Moodle for grading. So far, the "Upload a Single File" and "Advanced Uploading of Files" Assignment types have been used. ("Upload a Single File" does not allow the teacher to upload a response file, whereas "Advanced Uploading" does).

With editing turned on, the teacher would select "Assignment" from the "Add an Activity" dropdown menu.
The teacher specifies a name, description, available from and available to dates and times and a grade for the assignment.
The teacher specifies the maximum number of files a student is allowed to submit, and the size per file (or all files together?).

Once the assignment opens, each student opens the assignment activity and uploads their files form their computer. This may be done over several visits. When the required files are uploaded, the student presses a button to indicate this and the assignment is locked from further changes by the student. (THis is the Send for marking/Draft mode behaviour of the Advanced file upload)

This process described does not have any facility for the teacher to upload a file with instructions for the students, or a data file to process in the assignment. THis is a common request and should be added.

=== Use Case 2: Statistics Assignment ===
The Teacher wishes to provide the students with a data file which is to be processed. The students will have to supply output from a statistics program with graphs and a report written in a word processor to complete the assignment.

This is similar to Use Case 1 but the teacher uploads the data file as a assignment instruction file when creating the assignment.

=== Use Case 3: Anonymous marking ===
# Teacher creates the assignment with normal settings
# Teacher select to use Anonymous marking for this assignment
# Teacher selects the "post" or go live date for the results (this is also the date which the teacher will see student names for assignments)
# Students upload the assignments
# The papers are giving a unique submissionID for referencing
# Teacher / or Non-editing teacher then downloads the file with no access to knowing who the student is just the submissionID
# Teacher then grades the assignment
# When the post date / go live date arrives, grades are posted to the gradebook and the teacher can now see names in the activity

=== Use Case 4: Offline Assignment ===

=== Use Case 5: Zip & download, offline marking ===

=== Use Case 6: Student uploads assignment, would like to retract file ===

=== Use Case 7: Students work in teams and submit one common set of files. All students receive the same grade ===

=== Use Case 8: Students work in teams and submit one common set of files. All students receive individual grades based on their contributions ===

=== Use Case 9: Individual assignments, but a teacher only marks assignments in one group ===

=== Use Case 10: Online Text ===

=== Use Case 11: Second Marking process ===

There are a number of second marking methods this is one common process.

The first marker assesses and provides comments and awards a mark
The second marker checks the grading and comments of the first marker to check for fairness and consistency in standards. This includes the calculation of the grade/marks.

This may be done for (and option should be available for)
* all the submissions
* a random sample of submissions
* any fails
* firsts
* borderlines

There is also another common use case

Double blind marking
* This is where both markers mark the paper without reference to each other
* They ensure there is a clear audit trail for the rationale of the marks
* they then reconcile the marks through discussion and agree final mark and comments.

== Mock-Ups ==

== Implementation Plan ==
Once specifications have been collected the project will be split into phases based on the importance of features - the four problems will be addressed in the first phase.

== Database Schema ==

Assignment

2011-11-22T23:48:34Z

Ghenrick:

{{Work in progress}}
{{Infobox Project
|name = Assignment module
|state = Scoping
|tracker = TBA
|discussion = TBA
|assignee = Netspot
}}
{{Moodle 2.3}}

== Project goals ==
To redevelop the Moodle Assignment Module to address common problems around usability and extensibility and to implement web services to ease integration with third party tools.

The following four problems have been highlighted requiring attention:
* The four core subtypes are confusing to new users, and are in fact all very similar.
* There is no good support for team-based assignments.
* The support of subtypes makes it slightly easier to write new assignment types but also makes them less flexible, and so people tend to create hacks
* Third party tools such as Lightwork and the Moodle mobile app require the use of web services to be able to access all functionality of Moodle

These goals are to be achieved by collapsing the four assignment subtypes into one assignment type which supports:
* Teacher-written text to students
* Teacher-supplied files to students
* Student-written text for teacher
* Student-supplied files for teacher

The assignment activity should support groups and groupings not just from the teacher perspective (for grading purposes) but also for students, such that, if desired, teams of students can submit assignments by sharing uploading to a common file area and entering text into a shared text response. A grade for a group submission would apply to all students but would allow manual overriding for individual students. This may be achieved though a new setting in the assignment module.

Logging of activity in the assignment module will be even more important than previously if multiple students can modify each others' (common) work.

The framework of the assignment module should allow for other activity modules to declare themselves "Assignments" such that they can be grouped in the UI if required.

A facility will need to be provided (through lib/assignmentlib.php) to convert assignment from the old four-pronged Assignment module to the new Assignment module with the appropriate settings.

The Assignment module needs to provide web services which allow other tools to view, contribute, submit and grade assignments.

== Use Cases ==
=== Use Case 1: File Upload Assignment ===
In a traditional use case a teacher may require the students to write an essay and submit the file to Moodle for grading. So far, the "Upload a Single File" and "Advanced Uploading of Files" Assignment types have been used. ("Upload a Single File" does not allow the teacher to upload a response file, whereas "Advanced Uploading" does).

With editing turned on, the teacher would select "Assignment" from the "Add an Activity" dropdown menu.
The teacher specifies a name, description, available from and available to dates and times and a grade for the assignment.
The teacher specifies the maximum number of files a student is allowed to submit, and the size per file (or all files together?).

Once the assignment opens, each student opens the assignment activity and uploads their files form their computer. This may be done over several visits. When the required files are uploaded, the student presses a button to indicate this and the assignment is locked from further changes by the student. (THis is the Send for marking/Draft mode behaviour of the Advanced file upload)

This process described does not have any facility for the teacher to upload a file with instructions for the students, or a data file to process in the assignment. THis is a common request and should be added.

=== Use Case 1: Statistics Assignment ===
The Teacher wishes to provide the students with a data file which is to be processed. THe students will have to supply output from a stats program with graphs and a report written in a word processor to complete the assignment.

This is similar to Use Case 1 but the teacher uploads the data file as a assignment instruction file when creating the assignment.

=== Use Case 3: Anonymous marking ===
Teacher creates the assignment with normal settings
Teacher select to use Anonymous marking for this assignment
Teacher selects the "post" or go live date for the results (this is also the date which the teacher will see student names for assignments)
Students upload the assignments
The papers are giving a unique submissionID for referencing
Teacher / or Non-editing teacher then downloads the file with no access to knowing who the student is just the submissionID
Teacher then grades the assignment
When the post date / go live date arrives, grades are posted to the gradebook and the teacher can now see names in the activity

== Mock-Ups ==

== Implementation Plan ==

== Database Schema ==

Assignment

2011-11-22T23:48:10Z

Ghenrick:

{{Work in progress}}
{{Infobox Project
|name = Assignment module
|state = Scoping
|tracker = TBA
|discussion = TBA
|assignee = Netspot
}}
{{Moodle 2.3}}

== Project goals ==
To redevelop the Moodle Assignment Module to address common problems around usability and extensibility and to implement web services to ease integration with third party tools.

The following four problems have been highlighted requiring attention:
* The four core subtypes are confusing to new users, and are in fact all very similar.
* There is no good support for team-based assignments.
* The support of subtypes makes it slightly easier to write new assignment types but also makes them less flexible, and so people tend to create hacks
* Third party tools such as Lightwork and the Moodle mobile app require the use of web services to be able to access all functionality of Moodle

These goals are to be achieved by collapsing the four assignment subtypes into one assignment type which supports:
* Teacher-written text to students
* Teacher-supplied files to students
* Student-written text for teacher
* Student-supplied files for teacher

The assignment activity should support groups and groupings not just from the teacher perspective (for grading purposes) but also for students, such that, if desired, teams of students can submit assignments by sharing uploading to a common file area and entering text into a shared text response. A grade for a group submission would apply to all students but would allow manual overriding for individual students. This may be achieved though a new setting in the assignment module.

Logging of activity in the assignment module will be even more important than previously if multiple students can modify each others' (common) work.

The framework of the assignment module should allow for other activity modules to declare themselves "Assignments" such that they can be grouped in the UI if required.

A facility will need to be provided (through lib/assignmentlib.php) to convert assignment from the old four-pronged Assignment module to the new Assignment module with the appropriate settings.

The Assignment module needs to provide web services which allow other tools to view, contribute, submit and grade assignments.

== Use Cases ==
=== Use Case 1: File Upload Assignment ===
In a traditional use case a teacher may require the students to write an essay and submit the file to Moodle for grading. So far, the "Upload a Single File" and "Advanced Uploading of Files" Assignment types have been used. ("Upload a Single File" does not allow the teacher to upload a response file, whereas "Advanced Uploading" does).

With editing turned on, the teacher would select "Assignment" from the "Add an Activity" dropdown menu.
The teacher specifies a name, description, available from and available to dates and times and a grade for the assignment.
The teacher specifies the maximum number of files a student is allowed to submit, and the size per file (or all files together?).

Once the assignment opens, each student opens the assignment activity and uploads their files form their computer. This may be done over several visits. When the required files are uploaded, the student presses a button to indicate this and the assignment is locked from further changes by the student. (THis is the Send for marking/Draft mode behaviour of the Advanced file upload)

This process described does not have any facility for the teacher to upload a file with instructions for the students, or a data file to process in the assignment. THis is a common request and should be added.

=== Use Case 1: Statistics Assignment ===
The Teacher wishes to provide the students with a data file which is to be processed. THe students will have to supply output from a stats program with graphs and a report written in a word processor to complete the assignment.

This is similar to Use Case 1 but the teacher uploads the data file as a assignment instruction file when creating the assignment.

=== Use Case 3: ===
Anonymous marking
Teacher creates the assignment with normal settings
Teacher select to use Anonymous marking for this assignment
Teacher selects the "post" or go live date for the results (this is also the date which the teacher will see student names for assignments)
Students upload the assignments
The papers are giving a unique submissionID for referencing
Teacher / or Non-editing teacher then downloads the file with no access to knowing who the student is just the submissionID
Teacher then grades the assignment
When the post date / go live date arrives, grades are posted to the gradebook and the teacher can now see names in the activity

== Mock-Ups ==

== Implementation Plan ==

== Database Schema ==

Talk:Portfolio API

2008-07-01T00:43:07Z

Ghenrick:

===Comments on specification===

Please leave your name and indent according to reply structure.

===Comments from Tim Hunt===

====Do we have to restrict it so that only admins can configure repositories====

Here is an example user story:

A course somewhere out there about good online teaching requires students to participate in an online community, say, Moodle.org, and record evidence of their activity to their Portfolio. Moodle.org is a nice open place, so wants to help this sort of thing. Therefore, Martin configures it so that any user can go to their user profile, and configure any portfolio plugin for their own use, so students on this course can easily export from moodle.org to their own Portfolio.

Similarly, this may be a way to deal with Facebook authentication issues. Each student configures the facebook plugin for themselves, including some sort of secret key.

=====Penny's reply=====

Hmm. I agree with your user story but I'm not sure of the implications of it. At any rate, the portfolio plugin system must support multiple instances of a plugin being configured (iirc, this will be the first instance of this in moodle?) but then in terms of permissions I'm not sure how it would work - it's almost a new context level - so that any user could configure a plugin instance and then grant access. I think it should definitely be able to be turned off though (by an admin)

[[User:Martin Dougiamas|Martin Dougiamas]] 04:11, 24 June 2008 (CDT) Absolutely agree with Tim's picture, that is the same way the repositories API will work. Yes, the admin should choose to allow users to configure their own portfolios. This is basically saving user preferences for each plugin type, and could be part of the "save" process (use checkbox to save this portfolio for next time).

Yeah but still we have the model of admins creating instances of plugins and users can just configure them. They can't create their own instances - [[User:Penny Leach|Penny Leach]]

====Do we really need transport APIs====

I am not if transport layers really need to be pluggable APIs as such. Surely almost all Portfolio plugins will use a single transport method.

Of course, each transport method will have a library of code, for example a SOAP library, or the mnet libraries, and the Portfolio plugins will use these, but I don't see any need for all the transport mechanisms to implement some common interface. Different transport mechanisms work very differently, and tend to have different interfaces in their standard libraries. Trying to put a common wrapper round all of them seems difficult and unnecessary to me.

=====Penny's reply=====

Well theoretically moodle-moodle and moodle-mahara would both use mnet, although I guess you're right that it might be overly difficult. I was trying to avoid multiple wrappers around the same library. We started off as having formats as a plugin too and moved away from it in favour of libraries. I wonder if we gain anything in terms of test framework by adhering to one API for transport layers (think mock objects).. I'll ask Nico.

=====Nico's reply=====

I am fine with the idea of using libraries directly in portfolio/repository code, BUT with the following requirements:
* Libraries must be object-oriented
* The Transport object must be a member variable of the Portfolio class
There is no way to do proper unit testing without proper object orientation. If there is to be only one transport method per portfolio instance, then it should be a private member with public setters/getters. This will allow unit tests to mock the transport object, and test the portfolio code without having to worry about the transport code.

Here is some pseudo-code:

<?php
$portfolio = new PortFolio();
$transport = new Transport_Mnet();
$portfolio->set_transport($transport);
?>

<?php
class Portfolio {
private $transport;

function query($query) {
$this->transport->query($query);
}
}

===Comments from Gavin Henrick===

====Content & Formats / Meta data====

2 examples to think on:
case1. A user exports his thesis to his portfolio, you get the meta data from the install/course/grade/anything he adds and the file (any type)
case2. A user exports his forum post to his portfolio, you get the meta data from the install/course/grade/forum, you get his content of his post (txt/html?) and optionally have a file (any type)
case3. A user exports his case history from a database module which has 4 graphics files in it. you get the meta data from the install/course/grade/database instance, you get his content of entry(txt/html?) and the files

IN the first case, you end up with meta data and a file of some type to export, how can a user define export format when its unlikely all will have servers capable of transforming to the chosen format.

In the second case, you have data, content (txt) and a file of some format - again how can you transpose the content and the file and data into any given format?

When we did the export we had the the end result as up to N files, the xml file(this is the meta data and could be csv,rtf, or html too), the html content file and the raw files which may be attached. Depending on where it is going, the meta data may end up as fields being pushed with the file, or so on. but i think holding it in a workable object (xml object or something else would be useful.

Therefore I would propose that txt level output + files this be the lowest common denominator since everyone can generate it. xml,csv, or html for the meta data, and txt or html or rtf (since not all will be able to generate pdfs, and some content isnt that great in some pdf engines).

Obviously the design leaves room for those who may xpose into pdf the doc, ppt etc attachments, and so on (we automate this for some clients on a seperate box using open office)

====User Actions====

Pertaining mostly to portfolios, and perhaps student workspaces, some have asked about automating this completely. I think if you look at the stages
- initiating xfer
- meta data

Could we not have a flag (per course? or instance or student?) perhaps to automate the transfer once something is complete (submitted graded etc..). It may also be useful to have an admin action to initiate this for all students "send all student data to portfolio"

Could we not have a flag to not prompt students for more data as the people we have talked to mostly want this to be a "2 click" event, choose to export and confirm. I think it may be more difficult and create a barrier to use if students are prompted for meta data, so having this optional at admin level would be good.

So a default simple install would automatically xfer all finalised content on enable modules to the students portfolio so they have it whether they forget to do so or not.

Talk:Portfolio API

2008-07-01T00:33:02Z

Ghenrick: