MoodleDocs - User contributions [en]

Roles

2006-08-14T12:15:08Z

Hatshepsut: /* Enrolment-level Capabilities */

'''Roles and permissions''' will be in Moodle 1.7 and are available in the developer version of Moodle.

==Definitions==

A role is an identifier of the user's status in some context, for example, teacher, student and forum moderator are examples of roles.

A capability is a description of some particular Moodle feature. Capabilities are associated with roles. For example, ''mod/forum:replypost'' is a capability.

A permission is some value that is assigned for a capability for a particular role. For example, allow or prevent.

A context is a "space" in the Moodle, such as courses, activity modules, blocks etc.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

{{Moodle 1.7}}The new system will allow authorized users to define an arbitrary number of roles (eg a teacher)

A role consists of a list of permissions for different possible actions within Moodle (eg delete discussions, add activities etc)

Roles can be applied to users in a context (eg assign Fred as a teacher in a particular course)

Here are the possible contexts, listed from the most general to the most specific.

#CONTEXT_SYSTEM
#CONTEXT_PERSONAL
#CONTEXT_USERID
#CONTEXT_COURSECAT
#CONTEXT_COURSE
#CONTEXT_GROUP
#CONTEXT_MODULE
#CONTEXT_BLOCK

An authorized user will be able to assign an arbitrary number of roles to each user in any context.

Capabilities can have the following permissions:

#CAP_INHERIT
#CAP_ALLOW
#CAP_PREVENT
#CAP_PROHIBIT

If no permission is defined, then the capability permission is inherited from a context that is more general than the current context. If we define different permission values for the same capability in different contexts, we say that we are overriding the capability in the more specific context.

Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by enforcing the rule that the capability defined for a more specific context will win, unless a prohibit is encountered in a less specific context.

For example, Mark has a student role at course level, which allows him to write into a wiki. But Mark also got assigned a Visitor role at a module context level (for a particular wiki) which prevents him from writing to the wiki (read only). Therefore, for this particular wiki, Mark will not be able to write to the wiki since the more specific context wins.

If we set a prohibit on a capability, it means that the capability cannot be overridden and will always have a permission of prevent (deny). Prohibit always wins. For example, Jeff has a naughty student role that prohibits him from postings in any forums (for the whole site), but he's also assigned a facilitator role in "Science forum" in the course Science and Math 101. Since prohibit always wins, Jeff is unable to post in "Science forum".

Allow and prevent will cancel each other out if set for the same capability at the same context level. If this happens, we refer to the previous context level to determine the permission for the capability.

This may sound more complex than it really is in practice. The upshot is that the system can be flexible enough to allow any combination of permissions.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the existing capabilities will be automatically retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, mirroring what we have in 1.6. With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==Capabilities==

This will be a comprehensive list of capabilities (it's not complete yet). It is important that capability names are unique.

===Core-level Capabilities===

Moodle core capability names start with 'moodle/'. The next word indicates what type of core capability it is, and the last word is the actual capability itself. The capabilities for the Moodle core are defined in lib/db/access.php

#moodle/legacy:guest - legacy capabilities are used to transition existing users to the new roles system during the upgrade to Moodle 1.7
#moodle/legacy:student
#moodle/legacy:teacher
#moodle/legacy:editingteacher
#moodle/legacy:coursecreator
#moodle/legacy:admin
#moodle/site:doanything - special capability, meant for admins, if is set, overrides all other capability settings
#moodle/site:config - applicable in admin/index.php and config.php (might break down later) : 1)admin/config.php 2)admin/configure.php 3)blocks/admin/block_admin.php load_content_for_site()
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now) : 1)_add_edit_controls moodleblock.class.php
#moodle/site:backup - can create a course backup : 1)course/category.php 2)block_admin.php
#moodle/site:restore - can restore into this context : 1)course/category.php 2)block_admin.php
#moodle/site:import - can import other courses into this context : 1)block_admin.php
#moodle/site:accessallgroups - able to access all groups irrespective of what group the user is in
#moodle/blog:view - read blogs
#moodle/blog:create - write new blog posts
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use
#moodle/blog:manageentries - edit/delete all blog entries
#moodle/course:create - create courses : 1)course/edit.php 2)course/category.php 3)course/index.php
#moodle/course:delete - create courses : 1)course/category.php
#moodle/course:update - update course settings
#moodle/course:view - can use this to find participants
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:viewscales - view scales (i.e. in a help window?) : 1)course/scales.php
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)
#moodle/course:managescales - add, delete, edit scales, move scales up and down : 1)blocks/block_admin.php 2)course/scales.php
#moodle/course:managegroups - managing groups, add, edit, delete : 1)course/groups.php 2)course/group.php
#moodle/course:visibility - hide/show courses : 1)course/category.php
#moodle/course:activityvisibility - hide/show activities within a course
#moodle/course:viewhiddenactivities - able to see activities that have been hidden
#moodle/category:create - create category : 1)course/index.php
#moodle/category:delete - delete category : 1)course/index.php
#moodle/category:update - update category settings : 1)course/category.php
#moodle/category:visibility - hide/show categories : 1)course/index.php
#moodle/user:create - create user : 1) user/edit.php
#moodle/user:delete - delete user : 1) admin/user.php
#moodle/user:update - update user settings : 1) user/edit.php
#moodle/user:viewdetails - view personally-identifying user details (e.g. name, photo). This ties in with the "visitor" scenario described below.
#moodle/calendar:manageownentries - create/edit/delete
#moodle/calendar:manageentries - create/edit/delete
#moodle/role:assign - assign roles to users
#moodle/role:manage - create/edit/delete roles, set capability permissions for each role

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The part before the colon is the full path to the module in the Moodle code. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:view- reading the assignment description
##mod/assignment:submit - turn assignment in
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entries
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:viewhiddentimedposts
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:viewrating
##mod/forum:viewanyrating
##mod/forum:rate
##mod/forum:createattachment
##mod/forum:deleteownpost
##mod/forum:deleteanypost
##mod/forum:splitdiscussions
##mod/forum:movediscussions
##mod/forum:editanypost
##mod/forum:viewqandawithoutposting
##mod/forum:viewsubscribers
##mod/forum:managesubscriptions
##mod/forum:throttlingapplies
#Glossary
##mod/glossary:view - read entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:viewrating - view ratings
#Hotpot
##mod/hotpot:view
#Label
##none
#Lams
##TBD
#Lesson
##TBD
#Quiz
##TBD
#Resource
##mod/resource:view
#Scorm
##mod/scorm:view
##mod/scorm:viewgrades
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
##Waiting on new wiki
#Workshop
##Waiting on new Workshop

===Enrolment-level Capabilities===

The naming convention for capabilities that are specific to enrolment is 'enrol/enrol_name:capability'. The enrolment capabilities are defined in enrol/enrol_name/db/access.php.

#Authorize.net Payment Gateway
##enrol/authorize:managepayments - manage user payments, capture, void, refund, delete etc.

Will it be possible to enroll people into different roles in a course as part of the enrollment process itself? I mean could you have an option to self-enroll (either involving payment or not) into multiple roles? In fact, will there be any possibility of a student self-selecting a role for themselves, but no one else but themselves?--[[User:N Hansen|N Hansen]] 02:00, 14 August 2006 (WST)

===Blocks===

===Questions===
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].

See [http://moodle.org/mod/forum/discuss.php?d=51143 this forum thread] for a discussion about the current problems wth publishing question categories.[[User:Tim Hunt|Tim Hunt]] 18:50, 8 August 2006 (WST)

==Programming Interface==

Although the Roles system may look complicated at first glance, implementing it in Moodle code is fairly simple.

* You need to define each capability once, so that Moodle can upgrade existing roles to take advantage of it. You do this in an access.php inside the db folder of any module (eg see mod/forum/db/access.php). The array contains entries like this (note the descriptions for the legacy roles which provides forward compatibility):
'mod/forum:viewforum' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'legacy' => array(
'guest' => CAP_PREVENT,
'student' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'coursecreator' => CAP_ALLOW,
'admin' => CAP_ALLOW
)
),
* To load/change these capabilities you need to bump the module version. There's no need to provide changes or differences as Moodle will scan the whole array and sort it out.
* On each page you need to find the context the user is working in, using the get_context_instance() function. For example, in the forum module:

$context = get_context_instance(CONTEXT_MODULE, $cm->id);
* Then, whenever you want to check that the current user has rights to do something, call has_capability() like this:
if (!has_capability('mod/forum:viewforum', $context)) {
print_error('nopermissiontoviewforum');
}
* If you just want to assert a capability and then finish with an error message if it's not met (as we did above), then a shorter way it to use require_capability() like this:

require_capability('mod/forum:viewforum', $context);

* Note that there are extra parameters you can specify to get a custom error message, otherwise users get an automated "No permissions" message that lists the permission they were missing.

As a result of the new Roles System, all calls to isadmin(), iscoursecreator, isteacheredit(), isteacher(), isstudent(), and isguest() will have to be replaced with calls to has_capability() or require_capability(). However, these functions will be retained for some backward compatibility with old code, using the legacy capabilities to try and work out what to do.

==Scenario brainstorming==

This section is for brainstorming some example roles that we would like to support. Note some of these *may* not be possible in 1.7.

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===Peer observer of teaching===
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY=3+4 yr olds) and Key Stage 1 (KS1=5+6 yr olds) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary. In Key Stage 2 (KS2=7-11 yr olds) parents would be more monitoring but may join in as well.

In Key stages 3 (KS3=12-14 yr olds) and 4 (KS4=15+16 yr olds) this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments. Also in all Key Satges there may be a home-school agreement which may be signed up to. Could this form part of a site policy system that incorporates a tickable list of activities the parent agrees to the child using (blogs/wikis/forums etc.)?

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

Again in the UK, parents have their own independent right of access to a child's educational records. Obviously, children's records must not be made available to other parties, including the parents of other children in the same class. Thus it would be necessary to associate parent accounts with their own child's accounts in such a way that they could, if so desired, have read access to their child's grades, answers and contributions, but generally not those of other children - this may be problematic in the case of wiki activities or forum posts.

There is some concern that children's forum contributions etc may be constrained if their parents are able to read all that they write; this may be particularly problematic in areas such as Personal, Social and Health Education (PSHE), where some schools may choose to use obfuscated usernames.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===Alumnus=== An ALUMNUS should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when an ALUMNUS is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

In schools there is often a book review system. This may be covered by the lending system database but may not in which case a librarian may neeed to have a course area they can create a database template to handle the reviews in which case they may have a normal teacher style role? Off topic but course an integration with common schools database systems would be great.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Student - FERPA rights===

A student that has asserted their FERPA rights to non-disclosure. Typically includes not publishing their name
in any public place. Could include this student only being seen with an "alias" within course spaces. Is this an attribute rather
than a role?

===Help Desk===

Help desk agents that have read access for the purposes of trouble shooting. Some care in placing this role within a hierarchy
of inheritance is needed, full access will be problematic with FERPA.

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]
[[Category:Roles]]

[[ru:Роли]]

Wikindx

2006-08-13T18:05:36Z

Hatshepsut:

'''Notes on the possible integration of [http://wikindx.sourceforge.net/index2.html WIKINDX] with Moodle.'''

[http://wikindx.sourceforge.net/index2.html WIKINDX]is a free bibliographic and quotations/notes management and article authoring system designed either for single use (on a variety of operating sytems) or multi-user collaborative use across the internet.

Please also see the Moodle Discussion at http://moodle.org/mod/forum/discuss.php?d=23022

==Wikindx filter for Moodle==

Dan Stowell has created a "Wikindx filter" for Moodle which allows you to cross-link to a wikindx entry by typing (for example) wikindx:646. The filter is in contrib CVS, named "filter_wikindx" or can be downloaded at http://download.moodle.org/download.php/modules/filter_wikindx.zip

From MG:
Some design considerations for a moodle filter that enables a wikindx to be searched, a reference to be selected, page number(s) to be added and the in-text or footnote citation and full reference to be returned formatted to the user's requirements.

NB With everything else I have going on (PhD, Wikindx, life) I have no intention of setting up Moodle for testing this (no prior experience in Moodle let alone moodle filters) but, if someone is willing to a) write the moodle filter code and b) be prepared to run beta wikindx code to test the interface, then I would be more than happy to do whatever needs to be done in the wikindx code. The wikindx code will be easy: I can't speak for the moodle code (but, see below, imagine that quite a bit of it could be pulled from wikindx). I also have no idea if moodle filters alone can accomplish what I've suggested below or if the code needs greater integration in the moodle core code.

1/ The Moodle filter needs to provide 3 basic functions:
:a) an icon in the HTML text editor that opens a pop-up,
:b) the pop up should provide a simple search/select interface to wikindx resources,
:c) once the selected wikindx resource has been inserted into the text, the moodle HTML editor text is saved and the filter sends the reference (and style and page number(s)) to wikindx for formatting and insertion into the moodle text.

2/ Because what is supplied to the pop-up (see below) requires a connection to wikindx, the filter should have a config file for the wikindx database connection details. wikindx 3.4 now allows admins to lock out read-only users so this config file may also have the option to add a wikindx username::password pair (I would not favour this though).

3/ The search interface could be similar to the wikindx Quick Search interface less the ordering options (to save on space). [WIKINDX code (filling the pop-up)]

4/ The results of a search should be displayed with multiple resources next to radio buttons, a select box to choose the formatting style and text boxes to enter page number(s). Each radio button has a value that is the unique resource ID in the wikindx. [WIKINDX code]

5/ Once the appropriate resource has been selected and other details added, clicking on a 'process' button will add the appropriate filter mark-up which may be something like:
:wikindx:34:12[APA]
:wikindx:56:34-35[CHICAGO]

where the first number is the wikindx resource ID, the second number(s) is the page and [...] is the bibliographic style chosen. [WIKINDX code]

6/ On saving the moodle text, that markup is extracted and sent to the wikindx server (something like http://....index.php&externalResourceGrab&id=56&pages=34-35&style=CHICAGO) which then formats the requested resource and provides a string in return which would consist of a serialized/base64_encoded PHP multi-dimensional array which, when unpacked, would have something like the following (if APA for example):
:array(
::[styleType] = array(
:::[0] => "inText"
::),
::[citation] = array(
:::[0] => "(Martin et al. 1978, pp.34--35)"
::),
::[reference] = array(
:::[0] => "Martin, R. L., Thrift, N. J., & Bennett, R. J. (Eds.). (1978). ''Towards the dynamic analysis of spatial systems''. London: Pion."
::)
:);

for a footnote-type citation (e.g. Chicago), it might be:
:array(
::[styleType] = array(
:::[0] => "footnote"
::),
::[citation] = array(
:::[0] => "''Towards the Dynamic Analysis of Spatial Systems''. 1978. Edited by R. L. Martin, N. J. Thrift and R. J. Bennett. London: Pion. pp.34--35"
::),
::[reference] = array(
:::[0] => "''Towards the Dynamic Analysis of Spatial Systems''. 1978. Edited by R. L. Martin, N. J. Thrift and R. J. Bennett. London: Pion."
::)
:);

NB The italics (and any underline, bold etc.) would be returned as HTML markup. [WIKINDX code]

7/ Moodle would take this array and, if [styleType] == 'footnote', insert something like '[1]' in the body of the text, [citation] as a footnote and, if required, append [reference] to a bibliography (perhaps this is just future-proofing in this case). However, if [styleType] == 'inText', [citation] would be inserted in the body of the text and [reference] appended.

8/ In the case of multiple citations, wikindx should be able to provide the second element of the array correctly ordered as per the style requirements. So you might have something like:

:array(
::[styleType] = array(
:::[0] => "inText"
::),
::[citation] = array(
:::[0] => "(Martin et al. 1978, pp.34--35)",
:::[1] => "(Aarseth et al. 2003)"
::),
::[reference] = array(
:::[0] => "Aarseth, E., Smedstad, S. M., & Sunnanå, L. (2003, November 4—6). ''A multi-dimensional typology of games''. Paper presented at Level Up, Utrecht Universiteit.",
:::[1] => "Martin, R. L., Thrift, N. J., & Bennett, R. J. (Eds.). (1978). ''Towards the dynamic analysis of spatial systems''. London: Pion."
::)
:);

In this way separate orders are maintained for the citation and the appended bibliography. [WIKINDX code]

Perhaps the above is not do-able as a simple moodle filter?

==Outline thoughts on integration...==

1. Do we need to allowing a user already logged into a Moodle site to be seamlessly logged in to a wikindx? Or maybe just use the same login details between the two (like the way that Moodle.org and MoodleDocs works). If necessary, something could be added to wikindx to enable this. In most cases though, with the right config settings, wikindx will allow any read only request without requiring login.

2. Another issue is how to integrate the paper writing function of Wikindx into Moodle. What about use of the HTML editor? Could it be integrated some way with the Netpublish module? Imagine students or professors being able to use it to write academic papers and then publish those on the Moodle site. Currently wikindx publishes papers solely to RTF. It should be simple to publish to HTML since that's what the raw document is anyway (a matter of adding HTML header/footer, formatting citations and appending bibliographies -- most of this code is already in wikindx but not (yet) made available to the word processor). Compared to other HTML editors, the only additional options wikindx offers in its version are buttons to import citations, metadata and insert footnotes. All the rest (barring stats, timestamps, save etc.) are font/text formatting.

3. For the filter above, how do you decide what bibliographic style to present in (APA, Chicago, IEEE etc.)? Presumably, this is something that could be set in the filter config file. (Although I haven't seen the filter in operation, I'm assuming it picks up a properly formatted reference for insert. Either short (Grimshaw, 2006) or long (Grimshaw, Mark N. 2006, WIKINDX [OSS].) for example. Is the only method of citation available parenthetical? Is it possible to use endnotes (or footnotes) as well? Yes, endnote/footnote styles are available as well.

:''Note from DS: No, at present the Wikindx filter simply displays the text "wikindx:646" (for example). It's a very simple start and I hope that people with more knowledge of Wikindx will be able to modify it to extract the properly-formatted reference direct from Wikindx. If wikindx had a system whereby a certain URL call would supply the reference text in whatever style was configured for wikindx, this would be a good way to display the citation nicely within Moodle. Does such a call exist? I don't think so. Something like mywikindx.com/index.php?'''action=resourceGrabCitation'''&id=501 would be required.''

:''Note from JB: As the wikindx admin can set the default bibliographic style in the config, the filter will just present that style. The filter is simple but oh so useful! So when I type '''wikindx:1''' into my moodle installation, it creates an automatic link to http://www.baillie.org.uk/wikindx//index.php?action=resourceView&id=1

:''Note from MG: action=resourceGrabCitation can be added and the default citation formatting applied. A possible gotcha in that there may be a problem with footnote/endnote style citation is that not only would you need the footnote marker (e.g. [1]) but you would also need the full reference to be appended to the text as a footnote (I'm assuming this is required rather than just using [1] as a hyperlink to the wikindx resource -- presumably you would want to use the same strict referencing that students are required to use). Hence, in this case, the returned values would consist of two values -- one the citation to be hyperlinked and the other the full reference to be appended.''

:''Note from MG: In wikindx, inserting a citation into metadata or the word processor involves clicking on an icon which opens a popup. In this, there is a select box listing short entries of all available resources and some text fields for users to enter cited page numbers. Perhaps something similar could be used in the moodle wikindx filter to avoid the hassle of having to look up the wikindx resource id before entering it into moodle. This pop-up could also list the available citation/bibliographic styles on the wikindx allowing the user to select the style with which the citation should be formatted prior to insertion into moodle.''

4. Mark, your remarks in 2 have gotten me thinking. Although not everyone likes the Moodle HTML area editor that much, it still is the standard way of creating text in Moodle and perhaps a way of integrating Wikindx would be to add buttons for Wikindx to it, just like the kind described above in Wikindx's native editor. I needed to integrate a hieroglyph editor into my site and Janne Mikkonen helped me to add it through a button in the html editor that pops up a window, in which the student type the hieroglyphs they need, and then click a button to have them inserted back into the editor-similar to the way the insert image popup works. I would imagine something similar could be done with Wikindx. The advantage of this is that it would make Wikindx accessible anywhere within Moodle, rather than just as a separate module. You might also want a standalone module option whereby students could collaborate on creating bibliographies together.

:''Note from MG: Adding the appropriate buttons would be my suggestion. In wikindx, citations are added by the popup automatically adding something like''
:''[cite]146:22-23[/cite]''
:''where 146 is the resource ID in the database and 22-23 are the page nos. This can be added via a cite button or will be appended to an inserted quotation/paraphrase via the wikindx 'insert metadata' button. Footnotes (i.e. parenthetical thoughts as opposed to citation footnotes - WIKINDX does handle those footnotes/endnotes as well) are inserted via a button which encloses the inserted footnote in:''
:''[footnote]....[/footnote]''

:''Exporting to RTF, the cite tags are substituted with the formatted citation marker (in-text or footnote/endnote), bibliographic information is extracted and appended to a bibliography and footnote tags are converted to RTF footnotes. Of course, all HTML code (font/text formatting, tables, lists, images etc.) are converted to their appropriate RTF code too.''

5. Re the citation/bibliographic formatting, the PHP code for this has been extracted from wikindx and made available to other OSS apps at http://bibliophile.sourceforge.net (I think Aigaion and Bibliograph use it or are about to) so it may be easy enough for Moodle to use this too. In fact doubly easy if moodle interfaces with a wikindx because the quickest way to set up the formatting engine is to provide data to it in exactly the same PHP associative array that wikindx natively expects.

6. What capabilities are there in Wikindx at this time for different capabilities in using bibliographies? Can bibliographies be shared by a predefined group/all users? Can some people be given the ability to add to a bibliography while others can only use the bibilography? Can bibliography entries be required to have approval by some person before they are displayed to all? These would be nice features to have.

Roles

2006-08-13T18:00:51Z

Hatshepsut: /* Enrolment-level Capabilities */

'''Roles and permissions''' will be in Moodle 1.7 and are available in the developer version of Moodle.

==Definitions==

A role is an identifier of the user's status in some context, for example, teacher, student and forum moderator are examples of roles.

A capability is a description of some particular Moodle feature. Capabilities are associated with roles. For example, ''mod/forum:replypost'' is a capability.

A permission is some value that is assigned for a capability for a particular role. For example, allow or prevent.

A context is a "space" in the Moodle, such as courses, activity modules, blocks etc.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

{{Moodle 1.7}}The new system will allow authorized users to define an arbitrary number of roles (eg a teacher)

A role consists of a list of permissions for different possible actions within Moodle (eg delete discussions, add activities etc)

Roles can be applied to users in a context (eg assign Fred as a teacher in a particular course)

Here are the possible contexts, listed from the most general to the most specific.

#CONTEXT_SYSTEM
#CONTEXT_PERSONAL
#CONTEXT_USERID
#CONTEXT_COURSECAT
#CONTEXT_COURSE
#CONTEXT_GROUP
#CONTEXT_MODULE
#CONTEXT_BLOCK

An authorized user will be able to assign an arbitrary number of roles to each user in any context.

Capabilities can have the following permissions:

#CAP_INHERIT
#CAP_ALLOW
#CAP_PREVENT
#CAP_PROHIBIT

If no permission is defined, then the capability permission is inherited from a context that is more general than the current context. If we define different permission values for the same capability in different contexts, we say that we are overriding the capability in the more specific context.

Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by enforcing the rule that the capability defined for a more specific context will win, unless a prohibit is encountered in a less specific context.

For example, Mark has a student role at course level, which allows him to write into a wiki. But Mark also got assigned a Visitor role at a module context level (for a particular wiki) which prevents him from writing to the wiki (read only). Therefore, for this particular wiki, Mark will not be able to write to the wiki since the more specific context wins.

If we set a prohibit on a capability, it means that the capability cannot be overridden and will always have a permission of prevent (deny). Prohibit always wins. For example, Jeff has a naughty student role that prohibits him from postings in any forums (for the whole site), but he's also assigned a facilitator role in "Science forum" in the course Science and Math 101. Since prohibit always wins, Jeff is unable to post in "Science forum".

Allow and prevent will cancel each other out if set for the same capability at the same context level. If this happens, we refer to the previous context level to determine the permission for the capability.

This may sound more complex than it really is in practice. The upshot is that the system can be flexible enough to allow any combination of permissions.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the existing capabilities will be automatically retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, mirroring what we have in 1.6. With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==Capabilities==

This will be a comprehensive list of capabilities (it's not complete yet). It is important that capability names are unique.

===Core-level Capabilities===

Moodle core capability names start with 'moodle/'. The next word indicates what type of core capability it is, and the last word is the actual capability itself. The capabilities for the Moodle core are defined in lib/db/access.php

#moodle/legacy:guest - legacy capabilities are used to transition existing users to the new roles system during the upgrade to Moodle 1.7
#moodle/legacy:student
#moodle/legacy:teacher
#moodle/legacy:editingteacher
#moodle/legacy:coursecreator
#moodle/legacy:admin
#moodle/site:doanything - special capability, meant for admins, if is set, overrides all other capability settings
#moodle/site:config - applicable in admin/index.php and config.php (might break down later) : 1)admin/config.php 2)admin/configure.php 3)blocks/admin/block_admin.php load_content_for_site()
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now) : 1)_add_edit_controls moodleblock.class.php
#moodle/site:backup - can create a course backup : 1)course/category.php 2)block_admin.php
#moodle/site:restore - can restore into this context : 1)course/category.php 2)block_admin.php
#moodle/site:import - can import other courses into this context : 1)block_admin.php
#moodle/site:accessallgroups - able to access all groups irrespective of what group the user is in
#moodle/blog:view - read blogs
#moodle/blog:create - write new blog posts
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use
#moodle/blog:manageentries - edit/delete all blog entries
#moodle/course:create - create courses : 1)course/edit.php 2)course/category.php 3)course/index.php
#moodle/course:delete - create courses : 1)course/category.php
#moodle/course:update - update course settings
#moodle/course:view - can use this to find participants
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:viewscales - view scales (i.e. in a help window?) : 1)course/scales.php
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)
#moodle/course:managescales - add, delete, edit scales, move scales up and down : 1)blocks/block_admin.php 2)course/scales.php
#moodle/course:managegroups - managing groups, add, edit, delete : 1)course/groups.php 2)course/group.php
#moodle/course:visibility - hide/show courses : 1)course/category.php
#moodle/course:activityvisibility - hide/show activities within a course
#moodle/course:viewhiddenactivities - able to see activities that have been hidden
#moodle/category:create - create category : 1)course/index.php
#moodle/category:delete - delete category : 1)course/index.php
#moodle/category:update - update category settings : 1)course/category.php
#moodle/category:visibility - hide/show categories : 1)course/index.php
#moodle/user:create - create user : 1) user/edit.php
#moodle/user:delete - delete user : 1) admin/user.php
#moodle/user:update - update user settings : 1) user/edit.php
#moodle/user:viewdetails - view personally-identifying user details (e.g. name, photo). This ties in with the "visitor" scenario described below.
#moodle/calendar:manageownentries - create/edit/delete
#moodle/calendar:manageentries - create/edit/delete
#moodle/role:assign - assign roles to users
#moodle/role:manage - create/edit/delete roles, set capability permissions for each role

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The part before the colon is the full path to the module in the Moodle code. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:view- reading the assignment description
##mod/assignment:submit - turn assignment in
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entries
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:viewhiddentimedposts
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:viewrating
##mod/forum:viewanyrating
##mod/forum:rate
##mod/forum:createattachment
##mod/forum:deleteownpost
##mod/forum:deleteanypost
##mod/forum:splitdiscussions
##mod/forum:movediscussions
##mod/forum:editanypost
##mod/forum:viewqandawithoutposting
##mod/forum:viewsubscribers
##mod/forum:managesubscriptions
##mod/forum:throttlingapplies
#Glossary
##mod/glossary:view - read entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:viewrating - view ratings
#Hotpot
##mod/hotpot:view
#Label
##none
#Lams
##TBD
#Lesson
##TBD
#Quiz
##TBD
#Resource
##mod/resource:view
#Scorm
##mod/scorm:view
##mod/scorm:viewgrades
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
##Waiting on new wiki
#Workshop
##Waiting on new Workshop

===Enrolment-level Capabilities===

The naming convention for capabilities that are specific to enrolment is 'enrol/enrol_name:capability'. The enrolment capabilities are defined in enrol/enrol_name/db/access.php.

#Authorize.net Payment Gateway
##enrol/authorize:managepayments - manage user payments, capture, void, refund, delete etc.

Will it be possible to enroll people into different roles in a course as part of the enrollment process itself? I mean could you have an option to self-enroll (either involving payment or not) into multiple roles?--[[User:N Hansen|N Hansen]] 02:00, 14 August 2006 (WST)

===Blocks===

===Questions===
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].

See [http://moodle.org/mod/forum/discuss.php?d=51143 this forum thread] for a discussion about the current problems wth publishing question categories.[[User:Tim Hunt|Tim Hunt]] 18:50, 8 August 2006 (WST)

==Programming Interface==

Although the Roles system may look complicated at first glance, implementing it in Moodle code is fairly simple.

# You need to define each capability once, so that Moodle can upgrade existing roles to take advantage of it. You do this in an access.php inside the db folder of any module (eg see mod/forum/db/access.php). The array contains entries like this (note the descriptions for the legacy roles which provides forward compatibility):

'mod/forum:viewforum' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'legacy' => array(
'guest' => CAP_PREVENT,
'student' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'coursecreator' => CAP_ALLOW,
'admin' => CAP_ALLOW
)
),

# To load/change these capabilities you need to bump the module version. There's no need to provide changes or differences as Moodle will scan the whole array and sort it out.
# On each page you need to define the context the user is working in. For example, in the forum module:

$context = get_context_instance(CONTEXT_MODULE, $cm->id);

# Then, whenever you want to check that the current user has rights to do something, call has_capability() like this:

if (!has_capability('mod/forum:viewforum', $context->id)) {
print_error('nopermissiontoviewforum);
}

==Scenario brainstorming==

This section is for brainstorming some example roles that we would like to support. Note some of these *may* not be possible in 1.7.

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===Peer observer of teaching===
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY=3+4 yr olds) and Key Stage 1 (KS1=5+6 yr olds) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary. In Key Stage 2 (KS2=7-11 yr olds) parents would be more monitoring but may join in as well.

In Key stages 3 (KS3=12-14 yr olds) and 4 (KS4=15+16 yr olds) this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments. Also in all Key Satges there may be a home-school agreement which may be signed up to. Could this form part of a site policy system that incorporates a tickable list of activities the parent agrees to the child using (blogs/wikis/forums etc.)?

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

Again in the UK, parents have their own independent right of access to a child's educational records. Obviously, children's records must not be made available to other parties, including the parents of other children in the same class. Thus it would be necessary to associate parent accounts with their own child's accounts in such a way that they could, if so desired, have read access to their child's grades, answers and contributions, but generally not those of other children - this may be problematic in the case of wiki activities or forum posts.

There is some concern that children's forum contributions etc may be constrained if their parents are able to read all that they write; this may be particularly problematic in areas such as Personal, Social and Health Education (PSHE), where some schools may choose to use obfuscated usernames.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===Alumnus=== An ALUMNUS should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when an ALUMNUS is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

In schools there is often a book review system. This may be covered by the lending system database but may not in which case a librarian may neeed to have a course area they can create a database template to handle the reviews in which case they may have a normal teacher style role? Off topic but course an integration with common schools database systems would be great.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Student - FERPA rights===

A student that has asserted their FERPA rights to non-disclosure. Typically includes not publishing their name
in any public place. Could include this student only being seen with an "alias" within course spaces. Is this an attribute rather
than a role?

===Help Desk===

Help desk agents that have read access for the purposes of trouble shooting. Some care in placing this role within a hierarchy
of inheritance is needed, full access will be problematic with FERPA.

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]
[[Category:Roles]]

[[ru:Роли]]

Roles

2006-08-13T17:57:18Z

Hatshepsut: /* ALUMNUS */

'''Roles and permissions''' will be in Moodle 1.7 and are available in the developer version of Moodle.

==Definitions==

A role is an identifier of the user's status in some context, for example, teacher, student and forum moderator are examples of roles.

A capability is a description of some particular Moodle feature. Capabilities are associated with roles. For example, ''mod/forum:replypost'' is a capability.

A permission is some value that is assigned for a capability for a particular role. For example, allow or prevent.

A context is a "space" in the Moodle, such as courses, activity modules, blocks etc.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

{{Moodle 1.7}}The new system will allow authorized users to define an arbitrary number of roles (eg a teacher)

A role consists of a list of permissions for different possible actions within Moodle (eg delete discussions, add activities etc)

Roles can be applied to users in a context (eg assign Fred as a teacher in a particular course)

Here are the possible contexts, listed from the most general to the most specific.

#CONTEXT_SYSTEM
#CONTEXT_PERSONAL
#CONTEXT_USERID
#CONTEXT_COURSECAT
#CONTEXT_COURSE
#CONTEXT_GROUP
#CONTEXT_MODULE
#CONTEXT_BLOCK

An authorized user will be able to assign an arbitrary number of roles to each user in any context.

Capabilities can have the following permissions:

#CAP_INHERIT
#CAP_ALLOW
#CAP_PREVENT
#CAP_PROHIBIT

If no permission is defined, then the capability permission is inherited from a context that is more general than the current context. If we define different permission values for the same capability in different contexts, we say that we are overriding the capability in the more specific context.

Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by enforcing the rule that the capability defined for a more specific context will win, unless a prohibit is encountered in a less specific context.

For example, Mark has a student role at course level, which allows him to write into a wiki. But Mark also got assigned a Visitor role at a module context level (for a particular wiki) which prevents him from writing to the wiki (read only). Therefore, for this particular wiki, Mark will not be able to write to the wiki since the more specific context wins.

If we set a prohibit on a capability, it means that the capability cannot be overridden and will always have a permission of prevent (deny). Prohibit always wins. For example, Jeff has a naughty student role that prohibits him from postings in any forums (for the whole site), but he's also assigned a facilitator role in "Science forum" in the course Science and Math 101. Since prohibit always wins, Jeff is unable to post in "Science forum".

Allow and prevent will cancel each other out if set for the same capability at the same context level. If this happens, we refer to the previous context level to determine the permission for the capability.

This may sound more complex than it really is in practice. The upshot is that the system can be flexible enough to allow any combination of permissions.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the existing capabilities will be automatically retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, mirroring what we have in 1.6. With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==Capabilities==

This will be a comprehensive list of capabilities (it's not complete yet). It is important that capability names are unique.

===Core-level Capabilities===

Moodle core capability names start with 'moodle/'. The next word indicates what type of core capability it is, and the last word is the actual capability itself. The capabilities for the Moodle core are defined in lib/db/access.php

#moodle/legacy:guest - legacy capabilities are used to transition existing users to the new roles system during the upgrade to Moodle 1.7
#moodle/legacy:student
#moodle/legacy:teacher
#moodle/legacy:editingteacher
#moodle/legacy:coursecreator
#moodle/legacy:admin
#moodle/site:doanything - special capability, meant for admins, if is set, overrides all other capability settings
#moodle/site:config - applicable in admin/index.php and config.php (might break down later) : 1)admin/config.php 2)admin/configure.php 3)blocks/admin/block_admin.php load_content_for_site()
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now) : 1)_add_edit_controls moodleblock.class.php
#moodle/site:backup - can create a course backup : 1)course/category.php 2)block_admin.php
#moodle/site:restore - can restore into this context : 1)course/category.php 2)block_admin.php
#moodle/site:import - can import other courses into this context : 1)block_admin.php
#moodle/site:accessallgroups - able to access all groups irrespective of what group the user is in
#moodle/blog:view - read blogs
#moodle/blog:create - write new blog posts
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use
#moodle/blog:manageentries - edit/delete all blog entries
#moodle/course:create - create courses : 1)course/edit.php 2)course/category.php 3)course/index.php
#moodle/course:delete - create courses : 1)course/category.php
#moodle/course:update - update course settings
#moodle/course:view - can use this to find participants
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:viewscales - view scales (i.e. in a help window?) : 1)course/scales.php
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)
#moodle/course:managescales - add, delete, edit scales, move scales up and down : 1)blocks/block_admin.php 2)course/scales.php
#moodle/course:managegroups - managing groups, add, edit, delete : 1)course/groups.php 2)course/group.php
#moodle/course:visibility - hide/show courses : 1)course/category.php
#moodle/course:activityvisibility - hide/show activities within a course
#moodle/course:viewhiddenactivities - able to see activities that have been hidden
#moodle/category:create - create category : 1)course/index.php
#moodle/category:delete - delete category : 1)course/index.php
#moodle/category:update - update category settings : 1)course/category.php
#moodle/category:visibility - hide/show categories : 1)course/index.php
#moodle/user:create - create user : 1) user/edit.php
#moodle/user:delete - delete user : 1) admin/user.php
#moodle/user:update - update user settings : 1) user/edit.php
#moodle/user:viewdetails - view personally-identifying user details (e.g. name, photo). This ties in with the "visitor" scenario described below.
#moodle/calendar:manageownentries - create/edit/delete
#moodle/calendar:manageentries - create/edit/delete
#moodle/role:assign - assign roles to users
#moodle/role:manage - create/edit/delete roles, set capability permissions for each role

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The part before the colon is the full path to the module in the Moodle code. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:view- reading the assignment description
##mod/assignment:submit - turn assignment in
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entries
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:viewhiddentimedposts
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:viewrating
##mod/forum:viewanyrating
##mod/forum:rate
##mod/forum:createattachment
##mod/forum:deleteownpost
##mod/forum:deleteanypost
##mod/forum:splitdiscussions
##mod/forum:movediscussions
##mod/forum:editanypost
##mod/forum:viewqandawithoutposting
##mod/forum:viewsubscribers
##mod/forum:managesubscriptions
##mod/forum:throttlingapplies
#Glossary
##mod/glossary:view - read entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:viewrating - view ratings
#Hotpot
##mod/hotpot:view
#Label
##none
#Lams
##TBD
#Lesson
##TBD
#Quiz
##TBD
#Resource
##mod/resource:view
#Scorm
##mod/scorm:view
##mod/scorm:viewgrades
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
##Waiting on new wiki
#Workshop
##Waiting on new Workshop

===Enrolment-level Capabilities===

The naming convention for capabilities that are specific to enrolment is 'enrol/enrol_name:capability'. The enrolment capabilities are defined in enrol/enrol_name/db/access.php.

#Authorize.net Payment Gateway
##enrol/authorize:managepayments - manage user payments, capture, void, refund, delete etc.

===Blocks===

===Questions===
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].

See [http://moodle.org/mod/forum/discuss.php?d=51143 this forum thread] for a discussion about the current problems wth publishing question categories.[[User:Tim Hunt|Tim Hunt]] 18:50, 8 August 2006 (WST)

==Programming Interface==

Although the Roles system may look complicated at first glance, implementing it in Moodle code is fairly simple.

# You need to define each capability once, so that Moodle can upgrade existing roles to take advantage of it. You do this in an access.php inside the db folder of any module (eg see mod/forum/db/access.php). The array contains entries like this (note the descriptions for the legacy roles which provides forward compatibility):

'mod/forum:viewforum' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'legacy' => array(
'guest' => CAP_PREVENT,
'student' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'coursecreator' => CAP_ALLOW,
'admin' => CAP_ALLOW
)
),

# To load/change these capabilities you need to bump the module version. There's no need to provide changes or differences as Moodle will scan the whole array and sort it out.
# On each page you need to define the context the user is working in. For example, in the forum module:

$context = get_context_instance(CONTEXT_MODULE, $cm->id);

# Then, whenever you want to check that the current user has rights to do something, call has_capability() like this:

if (!has_capability('mod/forum:viewforum', $context->id)) {
print_error('nopermissiontoviewforum);
}

==Scenario brainstorming==

This section is for brainstorming some example roles that we would like to support. Note some of these *may* not be possible in 1.7.

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===Peer observer of teaching===
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY=3+4 yr olds) and Key Stage 1 (KS1=5+6 yr olds) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary. In Key Stage 2 (KS2=7-11 yr olds) parents would be more monitoring but may join in as well.

In Key stages 3 (KS3=12-14 yr olds) and 4 (KS4=15+16 yr olds) this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments. Also in all Key Satges there may be a home-school agreement which may be signed up to. Could this form part of a site policy system that incorporates a tickable list of activities the parent agrees to the child using (blogs/wikis/forums etc.)?

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

Again in the UK, parents have their own independent right of access to a child's educational records. Obviously, children's records must not be made available to other parties, including the parents of other children in the same class. Thus it would be necessary to associate parent accounts with their own child's accounts in such a way that they could, if so desired, have read access to their child's grades, answers and contributions, but generally not those of other children - this may be problematic in the case of wiki activities or forum posts.

There is some concern that children's forum contributions etc may be constrained if their parents are able to read all that they write; this may be particularly problematic in areas such as Personal, Social and Health Education (PSHE), where some schools may choose to use obfuscated usernames.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===Alumnus=== An ALUMNUS should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when an ALUMNUS is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

In schools there is often a book review system. This may be covered by the lending system database but may not in which case a librarian may neeed to have a course area they can create a database template to handle the reviews in which case they may have a normal teacher style role? Off topic but course an integration with common schools database systems would be great.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Student - FERPA rights===

A student that has asserted their FERPA rights to non-disclosure. Typically includes not publishing their name
in any public place. Could include this student only being seen with an "alias" within course spaces. Is this an attribute rather
than a role?

===Help Desk===

Help desk agents that have read access for the purposes of trouble shooting. Some care in placing this role within a hierarchy
of inheritance is needed, full access will be problematic with FERPA.

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]
[[Category:Roles]]

[[ru:Роли]]

Roles

2006-08-13T17:57:01Z

Hatshepsut: /* Former Student */

'''Roles and permissions''' will be in Moodle 1.7 and are available in the developer version of Moodle.

==Definitions==

A role is an identifier of the user's status in some context, for example, teacher, student and forum moderator are examples of roles.

A capability is a description of some particular Moodle feature. Capabilities are associated with roles. For example, ''mod/forum:replypost'' is a capability.

A permission is some value that is assigned for a capability for a particular role. For example, allow or prevent.

A context is a "space" in the Moodle, such as courses, activity modules, blocks etc.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

{{Moodle 1.7}}The new system will allow authorized users to define an arbitrary number of roles (eg a teacher)

A role consists of a list of permissions for different possible actions within Moodle (eg delete discussions, add activities etc)

Roles can be applied to users in a context (eg assign Fred as a teacher in a particular course)

Here are the possible contexts, listed from the most general to the most specific.

#CONTEXT_SYSTEM
#CONTEXT_PERSONAL
#CONTEXT_USERID
#CONTEXT_COURSECAT
#CONTEXT_COURSE
#CONTEXT_GROUP
#CONTEXT_MODULE
#CONTEXT_BLOCK

An authorized user will be able to assign an arbitrary number of roles to each user in any context.

Capabilities can have the following permissions:

#CAP_INHERIT
#CAP_ALLOW
#CAP_PREVENT
#CAP_PROHIBIT

If no permission is defined, then the capability permission is inherited from a context that is more general than the current context. If we define different permission values for the same capability in different contexts, we say that we are overriding the capability in the more specific context.

Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by enforcing the rule that the capability defined for a more specific context will win, unless a prohibit is encountered in a less specific context.

For example, Mark has a student role at course level, which allows him to write into a wiki. But Mark also got assigned a Visitor role at a module context level (for a particular wiki) which prevents him from writing to the wiki (read only). Therefore, for this particular wiki, Mark will not be able to write to the wiki since the more specific context wins.

If we set a prohibit on a capability, it means that the capability cannot be overridden and will always have a permission of prevent (deny). Prohibit always wins. For example, Jeff has a naughty student role that prohibits him from postings in any forums (for the whole site), but he's also assigned a facilitator role in "Science forum" in the course Science and Math 101. Since prohibit always wins, Jeff is unable to post in "Science forum".

Allow and prevent will cancel each other out if set for the same capability at the same context level. If this happens, we refer to the previous context level to determine the permission for the capability.

This may sound more complex than it really is in practice. The upshot is that the system can be flexible enough to allow any combination of permissions.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the existing capabilities will be automatically retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, mirroring what we have in 1.6. With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==Capabilities==

This will be a comprehensive list of capabilities (it's not complete yet). It is important that capability names are unique.

===Core-level Capabilities===

Moodle core capability names start with 'moodle/'. The next word indicates what type of core capability it is, and the last word is the actual capability itself. The capabilities for the Moodle core are defined in lib/db/access.php

#moodle/legacy:guest - legacy capabilities are used to transition existing users to the new roles system during the upgrade to Moodle 1.7
#moodle/legacy:student
#moodle/legacy:teacher
#moodle/legacy:editingteacher
#moodle/legacy:coursecreator
#moodle/legacy:admin
#moodle/site:doanything - special capability, meant for admins, if is set, overrides all other capability settings
#moodle/site:config - applicable in admin/index.php and config.php (might break down later) : 1)admin/config.php 2)admin/configure.php 3)blocks/admin/block_admin.php load_content_for_site()
#moodle/site:manageblocks - adding/removing/editing blocks (site, course contexts only for now) : 1)_add_edit_controls moodleblock.class.php
#moodle/site:backup - can create a course backup : 1)course/category.php 2)block_admin.php
#moodle/site:restore - can restore into this context : 1)course/category.php 2)block_admin.php
#moodle/site:import - can import other courses into this context : 1)block_admin.php
#moodle/site:accessallgroups - able to access all groups irrespective of what group the user is in
#moodle/blog:view - read blogs
#moodle/blog:create - write new blog posts
#moodle/blog:manageofficialtags - create/delete official blog tags that others can use
#moodle/blog:managepersonaltags - create/delete official blog tags that others can use
#moodle/blog:manageentries - edit/delete all blog entries
#moodle/course:create - create courses : 1)course/edit.php 2)course/category.php 3)course/index.php
#moodle/course:delete - create courses : 1)course/category.php
#moodle/course:update - update course settings
#moodle/course:view - can use this to find participants
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:viewscales - view scales (i.e. in a help window?) : 1)course/scales.php
#moodle/course:manageactivities - adding/removing/editing activities and resources (don't think it makes any sense to split these)
#moodle/course:managescales - add, delete, edit scales, move scales up and down : 1)blocks/block_admin.php 2)course/scales.php
#moodle/course:managegroups - managing groups, add, edit, delete : 1)course/groups.php 2)course/group.php
#moodle/course:visibility - hide/show courses : 1)course/category.php
#moodle/course:activityvisibility - hide/show activities within a course
#moodle/course:viewhiddenactivities - able to see activities that have been hidden
#moodle/category:create - create category : 1)course/index.php
#moodle/category:delete - delete category : 1)course/index.php
#moodle/category:update - update category settings : 1)course/category.php
#moodle/category:visibility - hide/show categories : 1)course/index.php
#moodle/user:create - create user : 1) user/edit.php
#moodle/user:delete - delete user : 1) admin/user.php
#moodle/user:update - update user settings : 1) user/edit.php
#moodle/user:viewdetails - view personally-identifying user details (e.g. name, photo). This ties in with the "visitor" scenario described below.
#moodle/calendar:manageownentries - create/edit/delete
#moodle/calendar:manageentries - create/edit/delete
#moodle/role:assign - assign roles to users
#moodle/role:manage - create/edit/delete roles, set capability permissions for each role

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The part before the colon is the full path to the module in the Moodle code. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:view- reading the assignment description
##mod/assignment:submit - turn assignment in
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entries
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:viewhiddentimedposts
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:viewrating
##mod/forum:viewanyrating
##mod/forum:rate
##mod/forum:createattachment
##mod/forum:deleteownpost
##mod/forum:deleteanypost
##mod/forum:splitdiscussions
##mod/forum:movediscussions
##mod/forum:editanypost
##mod/forum:viewqandawithoutposting
##mod/forum:viewsubscribers
##mod/forum:managesubscriptions
##mod/forum:throttlingapplies
#Glossary
##mod/glossary:view - read entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:viewrating - view ratings
#Hotpot
##mod/hotpot:view
#Label
##none
#Lams
##TBD
#Lesson
##TBD
#Quiz
##TBD
#Resource
##mod/resource:view
#Scorm
##mod/scorm:view
##mod/scorm:viewgrades
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
##Waiting on new wiki
#Workshop
##Waiting on new Workshop

===Enrolment-level Capabilities===

The naming convention for capabilities that are specific to enrolment is 'enrol/enrol_name:capability'. The enrolment capabilities are defined in enrol/enrol_name/db/access.php.

#Authorize.net Payment Gateway
##enrol/authorize:managepayments - manage user payments, capture, void, refund, delete etc.

===Blocks===

===Questions===
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].

See [http://moodle.org/mod/forum/discuss.php?d=51143 this forum thread] for a discussion about the current problems wth publishing question categories.[[User:Tim Hunt|Tim Hunt]] 18:50, 8 August 2006 (WST)

==Programming Interface==

Although the Roles system may look complicated at first glance, implementing it in Moodle code is fairly simple.

# You need to define each capability once, so that Moodle can upgrade existing roles to take advantage of it. You do this in an access.php inside the db folder of any module (eg see mod/forum/db/access.php). The array contains entries like this (note the descriptions for the legacy roles which provides forward compatibility):

'mod/forum:viewforum' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'legacy' => array(
'guest' => CAP_PREVENT,
'student' => CAP_ALLOW,
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'coursecreator' => CAP_ALLOW,
'admin' => CAP_ALLOW
)
),

# To load/change these capabilities you need to bump the module version. There's no need to provide changes or differences as Moodle will scan the whole array and sort it out.
# On each page you need to define the context the user is working in. For example, in the forum module:

$context = get_context_instance(CONTEXT_MODULE, $cm->id);

# Then, whenever you want to check that the current user has rights to do something, call has_capability() like this:

if (!has_capability('mod/forum:viewforum', $context->id)) {
print_error('nopermissiontoviewforum);
}

==Scenario brainstorming==

This section is for brainstorming some example roles that we would like to support. Note some of these *may* not be possible in 1.7.

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===Peer observer of teaching===
Many institutions encourage peer observation of teaching, to encourage reflection on practice. In online environments this will be similar to moderation or inspection. The peer observer would need to be able to experience the course "as a student", but also to be able to view summaries of usage, transcripts of interactions (forums/surveys/polls etc), grades assigned (e.g. in assignments).

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY=3+4 yr olds) and Key Stage 1 (KS1=5+6 yr olds) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary. In Key Stage 2 (KS2=7-11 yr olds) parents would be more monitoring but may join in as well.

In Key stages 3 (KS3=12-14 yr olds) and 4 (KS4=15+16 yr olds) this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments. Also in all Key Satges there may be a home-school agreement which may be signed up to. Could this form part of a site policy system that incorporates a tickable list of activities the parent agrees to the child using (blogs/wikis/forums etc.)?

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

Again in the UK, parents have their own independent right of access to a child's educational records. Obviously, children's records must not be made available to other parties, including the parents of other children in the same class. Thus it would be necessary to associate parent accounts with their own child's accounts in such a way that they could, if so desired, have read access to their child's grades, answers and contributions, but generally not those of other children - this may be problematic in the case of wiki activities or forum posts.

There is some concern that children's forum contributions etc may be constrained if their parents are able to read all that they write; this may be particularly problematic in areas such as Personal, Social and Health Education (PSHE), where some schools may choose to use obfuscated usernames.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===ALUMNUS=== An ALUMNUS should be able to search for all other ALUMNI of the school, interact with them and be enrolled in a seperate course - which is like a META course with all the content of his learning and interaction - as well as capabilities to be a part of this ALUMNI only course. All the teachers of courses during school years should automatically be a part of the ALUMNI course .. which means when an ALUMNUS is enrolled in a course, the original teachers of all his courses get enrolled ? --[[User:Anil Sharma|Anil Sharma]] 20:54, 15 July 2006 (WST)

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

In schools there is often a book review system. This may be covered by the lending system database but may not in which case a librarian may neeed to have a course area they can create a database template to handle the reviews in which case they may have a normal teacher style role? Off topic but course an integration with common schools database systems would be great.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Student - FERPA rights===

A student that has asserted their FERPA rights to non-disclosure. Typically includes not publishing their name
in any public place. Could include this student only being seen with an "alias" within course spaces. Is this an attribute rather
than a role?

===Help Desk===

Help desk agents that have read access for the purposes of trouble shooting. Some care in placing this role within a hierarchy
of inheritance is needed, full access will be problematic with FERPA.

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]
[[Category:Roles]]

[[ru:Роли]]

Wikindx

2006-08-08T22:53:52Z

Hatshepsut: changes to 3, added 4

Wikindx

2006-08-08T17:49:57Z

Hatshepsut:

Wikindx

2006-08-08T17:44:19Z

Hatshepsut:

Roles

2006-07-15T12:24:22Z

Hatshepsut: /* Questions */

'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.

''Please note that none of the following is finalised.''

==Definitions==

By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.

A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role.

To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==The plan==

There are a few major things that need to be done. Here's a list (in no particular order):

#Identify permissions required for site/course/each module.
#Define the database structure for storing roles and capabilities.
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?
#Consider interface issues, especially how to manage conflicting role/exception rules.
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?
#Consider the impact on backup/restore.
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.

==Capabilities==

This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?

What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)

Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.

Do we need to add canview and cansearch logs at site/course/user/group level?

I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)

===Core-level Capabilities===

Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php
Do we still keep student view? What is a student view?

#moodle/site:config - applicialbe in admin/index.php and config.php (might break down later)
#moodle/course:create - create courses
#moodle/course:view - possibly a capability used for checking student role
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:update - updates a course, i.e. adding/removing/editting activities
#moodle/course:viewscales - view scales (i.e. in a help window?)
#moodle/course:managescales - add, delete, edit scales, move scales up and down
#moodle/course:managegroups - managing groups, add, delete, add user in etc

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:read - reading the assignment description
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entry
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:managediscussions
##mod/forum:viewrating
##mod/forum:rate
#Glossary
##mod/glossary:read - view entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:readrate - view rating?
#Hotpot
#Label
#Lams
#Lesson
#Quiz
#Resource
#Scorm
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
#Workshop

==OU Desired Capabilities==

We will use this page to detail the specific capabilities needed to create the roles for the OU. Each capability has three parts:

# the name itself which can be anything and should be simple and short
# the name of the module it belongs to ("moodle", "blog", "course", "forum" etc)
# the name of the "class" it belongs to, currently "read" or "write". We can change
this in future if we can work out a sensible scheme. This is purely used for the
GUI to "clump" similar capabilties together

I would recommend we create a table for each module with the name, module and class of the capability

==Moodle Site==

<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Create Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Delete Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Create Catagory</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>View Courses</td>
<td>Site</td>
<td>Read</td>
<td></td>
</tr>

<tr>
<td>Add User</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>Move course to another category</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>Make course visible to students</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>new features? Site wide subscription default/setting</td>
<td>Site</td>
<td>optional/forced etc</td>
<td>recommended default optional for all OU forums</td>
</tr>

<tr>
<td>Access site</td>
<td>Site</td>
<td>read/write/no access</td>
<td>used to ban individuals from Moodle?</td>
</tr>
</table>

==Course - home page ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Add Blocks</td>
<td>Course</td>
<td>On/Off</td>
<td>CT & Staff = Off, Admins = On</td>
</tr>

<tr>
<td>Add/View users ALs/Staff/Students</td>
<td>Course</td>
<td>Read/Write</td>
<td>CT/Staff = Read (this should be managed through circe or the administrator). Admins = Write </td>
</tr>

<tr>
<td>Course settings</td>
<td>Course</td>
<td>Read/Write</td>
<td>Course teams = Read, Staff = no access. Admins = write</td>
</tr>

<tr>
<td>Move blocks?</td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff = off, Admin = on</td>
</tr>

<tr>
<td>Delete resource/page/activity/block </td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff= off, Admin = on. As we have no recovery process would it be best to prevent course teams from deleting resource pages & other items on the home page?</td>
</tr>

<tr>
<td>hide items</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, staff=off, admin=on</td>
</tr>

<tr>
<td>add resource</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which resource types are listed per course/site</td>
</tr>

<tr>
<td>add activity</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which activity types are listed per course/site</td>

<tr>
<td>upload calendar (OU feature?)</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write. CTs should not be able to upload a calendar (admin will add this & need to ensure the CT don't overwrite it with an alternative) </td>

<tr>
<td>edit calendar</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=write, Staff=read, admin=write </td>
</tr>

<tr>
<td>admin functions, e.g. back up, restore, import</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write </td>
</tr>

<tr>
<td>edit groups</td>
<td>Course</td>
<td>read/write</td>
<td>Admins = write CT/Moderators=on staff=read?</td>
</tr>

<tr>
<td>Access course</td>
<td>Course</td>
<td>read/write/no access</td>
<td></td>
</tr>

</table>

==Course - resource page (OU version) ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>add authid</td>
<td>Course (resource page)</td>
<td>Read/Write</td>
<td>Admin=Write, CT=Read</td>
</tr>

<tr>
<td>add placeholder</td>
<td>Course (resource page)</td>
<td>on/off</td>
<td>admin=on, CT=Off</td>
</tr>

<tr>
<td>Add RSS feed</td>
<td>Course resource page</td>
<td>on/off</td>
<td>admin=on, ct=off?</td>
</tr>

<tr>
<td>access page</td>
<td>Course resource page</td>
<td>read/write/noaccess</td>
<td>use to restrict access to pages by role?</td>
</tr>
</table>

==Forum==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>move discussion to (archive/move feature)</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL=off?</td>
</tr>

<tr>
<td>update this forum</td>
<td>Forum</td>
<td>read/write</td>
<td>admin=write, CT/Moderator=off? it would be good to break this down further and or premote some defaults for use. e.g subscription I think there should be a server wide default of optional for all OU forums which can't be oevrriden at the course level.</td>
</tr>

<tr>
<td>delete message/thread</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off? some course teams won't want students/als to be able to delete their own posts</td>
</tr>

<tr>
<td>split</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off </td>
</tr>

<tr>
<td>post to forum</td>
<td>Forum</td>
<td>on/off</td>
<td></td>
</tr>

<tr>
<td>access forum</td>
<td>Forum</td>
<td>read/write/no access</td>
<td></td>
</tr>

<tr>
<td>attach file to message</td>
<td>Forum</td>
<td>on/off access</td>
<td></td>
</tr>

</table>

==Blog==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Quiz==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Wiki==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Resources==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Questions==
I am adding question categories here because they seem to have been forgotten in the whole scheme of things since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].

==Scenarios==

This section is for brainstorming some example roles that we would like to support:

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.

In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]

[[ru:Роли]]

Roles

2006-07-15T12:23:54Z

Hatshepsut: /* Questions */

'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.

''Please note that none of the following is finalised.''

==Definitions==

By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.

A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role.

To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==The plan==

There are a few major things that need to be done. Here's a list (in no particular order):

#Identify permissions required for site/course/each module.
#Define the database structure for storing roles and capabilities.
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?
#Consider interface issues, especially how to manage conflicting role/exception rules.
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?
#Consider the impact on backup/restore.
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.

==Capabilities==

This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?

What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)

Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.

Do we need to add canview and cansearch logs at site/course/user/group level?

I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)

===Core-level Capabilities===

Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php
Do we still keep student view? What is a student view?

#moodle/site:config - applicialbe in admin/index.php and config.php (might break down later)
#moodle/course:create - create courses
#moodle/course:view - possibly a capability used for checking student role
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:update - updates a course, i.e. adding/removing/editting activities
#moodle/course:viewscales - view scales (i.e. in a help window?)
#moodle/course:managescales - add, delete, edit scales, move scales up and down
#moodle/course:managegroups - managing groups, add, delete, add user in etc

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:read - reading the assignment description
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entry
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:managediscussions
##mod/forum:viewrating
##mod/forum:rate
#Glossary
##mod/glossary:read - view entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:readrate - view rating?
#Hotpot
#Label
#Lams
#Lesson
#Quiz
#Resource
#Scorm
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
#Workshop

==OU Desired Capabilities==

We will use this page to detail the specific capabilities needed to create the roles for the OU. Each capability has three parts:

# the name itself which can be anything and should be simple and short
# the name of the module it belongs to ("moodle", "blog", "course", "forum" etc)
# the name of the "class" it belongs to, currently "read" or "write". We can change
this in future if we can work out a sensible scheme. This is purely used for the
GUI to "clump" similar capabilties together

I would recommend we create a table for each module with the name, module and class of the capability

==Moodle Site==

<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Create Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Delete Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Create Catagory</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>View Courses</td>
<td>Site</td>
<td>Read</td>
<td></td>
</tr>

<tr>
<td>Add User</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>Move course to another category</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>Make course visible to students</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>new features? Site wide subscription default/setting</td>
<td>Site</td>
<td>optional/forced etc</td>
<td>recommended default optional for all OU forums</td>
</tr>

<tr>
<td>Access site</td>
<td>Site</td>
<td>read/write/no access</td>
<td>used to ban individuals from Moodle?</td>
</tr>
</table>

==Course - home page ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Add Blocks</td>
<td>Course</td>
<td>On/Off</td>
<td>CT & Staff = Off, Admins = On</td>
</tr>

<tr>
<td>Add/View users ALs/Staff/Students</td>
<td>Course</td>
<td>Read/Write</td>
<td>CT/Staff = Read (this should be managed through circe or the administrator). Admins = Write </td>
</tr>

<tr>
<td>Course settings</td>
<td>Course</td>
<td>Read/Write</td>
<td>Course teams = Read, Staff = no access. Admins = write</td>
</tr>

<tr>
<td>Move blocks?</td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff = off, Admin = on</td>
</tr>

<tr>
<td>Delete resource/page/activity/block </td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff= off, Admin = on. As we have no recovery process would it be best to prevent course teams from deleting resource pages & other items on the home page?</td>
</tr>

<tr>
<td>hide items</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, staff=off, admin=on</td>
</tr>

<tr>
<td>add resource</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which resource types are listed per course/site</td>
</tr>

<tr>
<td>add activity</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which activity types are listed per course/site</td>

<tr>
<td>upload calendar (OU feature?)</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write. CTs should not be able to upload a calendar (admin will add this & need to ensure the CT don't overwrite it with an alternative) </td>

<tr>
<td>edit calendar</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=write, Staff=read, admin=write </td>
</tr>

<tr>
<td>admin functions, e.g. back up, restore, import</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write </td>
</tr>

<tr>
<td>edit groups</td>
<td>Course</td>
<td>read/write</td>
<td>Admins = write CT/Moderators=on staff=read?</td>
</tr>

<tr>
<td>Access course</td>
<td>Course</td>
<td>read/write/no access</td>
<td></td>
</tr>

</table>

==Course - resource page (OU version) ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>add authid</td>
<td>Course (resource page)</td>
<td>Read/Write</td>
<td>Admin=Write, CT=Read</td>
</tr>

<tr>
<td>add placeholder</td>
<td>Course (resource page)</td>
<td>on/off</td>
<td>admin=on, CT=Off</td>
</tr>

<tr>
<td>Add RSS feed</td>
<td>Course resource page</td>
<td>on/off</td>
<td>admin=on, ct=off?</td>
</tr>

<tr>
<td>access page</td>
<td>Course resource page</td>
<td>read/write/noaccess</td>
<td>use to restrict access to pages by role?</td>
</tr>
</table>

==Forum==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>move discussion to (archive/move feature)</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL=off?</td>
</tr>

<tr>
<td>update this forum</td>
<td>Forum</td>
<td>read/write</td>
<td>admin=write, CT/Moderator=off? it would be good to break this down further and or premote some defaults for use. e.g subscription I think there should be a server wide default of optional for all OU forums which can't be oevrriden at the course level.</td>
</tr>

<tr>
<td>delete message/thread</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off? some course teams won't want students/als to be able to delete their own posts</td>
</tr>

<tr>
<td>split</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off </td>
</tr>

<tr>
<td>post to forum</td>
<td>Forum</td>
<td>on/off</td>
<td></td>
</tr>

<tr>
<td>access forum</td>
<td>Forum</td>
<td>read/write/no access</td>
<td></td>
</tr>

<tr>
<td>attach file to message</td>
<td>Forum</td>
<td>on/off access</td>
<td></td>
</tr>

</table>

==Blog==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Quiz==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Wiki==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Resources==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Questions==
I am adding question categories here because they seem to have been forgotten since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118].

==Scenarios==

This section is for brainstorming some example roles that we would like to support:

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.

In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]

[[ru:Роли]]

Roles

2006-07-15T12:23:38Z

Hatshepsut: /* Questions */

'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.

''Please note that none of the following is finalised.''

==Definitions==

By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.

A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role.

To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==The plan==

There are a few major things that need to be done. Here's a list (in no particular order):

#Identify permissions required for site/course/each module.
#Define the database structure for storing roles and capabilities.
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?
#Consider interface issues, especially how to manage conflicting role/exception rules.
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?
#Consider the impact on backup/restore.
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.

==Capabilities==

This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?

What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)

Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.

Do we need to add canview and cansearch logs at site/course/user/group level?

I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)

===Core-level Capabilities===

Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php
Do we still keep student view? What is a student view?

#moodle/site:config - applicialbe in admin/index.php and config.php (might break down later)
#moodle/course:create - create courses
#moodle/course:view - possibly a capability used for checking student role
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:update - updates a course, i.e. adding/removing/editting activities
#moodle/course:viewscales - view scales (i.e. in a help window?)
#moodle/course:managescales - add, delete, edit scales, move scales up and down
#moodle/course:managegroups - managing groups, add, delete, add user in etc

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:read - reading the assignment description
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entry
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:managediscussions
##mod/forum:viewrating
##mod/forum:rate
#Glossary
##mod/glossary:read - view entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:readrate - view rating?
#Hotpot
#Label
#Lams
#Lesson
#Quiz
#Resource
#Scorm
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
#Workshop

==OU Desired Capabilities==

We will use this page to detail the specific capabilities needed to create the roles for the OU. Each capability has three parts:

# the name itself which can be anything and should be simple and short
# the name of the module it belongs to ("moodle", "blog", "course", "forum" etc)
# the name of the "class" it belongs to, currently "read" or "write". We can change
this in future if we can work out a sensible scheme. This is purely used for the
GUI to "clump" similar capabilties together

I would recommend we create a table for each module with the name, module and class of the capability

==Moodle Site==

<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Create Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Delete Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Create Catagory</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>View Courses</td>
<td>Site</td>
<td>Read</td>
<td></td>
</tr>

<tr>
<td>Add User</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>Move course to another category</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>Make course visible to students</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>new features? Site wide subscription default/setting</td>
<td>Site</td>
<td>optional/forced etc</td>
<td>recommended default optional for all OU forums</td>
</tr>

<tr>
<td>Access site</td>
<td>Site</td>
<td>read/write/no access</td>
<td>used to ban individuals from Moodle?</td>
</tr>
</table>

==Course - home page ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Add Blocks</td>
<td>Course</td>
<td>On/Off</td>
<td>CT & Staff = Off, Admins = On</td>
</tr>

<tr>
<td>Add/View users ALs/Staff/Students</td>
<td>Course</td>
<td>Read/Write</td>
<td>CT/Staff = Read (this should be managed through circe or the administrator). Admins = Write </td>
</tr>

<tr>
<td>Course settings</td>
<td>Course</td>
<td>Read/Write</td>
<td>Course teams = Read, Staff = no access. Admins = write</td>
</tr>

<tr>
<td>Move blocks?</td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff = off, Admin = on</td>
</tr>

<tr>
<td>Delete resource/page/activity/block </td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff= off, Admin = on. As we have no recovery process would it be best to prevent course teams from deleting resource pages & other items on the home page?</td>
</tr>

<tr>
<td>hide items</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, staff=off, admin=on</td>
</tr>

<tr>
<td>add resource</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which resource types are listed per course/site</td>
</tr>

<tr>
<td>add activity</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which activity types are listed per course/site</td>

<tr>
<td>upload calendar (OU feature?)</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write. CTs should not be able to upload a calendar (admin will add this & need to ensure the CT don't overwrite it with an alternative) </td>

<tr>
<td>edit calendar</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=write, Staff=read, admin=write </td>
</tr>

<tr>
<td>admin functions, e.g. back up, restore, import</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write </td>
</tr>

<tr>
<td>edit groups</td>
<td>Course</td>
<td>read/write</td>
<td>Admins = write CT/Moderators=on staff=read?</td>
</tr>

<tr>
<td>Access course</td>
<td>Course</td>
<td>read/write/no access</td>
<td></td>
</tr>

</table>

==Course - resource page (OU version) ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>add authid</td>
<td>Course (resource page)</td>
<td>Read/Write</td>
<td>Admin=Write, CT=Read</td>
</tr>

<tr>
<td>add placeholder</td>
<td>Course (resource page)</td>
<td>on/off</td>
<td>admin=on, CT=Off</td>
</tr>

<tr>
<td>Add RSS feed</td>
<td>Course resource page</td>
<td>on/off</td>
<td>admin=on, ct=off?</td>
</tr>

<tr>
<td>access page</td>
<td>Course resource page</td>
<td>read/write/noaccess</td>
<td>use to restrict access to pages by role?</td>
</tr>
</table>

==Forum==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>move discussion to (archive/move feature)</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL=off?</td>
</tr>

<tr>
<td>update this forum</td>
<td>Forum</td>
<td>read/write</td>
<td>admin=write, CT/Moderator=off? it would be good to break this down further and or premote some defaults for use. e.g subscription I think there should be a server wide default of optional for all OU forums which can't be oevrriden at the course level.</td>
</tr>

<tr>
<td>delete message/thread</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off? some course teams won't want students/als to be able to delete their own posts</td>
</tr>

<tr>
<td>split</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off </td>
</tr>

<tr>
<td>post to forum</td>
<td>Forum</td>
<td>on/off</td>
<td></td>
</tr>

<tr>
<td>access forum</td>
<td>Forum</td>
<td>read/write/no access</td>
<td></td>
</tr>

<tr>
<td>attach file to message</td>
<td>Forum</td>
<td>on/off access</td>
<td></td>
</tr>

</table>

==Blog==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Quiz==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Wiki==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Resources==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Questions==
I am adding question categories here because they seem to have been forgotten since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in [[http://www.moodle.org/bugs/bug.php?op=show&bugid=6118&pos= bug 6118]].

==Scenarios==

This section is for brainstorming some example roles that we would like to support:

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.

In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]

[[ru:Роли]]

Roles

2006-07-15T12:21:59Z

Hatshepsut:

'''Roles and capabilities''' are planned to be included in Moodle 1.7. For now, we have some basic ideas of how to implement such a structure in Moodle.

''Please note that none of the following is finalised.''

==Definitions==

By roles, we mean an identifier of the user's status, for example, teacher, student and forum moderator are examples of roles.

A capability is a permission to access some particular Moodle feature. Capabilities are associated with roles. For example, ''forum_canreadpost'' is a capability.

==The existing system==

Currently in Moodle, we have a fixed set of roles i.e. primary admin, admins, course creators, editing teachers, non-editing teachers, students, and guests. For each role, the capability or actions that they can performed are fixed. For example, the role student allows the user to submit an assignment, but doesn't allow the user to browse/edit other users' work. By using this setup we limit ourselves to a rather rigid set of capabilities for each role. If we want, say a particular student or group to be able to mark assignments in a particular course, we can't do that without giving these users teacher privileges.

==The new roles and capability system==

The new system will allow authorized users to define an arbitrary number of roles. Each role can have a customizable set of capabilities in every context. A context can be the whole Moodle site, a course, or a module instance, e.g. quiz 5 in 'Introduction to Photography'. An authorized user will be able to assign an arbitrary number of roles to each user. Since the capabilities in each role could be different, there could be conflict in capabilities. This is resolved by giving roles different 'priorities'. For example, to prevent a naughty student from posting, one could assign him a 'naughty student' role that does not allow him to post. This role should have a priority higher than that of a normal 'student' role.

To facilitate exceptional cases in roles and capabilities, we can use exception rules. For example, we can specify a rule saying that all students are able to mark/read other students' assignment in this particular course. Note that such rules need to have a priority as well. The capability of a user, in any context is then resolved by finding the highest priority role/rule.

''A smooth upgrade will be provided with 1.7. The existing roles (admin, teacher, student, etc), and the exisiting capabilities will be retained. This is done by creating default roles at site/course levels, and assigning the current users to these roles accordingly. The default roles will have default capabilities associated with them, which pretty much is what we have in 1.6. The whole process is automatic so there's nothing to worry about =). With no modifications, Moodle will operate exactly the same before and after the upgrade.''

==The plan==

There are a few major things that need to be done. Here's a list (in no particular order):

#Identify permissions required for site/course/each module.
#Define the database structure for storing roles and capabilities.
#Recode the whole of Moodle, including all modules to support the new structure. Instead of using <code>isteacher()</code> or <code>isstudent()</code> we should be using <code>has_capability($capability, $instanceid)</code> etc. A new API for handling roles and capabilities will be implemented (accesslib.php).
#Add storage of capabilities for each module. Can be done either in a file, e.g. db/capability.xml, or as a sql file that gets installed to a central db whenever this module is installed. Either way, what do we do when we need to upgrade these capabilities? Some capabilities might need refining/splitting later on. How do we control the 'version' of a capability?
#Consider interface issues, especially how to manage conflicting role/exception rules.
#Upon logging in, we should use a cache to store capability, down to module level. How should that be structured?
#Consider the impact on backup/restore.
#Upgrade path for current users. The user information in table user_coursecreators, user_admins, user_teachers, and user_students will most likely be migrated to the new roles and capabilities tables. The users will most likely be assigned default roles that comes with default capabilities (e.g. teachers, admins, students, etc). The old tables themselves could possibly be dropped at the end of the upgrade.

==Capabilities==

This is a comprehensive list of capabilities, well, in the making. It is important that capability names are unique. Please edit. Should we distinguish canedit and candelete?

What about a canview capability? Like for choice, where a person is allowed to see the choice question but not participate in it? --[[User:N Hansen|N Hansen]] 19:29, 16 May 2006 (WST)

Certainly need a canview or cansee capability for parents as linked to their child's data/contributions.

Do we need to add canview and cansearch logs at site/course/user/group level?

I could use a canview at a course level, if I understand what that means exactly.--[[User:N Hansen|N Hansen]] 19:43, 12 June 2006 (WST)

===Core-level Capabilities===

Moodle core capabilitie names start with 'moodle/'. The capabilities for the Moodle core are defined in lib/db/access.php
Do we still keep student view? What is a student view?

#moodle/site:config - applicialbe in admin/index.php and config.php (might break down later)
#moodle/course:create - create courses
#moodle/course:view - possibly a capability used for checking student role
#moodle/course:viewparticipants - allows a user to view participant list
#moodle/course:update - updates a course, i.e. adding/removing/editting activities
#moodle/course:viewscales - view scales (i.e. in a help window?)
#moodle/course:managescales - add, delete, edit scales, move scales up and down
#moodle/course:managegroups - managing groups, add, delete, add user in etc

===Module-level Capabilities===
The capabilities are cached into a database table when a module is installed or updated. Whenever the capability definitions are updated, the module version number should be bumped up so that the database table can be updated.

The naming convention for capabilities that are specific to modules and blocks is 'mod/mod_name:capability'. The module capabilities are defined in mod/mod_name/db/access.php.

#Assignment
##mod/assignment:read - reading the assignment description
##mod/assignment:grade - grading, viewing of list of submitted assignments
#Chat
##mod/chat:chat - allows a user to participate in this chat
##mod/chat:readlog - allows a user to read past chat session logs
##mod/chat:deletelog - allows a user to delete past chat logs
#Choice
##mod/choice:choose - make a choice
##mod/choice:readresponses - read all responses
##mod/choice:deleteresponses - deletes all responses
##mod/choice:downloadresponses - download responses
#Database
##mod/data:readentry - reads other people's entry
##mod/data:writeentry - add / edit and delete (own) entries
##mod/data:managetemplates - add, delete, edit fields and templates
##mod/data:manageentries - edit/delete all entry
##mod/data:comment - comment
##mod/data:managecomments - edit/delete all comments
##mod/data:rate - rate an entry
##mod/data:approve - approves an entry
##mod/data:uploadentries - batch upload of entries
#Exercise
##mod/exercise:assess
#Forum
##mod/forum:viewforum
##mod/forum:viewdiscussion
##mod/forum:viewdiscussionsfromallgroups
##mod/forum:startdiscussion
##mod/forum:replypost
##mod/forum:managediscussions
##mod/forum:viewrating
##mod/forum:rate
#Glossary
##mod/glossary:read - view entries
##mod/glossary:write - add entries
##mod/glossary:manageentries - add, edit, delete entries
##mod/glossary:managecategories - create, delete, edit categories
##mod/glossary:comment - comment on an entry
##mod/glossary:managecomments - edit, delete comments
##mod/glossary:import - import glossaries
##mod/glossary:export - export glossaries
##mod/glossary:approve - approve glossaries
##mod/glossary:rate - rates glossary
##mod/glossary:readrate - view rating?
#Hotpot
#Label
#Lams
#Lesson
#Quiz
#Resource
#Scorm
#Survey
##mod/survey:download - downloads survery result
##mod/survey:participate - participate/ do survey
##mod/survey:readresponses - read all user's responese
#Wiki
#Workshop

==OU Desired Capabilities==

We will use this page to detail the specific capabilities needed to create the roles for the OU. Each capability has three parts:

# the name itself which can be anything and should be simple and short
# the name of the module it belongs to ("moodle", "blog", "course", "forum" etc)
# the name of the "class" it belongs to, currently "read" or "write". We can change
this in future if we can work out a sensible scheme. This is purely used for the
GUI to "clump" similar capabilties together

I would recommend we create a table for each module with the name, module and class of the capability

==Moodle Site==

<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Create Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Delete Course</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>
<tr>
<td>Create Catagory</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>View Courses</td>
<td>Site</td>
<td>Read</td>
<td></td>
</tr>

<tr>
<td>Add User</td>
<td>Site</td>
<td>Write</td>
<td></td>
</tr>

<tr>
<td>Move course to another category</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>Make course visible to students</td>
<td>Site</td>
<td>write</td>
<td></td>
</tr>

<tr>
<td>new features? Site wide subscription default/setting</td>
<td>Site</td>
<td>optional/forced etc</td>
<td>recommended default optional for all OU forums</td>
</tr>

<tr>
<td>Access site</td>
<td>Site</td>
<td>read/write/no access</td>
<td>used to ban individuals from Moodle?</td>
</tr>
</table>

==Course - home page ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>Add Blocks</td>
<td>Course</td>
<td>On/Off</td>
<td>CT & Staff = Off, Admins = On</td>
</tr>

<tr>
<td>Add/View users ALs/Staff/Students</td>
<td>Course</td>
<td>Read/Write</td>
<td>CT/Staff = Read (this should be managed through circe or the administrator). Admins = Write </td>
</tr>

<tr>
<td>Course settings</td>
<td>Course</td>
<td>Read/Write</td>
<td>Course teams = Read, Staff = no access. Admins = write</td>
</tr>

<tr>
<td>Move blocks?</td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff = off, Admin = on</td>
</tr>

<tr>
<td>Delete resource/page/activity/block </td>
<td>Course</td>
<td>on/off</td>
<td>CT/Staff= off, Admin = on. As we have no recovery process would it be best to prevent course teams from deleting resource pages & other items on the home page?</td>
</tr>

<tr>
<td>hide items</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, staff=off, admin=on</td>
</tr>

<tr>
<td>add resource</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which resource types are listed per course/site</td>
</tr>

<tr>
<td>add activity</td>
<td>Course</td>
<td>on/off</td>
<td>Ct=on, Staff=off, admin=on used in conjunction with admin filer to restrcit which activity types are listed per course/site</td>

<tr>
<td>upload calendar (OU feature?)</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write. CTs should not be able to upload a calendar (admin will add this & need to ensure the CT don't overwrite it with an alternative) </td>

<tr>
<td>edit calendar</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=write, Staff=read, admin=write </td>
</tr>

<tr>
<td>admin functions, e.g. back up, restore, import</td>
<td>Course</td>
<td>read/write</td>
<td>Ct=read, admin=write </td>
</tr>

<tr>
<td>edit groups</td>
<td>Course</td>
<td>read/write</td>
<td>Admins = write CT/Moderators=on staff=read?</td>
</tr>

<tr>
<td>Access course</td>
<td>Course</td>
<td>read/write/no access</td>
<td></td>
</tr>

</table>

==Course - resource page (OU version) ==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>add authid</td>
<td>Course (resource page)</td>
<td>Read/Write</td>
<td>Admin=Write, CT=Read</td>
</tr>

<tr>
<td>add placeholder</td>
<td>Course (resource page)</td>
<td>on/off</td>
<td>admin=on, CT=Off</td>
</tr>

<tr>
<td>Add RSS feed</td>
<td>Course resource page</td>
<td>on/off</td>
<td>admin=on, ct=off?</td>
</tr>

<tr>
<td>access page</td>
<td>Course resource page</td>
<td>read/write/noaccess</td>
<td>use to restrict access to pages by role?</td>
</tr>
</table>

==Forum==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>

<tr>
<td>move discussion to (archive/move feature)</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL=off?</td>
</tr>

<tr>
<td>update this forum</td>
<td>Forum</td>
<td>read/write</td>
<td>admin=write, CT/Moderator=off? it would be good to break this down further and or premote some defaults for use. e.g subscription I think there should be a server wide default of optional for all OU forums which can't be oevrriden at the course level.</td>
</tr>

<tr>
<td>delete message/thread</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off? some course teams won't want students/als to be able to delete their own posts</td>
</tr>

<tr>
<td>split</td>
<td>Forum</td>
<td>on/off</td>
<td>admin=on, CT/Moderator=on AL/student=off </td>
</tr>

<tr>
<td>post to forum</td>
<td>Forum</td>
<td>on/off</td>
<td></td>
</tr>

<tr>
<td>access forum</td>
<td>Forum</td>
<td>read/write/no access</td>
<td></td>
</tr>

<tr>
<td>attach file to message</td>
<td>Forum</td>
<td>on/off access</td>
<td></td>
</tr>

</table>

==Blog==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Quiz==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Wiki==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Resources==
<table width=60% border=0>
<tr bgcolor=#EEEEEE>
<td>Name</td>
<td>Module</td>
<td>Class</td>
<td>Comment</td>
</tr>
<tr>
<td>replace</td>
<td>replace</td>
<td>replace</td>
<td>replace</td>
</tr>
</table>

==Questions==
I am adding question categories here because they seem to have been forgotten since having been removed from the quiz module itself. I've made a suggestion on how these could be handled in bug 6118.

==Scenarios==

This section is for brainstorming some example roles that we would like to support:

===Student===
Has this one been missed?

===Site Designers===
Is there a role for people involved in how the site looks but not full administrators? Thinking here of online control of themes rather than FTP theme uploading. But in either case they caneditlogos, caneditcss, candeditlevelatwhichthemeapplies.

===Educational Authority Adviser===
Someone who would want to browse the site and may be asked to comment or contribute to particular discussions or developments in school. Access for this role would be controlled by the school in the case of school level moodles but may be different if there were to be a Local Authority wide Moodle.

===Educational Inspector===
Someone who will visit the site to verify the school's self review that comments on home school relationships, extending the classroom etc. They may want to see summaries of usage and reports from surveys garnering parent and pupil views.

===Second Marker / Moderator===
A teacher within ths site that has access to assignments and quizzes from another teacher's course for second marking purposes. This may need additional functionality adding to the assignment module so that two sets of grades/feedback can be given to one set of assignments.

===External Examiner===
Has all the rights of inpectors, but would also need to be able to review assignments and feedback, view forums, glossaries etc. However, would not want to post, feedback onto the site at all.

===Parent===
A parent will have one or more children in one or more institutions which could be using one or more moodle instances or a mixture of Learning Platforms. A parent's role will vary depending on the age of their children and whether they are contributing as a parent or a school supporter.

In Early Years (EY) and Key Stage 1 (KS1) they may play/learn on an activity or write for the child. Parents often interpret homework tasks and read to their children perhaps filling in a joint reading diary.

In Key stages 3 and 4 this changes to more of a monitoring/awareness role where a parent would expect to have a summary report of attendance, attainment and general achievement on a weekly/monthly/termly or annual basis. Parents will often be asked to sign and write back comments about this review report.

In all Key Stages there is a great need for parents to receive communication from the school which they can confirm they have received by signing a form. In some cases this may also involve making choices from a list. It may also involve payment for a trip or disco being returned so there could be the possibility of electronic payments.

Parent's evenings often involve complex booking systems that attempt to get parent's and teachers together. Easy for EY/KS1/KS2 very difficult for KS3/KS4. Wow would this help if it was built into the Learning Platform.

In some cases there needs to be confidential communication between the parent and the teacher without the child being party to this. It may involve teaching and learning but could also involve a behaviour or medical issue. Often this may be done via a sealed letter or face to face.

The latest incarnation of OfSTED with the Self Review Framework (SEF) there is a greater emphasis on schools gathering parent voice via surveys and discussion. There is a clear match here with parents have access to parental votes, questionnaires and discussions and for schools to be able to publish news, results and reports back to parents.

In the UK the LP framework and agenda as being pushed by the DfES via Becta emphasises that within the mandatory groups and roles functionality the parent role is likely to be required to meet the LP Framework procurement standard.

===Manager===
''Please add text here...''

===Weekly Seminar Leader===
''In a university seminar, typically 8-15 students in their 3rd/4th year, each student is responsible for leading one topic in a study series. I ask each student to research 5-10 resources, then give a powerpoint presentation to the other students. This is followed by an in-class discussion and then online homework. The homework involves some fun quiz questions and then some reflective journal questions. I ask each seminar leader to prepare the quiz questions and journal questions as well as their presentation. To do that, I would like to assign activity-making/authoring roles to the student--either for a short period, or for duration of the whole course. Thus "Allow Quiz Authoring Role" or "Allow Assignment Authoring Role" at the course level or, if possible, even the Topic level (in a topic or week format course) would be important.''

===Mentor/Mentee===
''Please add text here...''

===Community-Designed Rating Criteria===
''The gradebook tends to be the domain of the teacher. What if community/peer ratings/marks could also be entered there? What if peer assessment criteria could be designed by the students, not just the teacher?''

===Visitor===

This would be a role whereby one could allow a visitor to visit one's classroom. This might be a colleague interested in seeing your course, or a journalist who might be writing an article about one's site. They should not be able to see the names of any students anywhere (eg recent activity, forum posts) for privacy reasons. They should be able to try out things like quizzes, and lessons but no grades would be recorded (like in teacher preview mode). They would not be able to participate in choices and forums but could view them. It would be read only in a way like former-student role below but without access to a particular student's records that former student role would grant.

===Former Student===
This role would be of particular use for courses with rolling enrollments. This role would be one where a student had completed all of the requirements of a course (ie assignments, quizzes etc.) but wished to have continued access to the course material for review or consultation. The key factor is that one would give access to the completed student to the notes he read, his work and the teacher's comments on it, but he would not be allowed to do anything that would take up the teacher's time. In other words, a sort-of read-only access to the course. How forums, which might contain pertinent information and would continue to grow, would be handled is a question. Perhaps the student would be shown only what was in the forums at the time he completed the course. He would not be allowed to see any new posts or add any himself. Same thing for database and glossary entries. In other words, a snapshot of the course at the time his regular enrollment ended. He shouldn't be able to see the names or profiles of any newly enrolled students for privacy reasons-hence the restrictions on forum access. One issue that would have to be dealt with would be changes to existing modules-such as resources. Does the student get access to the module as it was or as it is? We have no versioning of resources in Moodle so this would be a problem. What about a teacher changing a quiz question so that the answer is different? What would a former student see?

===Librarian===

Reference Librarians have an active role in most of the courses taught at Earlham College (with Bibliographic Instruction). The Librarian role within Moodle could encompass default read access to all courses (unless prohibited by course teacher) and read access to all components of the course unless access is barred (again by teacher). The Librarians would also perhaps have a block called perhaps Reference Services or Reference Desk with write access where they could deposit resources. Also this block might have a chat applet whereby enrolled students could chat to the Reference Librarian on duty about their bibliographic research needs.

===Teacher===

Teachers should have read access to other Teacher's courses unless explictly prohibited. They should be able to set parts of their own course to be totally private (perhaps even to admin?). Just as each activity can currently be set to have group access, each activity could have a permissions field. Teachers could set default permissions for all activities on their course (eg they might disallow Librarian access for example) and then change the access permission for an individual activity.

I think that what is needed is a simple heirarchy of permissions and levels of granularity.

I would take issue with "teachers should have read access to other teacher's courses unless explicitly prohibited." This is a violation of the students' privacy as how they perform and what they do in one class isn't the business of another teacher. Moreover, in the real world a teacher wouldn't suddenly go sit in on a colleague's class without asking permission first. I would not have appreciated such an invasion of privacy as either a teacher or a student. It could be an option, but shouldn't be default.--[[User:N Hansen|N Hansen]] 19:54, 12 June 2006 (WST)

===Community Education Tutors/Trainers===
Teachers may be community adult education trainers making use of a school moodle so must only have access to their courses unless given access elsewhere. They would not necessarily get the default teacher privileges.

===Secretary/Student Worker===

We often have faculty who want their departmental secretary or student worker to scan and upload files and perhaps create resources. Currently they have to be given teacher access to the course. This is dangerous from a FERPA standpoint since they could easily get access to grades.

===Teaching Assistant===

Our Faculty frequently have undergraduate students acting as Teaching Assistants. These students need to be able to add resources, create assignments, and possibly grade assignments. However, due to FERPA they cannot have access to other students' overall grade information. I think the requirements here are slightly different than those of Secretary/Student Worker

===Admin - Catgory based===

Basically a person in between full Admin and Creator that has the permissions of an Admin but only with respect to courses and students. Currently a Creator has permissions site-wide which does not always meet the requirements of a given organisation (e.g. Department A may not be happy that a person from Department B can create/modify courses within Department A's area). The ability to designate a Creator within a specific category would allow areas to be set up for a faculty/department/organisation and allow the Admin for that area to create/delete courses, upload users, add site-wide entries to the calendar etc.

===PROCESS ROLES===

organising the learning process for a group you wish to have the choice to place students in differnt roles: examples of this are:
<li>1. Give a student the role of forum-moderator with edit and chunk-rights
<li>2. Give students different roles & rights in a Webquest design (and change these roles next week
<li>3. Give students different resources, depending of their roles in a rolegame/simulation
<li>4. Give a student the rights to create the section content of next week (and only that week..)
<li>5. ..

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=38788 Roles and Permissions architecture] forum discussion

[[Category:Future]]

[[ru:Роли]]

UK MoodleMoot 06 hackfest

2006-07-12T00:30:34Z

Hatshepsut: /* 2 What next for the quiz module? */

Monday 24th July, 2006

''Welcommen zum Hackfest'' (OK - I've been watching too much WorldCup on TV).

The first MoodleMoot hackfest is nearly upon us... and we don't have an agenda!

This is an open source agenda for the hackfest. We'll have a day before the Moot to geek out on some code, maybe develop a feature or two, fix some bugs and generally make our favorite learning system a happier place. But I leave it up to you to tell me exactly what we should do. We have four or five rooms with internet connections, a few projectors, and I'll try to get pizza.

Let's start by brainstorming some ideas here for a few days. If someone posts something you're interested in, put your name under it as a vote. The top votes become our central organizing ideas. For example

==1 Bug fixing==

Let's spend a few hours and hunt down as many outstanding bugs in 1.6 as possible. Bounties for most bugs killed, trickiest bug killed, and most unusual bug killed.

''I'm Interested:''
# Jason Cole
# skodak
# martin langhoff (auth & enrolment specifically).
# Martin Dougiamas
# Juliette White (arriving late though!)

(iarenaza) I won't be there, but here are a couple of bugs for Martin L., related to auth: #4648 and #5373. Very easy to fix :-)

==2 What next for the quiz module?==

If any other quizzy people are there, we should have a talk about where we see the quiz module going.

I/the OU have the following priorities:

# Make question type plugins really plug-in-able. At the moment there are some limitations:
#* All the lang strings are still in lang/en_utf8/quiz.php.
#* qtype plugins cannot easily feed CSS and Javascript into the page.
#* pluggable qtypes and pluggable inport/export filters don't play nicely together.
# Write some new question types.
# Make some improvements to existing question types.
# Get RQP working again, so our in-house question engine can talk to Moodle.

I'm not going to be there, but I think it would be helpful if you were to discuss ways in which the teacher's usage of the quiz module could be made more efficient, more in terms of grading than in creating quizzes (as there have already been a lot of improvements in that respect in 1.6). I've submitted a lot of bug reports about this already but personally efficiency would be more of a priority to me than new question types.--[[User:N Hansen|N Hansen]] 08:27, 12 July 2006 (WST)

''I'm Interested:''
# Tim Hunt
# Jamie Pratt

==Performance profiling==

Pick a (memory|database) hog and put it on a diet.

''I'm interested''

# martin langhoff

(iarenaza) Once again, I won't be there, but here's an unfixed bug in 1.6.x and HEAD (was fixed in 1.5.x, but not applied to HEAD at the moment): bug #4591

==Hacking on the OLPC Board==

MartinL will be bringing the OLPC board (if it is booting, and customs allows!) for people to have a play with it. If we have any Mozilla/XUL experts in the house, he will want to explore building a limited cached Moodle UI with it for offline work.

'''Note:''' We will need some spare parts & hardware to get the board going. I will bring a power supply, but a VGA monitor, USB mouse + keyboard, USB ext disk, USB hub, and open wifi (no ethernet on the board) will be needed.

''JC: We'll make sure you have the appropriate stuff. I need a USB disk anyway.''

''I'm interested:''

# martin langhoff
# Jason Cole

==How to save/retrieve a complete section from stock?==
Now the sections become more and more accepted as the tasksets for a week, our teachers wish to have topic oriented stores (courses for the moment) as section stores and want to copy one/more sections form that task store to a clean course..

''(In the end we wish that students can select sections from the store to compose their own courses, until the teacher freezes their choice set and the learning game can begin.)''

''I'm interested:''
# Ger Tielemans (I arrive a little later, so start with the bugs first, please :))
# Jan Kater (same arrival=same message as Ger T.)

==How to reveale files outside a course without using datadir for course 1?==
Can someone explain the right setup and use of the exception array:
- we want to show a student (after login) only his own file from that store
- we want to show a teacher/tutor only the files from the students in his course(s)

''I'm interested:''
# Ger Tielemans
# Jan Kater

==How to repair the last bug in the old bookmark option ?==
We changed William's bookmark in a student only note-taking tool and (thanks Chardelle!) almost repaired the complete bookmark for 1.6. (and it can be accessed from My Page)
Bug: Only when the user tries to sort the heder in the overview, the text of the headers disappear.
Code clean-up: how to remove obsolete code and make the bookmark pages secure?
(Wish for new code: categories are privat, so allow a student to delete a self created category)

''I'm interested:''
Ger Tielemans

==How to insert a HTML-editor in old code block and make it secure ?==
To make the set of student note-taking tools complete, I found old code to have a global private notebook.
(I group this with bookmarks in the calender, so the student has: 1. privat time-related-notes in the calendar, 2. a button for the overview of the privat page-related-notes under the calendar and 3. a global privat notebook for other scribbles..)
On this moment this piece of code has a flat text editor, would be nice to have HTML or even the new (Ajax?) miniWiki?)

With the new "View as student button" check like if isstudent() {..show..} offers teachers and admins empty - only for real student - spots (so an error)

''I'm interested:''
# Ger Tielemans
# Jan Kater

== Improve the way we integrate Rubrics in Moodle, like... ==
http://docs.subjectivemetrics.com/User/cam/rubistar/rs_overview.html

maybe with some flavors of...

http://ipeer.apsc.ubc.ca/ipeer_site/

==Add your suggestion here ...==

Go on, you know you want to.

==See also==
* [http://moodlemoot.org/ http://moodlemoot.org/]

UK MoodleMoot 06 hackfest

2006-07-12T00:27:57Z

Hatshepsut: /* 2 What next for the quiz module? */

Monday 24th July, 2006

''Welcommen zum Hackfest'' (OK - I've been watching too much WorldCup on TV).

The first MoodleMoot hackfest is nearly upon us... and we don't have an agenda!

This is an open source agenda for the hackfest. We'll have a day before the Moot to geek out on some code, maybe develop a feature or two, fix some bugs and generally make our favorite learning system a happier place. But I leave it up to you to tell me exactly what we should do. We have four or five rooms with internet connections, a few projectors, and I'll try to get pizza.

Let's start by brainstorming some ideas here for a few days. If someone posts something you're interested in, put your name under it as a vote. The top votes become our central organizing ideas. For example

==1 Bug fixing==

Let's spend a few hours and hunt down as many outstanding bugs in 1.6 as possible. Bounties for most bugs killed, trickiest bug killed, and most unusual bug killed.

''I'm Interested:''
# Jason Cole
# skodak
# martin langhoff (auth & enrolment specifically).
# Martin Dougiamas
# Juliette White (arriving late though!)

(iarenaza) I won't be there, but here are a couple of bugs for Martin L., related to auth: #4648 and #5373. Very easy to fix :-)

==2 What next for the quiz module?==

If any other quizzy people are there, we should have a talk about where we see the quiz module going.

I/the OU have the following priorities:

# Make question type plugins really plug-in-able. At the moment there are some limitations:
#* All the lang strings are still in lang/en_utf8/quiz.php.
#* qtype plugins cannot easily feed CSS and Javascript into the page.
#* pluggable qtypes and pluggable inport/export filters don't play nicely together.
# Write some new question types.
# Make some improvements to existing question types.
# Get RQP working again, so our in-house question engine can talk to Moodle.

I'm not going to be there, but I think it would be helpful if you were to discuss ways in which the teacher's usage of the quiz module could be made more efficient. I've submitted a lot of bug reports about this already but personally efficiency would be more of a priority to me than new question types.--[[User:N Hansen|N Hansen]] 08:27, 12 July 2006 (WST)

''I'm Interested:''
# Tim Hunt
# Jamie Pratt

==Performance profiling==

Pick a (memory|database) hog and put it on a diet.

''I'm interested''

# martin langhoff

(iarenaza) Once again, I won't be there, but here's an unfixed bug in 1.6.x and HEAD (was fixed in 1.5.x, but not applied to HEAD at the moment): bug #4591

==Hacking on the OLPC Board==

MartinL will be bringing the OLPC board (if it is booting, and customs allows!) for people to have a play with it. If we have any Mozilla/XUL experts in the house, he will want to explore building a limited cached Moodle UI with it for offline work.

'''Note:''' We will need some spare parts & hardware to get the board going. I will bring a power supply, but a VGA monitor, USB mouse + keyboard, USB ext disk, USB hub, and open wifi (no ethernet on the board) will be needed.

''JC: We'll make sure you have the appropriate stuff. I need a USB disk anyway.''

''I'm interested:''

# martin langhoff
# Jason Cole

==How to save/retrieve a complete section from stock?==
Now the sections become more and more accepted as the tasksets for a week, our teachers wish to have topic oriented stores (courses for the moment) as section stores and want to copy one/more sections form that task store to a clean course..

''(In the end we wish that students can select sections from the store to compose their own courses, until the teacher freezes their choice set and the learning game can begin.)''

''I'm interested:''
# Ger Tielemans (I arrive a little later, so start with the bugs first, please :))
# Jan Kater (same arrival=same message as Ger T.)

==How to reveale files outside a course without using datadir for course 1?==
Can someone explain the right setup and use of the exception array:
- we want to show a student (after login) only his own file from that store
- we want to show a teacher/tutor only the files from the students in his course(s)

''I'm interested:''
# Ger Tielemans
# Jan Kater

==How to repair the last bug in the old bookmark option ?==
We changed William's bookmark in a student only note-taking tool and (thanks Chardelle!) almost repaired the complete bookmark for 1.6. (and it can be accessed from My Page)
Bug: Only when the user tries to sort the heder in the overview, the text of the headers disappear.
Code clean-up: how to remove obsolete code and make the bookmark pages secure?
(Wish for new code: categories are privat, so allow a student to delete a self created category)

''I'm interested:''
Ger Tielemans

==How to insert a HTML-editor in old code block and make it secure ?==
To make the set of student note-taking tools complete, I found old code to have a global private notebook.
(I group this with bookmarks in the calender, so the student has: 1. privat time-related-notes in the calendar, 2. a button for the overview of the privat page-related-notes under the calendar and 3. a global privat notebook for other scribbles..)
On this moment this piece of code has a flat text editor, would be nice to have HTML or even the new (Ajax?) miniWiki?)

With the new "View as student button" check like if isstudent() {..show..} offers teachers and admins empty - only for real student - spots (so an error)

''I'm interested:''
# Ger Tielemans
# Jan Kater

== Improve the way we integrate Rubrics in Moodle, like... ==
http://docs.subjectivemetrics.com/User/cam/rubistar/rs_overview.html

maybe with some flavors of...

http://ipeer.apsc.ubc.ca/ipeer_site/

==Add your suggestion here ...==

Go on, you know you want to.

==See also==
* [http://moodlemoot.org/ http://moodlemoot.org/]

Talk:Quiz database structure

2006-07-03T01:12:03Z

Hatshepsut:

The contents of the event field are now defined in questionlib.php. Should that fact be added here?--[[User:N Hansen|N Hansen]] 09:12, 3 July 2006 (WST)

Talk:Activity Locking

2006-07-02T12:21:06Z

Hatshepsut: /* Releases */

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayor. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

It would be helpful if when someone creates and lists a new version here they state what version their new version is based on.--[[User:N Hansen|N Hansen]] 04:38, 2 July 2006 (WST)

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]

'''AL v2.1(john)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006, based on the version of activity locking released by Stuart Meyor on October 19, 2005. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Johns Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them.[http://moodle.org/mod/forum/discuss.php?d=46863#220125 AL v2.1-M1.6]

'''AL v2.1 for 1.6(chardelle)''' - link posted by Chardelle on 25 June 2006, 03:35 PM. This flavor has a hide future activity function and seems to be functioning on some Moodles but is being tweaked for others. See forum discussion: [http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 Certificate 1.6 with Security discussion in Activity Module forum].The link for the external website is: [http://proemployees.com/ActivityLockingWithHide-1.6.zip AL v2.1 for 1.6(chardelle)].

[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Locking a topic is an all-or-nothing proposition. If you lock at topic, you cannot have individual conditions on locking of the items inside that topic. It would be nice if this were not the case.

Activity Locking

2006-07-02T05:21:28Z

Hatshepsut: /* AL Branch 3.s for Moodle 1.6 (Stuart Mayor) */

=Overview=
This page is an attempt to consolidate and explain the available activity locking (AL) code that is present for Moodle 1.5.x and 1.6.x. This page will hopefully help explain all the available versions and their respective features. Some of the reference here will overlap with the existing MoodleDoc page covering [[Conditional activities]].

Please be patient as this page is new and under development. See page comments for reference material.

=Types of activity locking code=
For the purpose of this MoodleDoc article: AL is any code that allows the user to make decisions on the next available resource or item the student will be able to use based on student events or quiz performance. There is some activity locking code that is very quick and dirty to simply lock future activities and then there is much more complex code based on the conditional activity though structure which attempts to progress the student through the course in a thought out progression based on activities and performance. Again we hope to clarify some of this here.

==AL Branch 1.0 (Bernard Boucher)==
Bernard started all this with a hack to lock the certificate based on a quiz score in 2004. It was a great start!

== AL Branch 2.1 for Moodle 1.6 (Stuart Meyor)==
*This has been virtually a complete rewrite and as such there are areas of functionality the were available in older versions of AL that are not in this.

* Conditional locking: Lock based on a user's performance in previous activities. You can also choose to unlock and activity if a user scores less than a certain grade.
* Show activity completion: The checkbox that appears before each activity to show it have been done.
* A variation on this also hides future activities, see AL Branch 2.1 for Moodle 1.6 (John Gschnaidner-Chardelle Busch) below.
* Bernard Boucher reworked Stuart's version and on June 20, 2006 posted [http://206.167.134.155/bb/authoring1/activity_locking_v2_for_16_20060620.zip '''Activity_locking_v2_for_16_20060620.zip'''] on [http://moodle.org/mod/forum/user.php?id=1323&course=5 Activity Locking v3 or v2 for testing only]. The link is outside moodle.org and the link was not working on June 29, 2006.

===Installation for 2.1 for Moodle 1.6(Stuart Meyor)===
'''activitylocking20051201.zip''' the initial version

* Firstly, you need the stable build of Moodle 1.6. This version of AL might work on earlier releases but I didn't write it with them in mind and I certainly can't support them.
Next, you need to modify one table in the database and add a new one (I use phpmyadmin for this).

* The table you need to modify is mdl_course_modules and you need to add the following fields:
completedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '0'
completedscore VARCHAR(255) NOT NULL
completedstyle VARCHAR(255) NOT NULL
lockedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
lockedstyle VARCHAR(255) NOT NULL DEFAULT 'locked'
lockedvisible TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
delay INT(10) UNSIGNED NOT NULL DEFAULT '0'

* The table you need to create is as follows:
CREATE TABLE `mdl_course_locks` (
`id` int(10) unsigned NOT NULL auto_increment,
`courseid` int(10) unsigned NOT NULL default '0',
`locktype` varchar(10) NOT NULL default '',
`targetid` int(10) unsigned NOT NULL default '0',
`locks` longtext NOT NULL,
PRIMARY KEY (`id`)
) TYPE=MyISAM COMMENT='Contains locks for sections and modules';
* Lastly, you need to copy the following files from the zip file:
lib/moodlelib.php to moodle/lib/moodlelib.php
lib/locklib.php to moodle/lib/locklib.php
course/lib.php to moodle/course/lib.php
course/lock.php to moodle/course/lock.php
course/mod.php to moodle/course/mod.php
course/settings.html to moodle/course/settings.html
pix/t/open.gif to moodle/pix/t/open.gif
pix/t/closed.gif to moodle/pix/t/closed.gif
lang/en/lock.php to moodle/lang/en/lock.php

==AL Branch 2.2 for Moodle 1.6 (John Gschnaidner-Chardelle Busch and others)==
John's versionincludes the settings tab--making it possible to set the hide/visible options, as well as the completion (a checkmark in front of a resource/activity) options, says Chardelle.
* A variation on Stuart Mayor's 2.1, it hides topics dependent upon conditions set on specific activities/resources '''ALV2_1_debug.ZIP''' (John). Had bug which Benard tweaked out.
* A build of Stuarts Mayor's 2.1 it locks and/or hides specific activities depending upon conditions set on specific activities/resources. Was posted by Chardelle in [http://proemployees.com/ActivityLockingWithHide-1.6.zip '''ActivityLockingWithHide-1.6.zip''']. Probably same as above. Had bug which Benard tweaked out.
* A tweak by Bernard Boucher on June 27, 2006 was posted [http://moodle.org/mod/forum/discuss.php?d=35488&parent=222516 moodle/lib/locklib.php file] and called '''locklib.zip''' seems to fix known bug in both the above downloads.

==AL Branch 3.s for Moodle 1.6 (Stuart Meyor)==
Similar to the 2.x versions. Major difference is that a question to the student unlocks activities. Being actively developed and tested.

==CA Branch 1.0 for Moodle 1.5.2 (David Delgado)==
Details and discussed in the thread "NEW research on CONDITIONAL ACTIVITIES in Moodle"

= Table of Versions, to be completed... =
{| border="3" padding="4"
|+ Activity Locking updated 29 June 2006 10:00 AM EST
! -Version-
! Moodle version
! Who
! Status
! MySql Install
! Docs
! Comments
! Feature
! Feature
! Feature
! Feature
! Bug
! Bug
|-----
| AL 3.0
| 1.5.2
| Stuart Mayor
| not finished
|
|[http://moodle.org/mod/forum/discuss.php?d=46863]
|
| AL
| A/R dep on questions
|-----
| AL 2.3
| 1.6
| Stuart Mayor, Benard Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
|
| AL
| A/R/T dep on A/Rs
|-----
| AL 2.2
| 1.6
| Gschnaidner, Mayor, Busch, Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488#220946]
| almost
| AL
| A/R dep on A/Rs
| +Hide
|
| bug fix
|-----
| AL 2.1
| 1.6
| Stuart Mayor, Benard Boucher
| base
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
| see above
| AL
|-----
| C A 1.0
| 1.5.2
| David Delgado Borja Rubio Reyes
|
|
| [http://moodle.org/mod/forum/discuss.php?d=36697]
|
| AL
|}

=General installation instructions DRAFT=
Installing AL on a localhost (desktop) machine was not difficult! Some months ago I must have downloaded and connected phpAdministration and that came in handy for step 6. I just did a conversion and it took me less than 30 minutes (actually I think the AL part was done in 3 minutes ) because I wanted to install the latest version of Moodle 1.6 and then zipped my entire Moodle16 file structure before I attempted the AL installation.
*1. Perform any backups you think are necessary (I zipped everything in my localhost path).
*2. Select the zip file flavor of AL you want and download it (I used Chardelle's zip plus Bernards tweak found in 2.2 above)
*3. Unzip it to a non Moodle place. (Like to keep the folder structures option)
*4. Locate the MySQL.sql file so you can find it again.
*5. In Moodle as admin, go to Administration, Configuration and turn on Maintence Mode.
*6. Go to Administration, Database. In the home query window, on the left, click on moodle (mine says Moodle16 and has a bunch of mdl_ listings under it).
*7. Best: Click on the SQL tab. In the location of the text file, browse to the file in #4, then click go.
*7. Alternative: use the MySQL document and make or changes in
*8. Leave Moodle, shut that browser window.
*9. Now you need to move the files in the folders located in #3 to your Moodle file structure. (See my tip below). In your non moodle area you have unpack the file to a folder called ActivityLockingWithHide. It has a folder called Moodle in it, with sub folders under it, for example ActivityLockingWithHide\Moodle\Course. You should copy ever file from there to your local host file structure in the same spot. (Mine is Moodle16\Moodle\Course ).
*10. Go back into Moodle, log in as Admin, go to Administration. Moodle will adjust itself.
*11 Check in Administration, Configuration, Maintence to make sure it is disabled.
*12. You are done, check out a lesson with weeks or topics, go to lesson settings and notice the new tabs.
* TIP? There is probably a slicker way but after I unzipped the file in #3, I went down a level and zipped the Moodle folder. Then I unpacked the files to Moodle16\, told the unzip program to keep the folder structure and overwrite existing files.

=See Also=
*[[Adding_activity_locks]] will give the reader an idea of what one of the flavors of Activity Locking looks like for a student and teacher setting it up.

Please visit the Moodle Forum for more information concerning Activity Locking and Conditional Activities-

*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
* http://moodle.org/mod/forum/view.php?id=4295
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

There is a very specialized-limited type of activity locking under a lesson (activity) setting called dependency in 1.6. See: *https://docs.moodle.org/en/Adding/editing_a_lesson#Dependent_on .

Activity Locking

2006-07-02T05:18:36Z

Hatshepsut: /* AL Branch 2.1 for Moodle 1.6 (Stuart Meyor) */

=Overview=
This page is an attempt to consolidate and explain the available activity locking (AL) code that is present for Moodle 1.5.x and 1.6.x. This page will hopefully help explain all the available versions and their respective features. Some of the reference here will overlap with the existing MoodleDoc page covering [[Conditional activities]].

Please be patient as this page is new and under development. See page comments for reference material.

=Types of activity locking code=
For the purpose of this MoodleDoc article: AL is any code that allows the user to make decisions on the next available resource or item the student will be able to use based on student events or quiz performance. There is some activity locking code that is very quick and dirty to simply lock future activities and then there is much more complex code based on the conditional activity though structure which attempts to progress the student through the course in a thought out progression based on activities and performance. Again we hope to clarify some of this here.

==AL Branch 1.0 (Bernard Boucher)==
Bernard started all this with a hack to lock the certificate based on a quiz score in 2004. It was a great start!

== AL Branch 2.1 for Moodle 1.6 (Stuart Meyor)==
*This has been virtually a complete rewrite and as such there are areas of functionality the were available in older versions of AL that are not in this.

* Conditional locking: Lock based on a user's performance in previous activities. You can also choose to unlock and activity if a user scores less than a certain grade.
* Show activity completion: The checkbox that appears before each activity to show it have been done.
* A variation on this also hides future activities, see AL Branch 2.1 for Moodle 1.6 (John Gschnaidner-Chardelle Busch) below.
* Bernard Boucher reworked Stuart's version and on June 20, 2006 posted [http://206.167.134.155/bb/authoring1/activity_locking_v2_for_16_20060620.zip '''Activity_locking_v2_for_16_20060620.zip'''] on [http://moodle.org/mod/forum/user.php?id=1323&course=5 Activity Locking v3 or v2 for testing only]. The link is outside moodle.org and the link was not working on June 29, 2006.

===Installation for 2.1 for Moodle 1.6(Stuart Meyor)===
'''activitylocking20051201.zip''' the initial version

* Firstly, you need the stable build of Moodle 1.6. This version of AL might work on earlier releases but I didn't write it with them in mind and I certainly can't support them.
Next, you need to modify one table in the database and add a new one (I use phpmyadmin for this).

* The table you need to modify is mdl_course_modules and you need to add the following fields:
completedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '0'
completedscore VARCHAR(255) NOT NULL
completedstyle VARCHAR(255) NOT NULL
lockedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
lockedstyle VARCHAR(255) NOT NULL DEFAULT 'locked'
lockedvisible TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
delay INT(10) UNSIGNED NOT NULL DEFAULT '0'

* The table you need to create is as follows:
CREATE TABLE `mdl_course_locks` (
`id` int(10) unsigned NOT NULL auto_increment,
`courseid` int(10) unsigned NOT NULL default '0',
`locktype` varchar(10) NOT NULL default '',
`targetid` int(10) unsigned NOT NULL default '0',
`locks` longtext NOT NULL,
PRIMARY KEY (`id`)
) TYPE=MyISAM COMMENT='Contains locks for sections and modules';
* Lastly, you need to copy the following files from the zip file:
lib/moodlelib.php to moodle/lib/moodlelib.php
lib/locklib.php to moodle/lib/locklib.php
course/lib.php to moodle/course/lib.php
course/lock.php to moodle/course/lock.php
course/mod.php to moodle/course/mod.php
course/settings.html to moodle/course/settings.html
pix/t/open.gif to moodle/pix/t/open.gif
pix/t/closed.gif to moodle/pix/t/closed.gif
lang/en/lock.php to moodle/lang/en/lock.php

==AL Branch 2.2 for Moodle 1.6 (John Gschnaidner-Chardelle Busch and others)==
John's versionincludes the settings tab--making it possible to set the hide/visible options, as well as the completion (a checkmark in front of a resource/activity) options, says Chardelle.
* A variation on Stuart Mayor's 2.1, it hides topics dependent upon conditions set on specific activities/resources '''ALV2_1_debug.ZIP''' (John). Had bug which Benard tweaked out.
* A build of Stuarts Mayor's 2.1 it locks and/or hides specific activities depending upon conditions set on specific activities/resources. Was posted by Chardelle in [http://proemployees.com/ActivityLockingWithHide-1.6.zip '''ActivityLockingWithHide-1.6.zip''']. Probably same as above. Had bug which Benard tweaked out.
* A tweak by Bernard Boucher on June 27, 2006 was posted [http://moodle.org/mod/forum/discuss.php?d=35488&parent=222516 moodle/lib/locklib.php file] and called '''locklib.zip''' seems to fix known bug in both the above downloads.

==AL Branch 3.s for Moodle 1.6 (Stuart Mayor)==
Similar to the 2.x versions. Major difference is that a question to the student unlocks activities. Being actively developed and tested.

==CA Branch 1.0 for Moodle 1.5.2 (David Delgado)==
Details and discussed in the thread "NEW research on CONDITIONAL ACTIVITIES in Moodle"

= Table of Versions, to be completed... =
{| border="3" padding="4"
|+ Activity Locking updated 29 June 2006 10:00 AM EST
! -Version-
! Moodle version
! Who
! Status
! MySql Install
! Docs
! Comments
! Feature
! Feature
! Feature
! Feature
! Bug
! Bug
|-----
| AL 3.0
| 1.5.2
| Stuart Mayor
| not finished
|
|[http://moodle.org/mod/forum/discuss.php?d=46863]
|
| AL
| A/R dep on questions
|-----
| AL 2.3
| 1.6
| Stuart Mayor, Benard Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
|
| AL
| A/R/T dep on A/Rs
|-----
| AL 2.2
| 1.6
| Gschnaidner, Mayor, Busch, Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488#220946]
| almost
| AL
| A/R dep on A/Rs
| +Hide
|
| bug fix
|-----
| AL 2.1
| 1.6
| Stuart Mayor, Benard Boucher
| base
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
| see above
| AL
|-----
| C A 1.0
| 1.5.2
| David Delgado Borja Rubio Reyes
|
|
| [http://moodle.org/mod/forum/discuss.php?d=36697]
|
| AL
|}

=General installation instructions DRAFT=
Installing AL on a localhost (desktop) machine was not difficult! Some months ago I must have downloaded and connected phpAdministration and that came in handy for step 6. I just did a conversion and it took me less than 30 minutes (actually I think the AL part was done in 3 minutes ) because I wanted to install the latest version of Moodle 1.6 and then zipped my entire Moodle16 file structure before I attempted the AL installation.
*1. Perform any backups you think are necessary (I zipped everything in my localhost path).
*2. Select the zip file flavor of AL you want and download it (I used Chardelle's zip plus Bernards tweak found in 2.2 above)
*3. Unzip it to a non Moodle place. (Like to keep the folder structures option)
*4. Locate the MySQL.sql file so you can find it again.
*5. In Moodle as admin, go to Administration, Configuration and turn on Maintence Mode.
*6. Go to Administration, Database. In the home query window, on the left, click on moodle (mine says Moodle16 and has a bunch of mdl_ listings under it).
*7. Best: Click on the SQL tab. In the location of the text file, browse to the file in #4, then click go.
*7. Alternative: use the MySQL document and make or changes in
*8. Leave Moodle, shut that browser window.
*9. Now you need to move the files in the folders located in #3 to your Moodle file structure. (See my tip below). In your non moodle area you have unpack the file to a folder called ActivityLockingWithHide. It has a folder called Moodle in it, with sub folders under it, for example ActivityLockingWithHide\Moodle\Course. You should copy ever file from there to your local host file structure in the same spot. (Mine is Moodle16\Moodle\Course ).
*10. Go back into Moodle, log in as Admin, go to Administration. Moodle will adjust itself.
*11 Check in Administration, Configuration, Maintence to make sure it is disabled.
*12. You are done, check out a lesson with weeks or topics, go to lesson settings and notice the new tabs.
* TIP? There is probably a slicker way but after I unzipped the file in #3, I went down a level and zipped the Moodle folder. Then I unpacked the files to Moodle16\, told the unzip program to keep the folder structure and overwrite existing files.

=See Also=
*[[Adding_activity_locks]] will give the reader an idea of what one of the flavors of Activity Locking looks like for a student and teacher setting it up.

Please visit the Moodle Forum for more information concerning Activity Locking and Conditional Activities-

*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
* http://moodle.org/mod/forum/view.php?id=4295
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

There is a very specialized-limited type of activity locking under a lesson (activity) setting called dependency in 1.6. See: *https://docs.moodle.org/en/Adding/editing_a_lesson#Dependent_on .

Activity Locking

2006-07-02T05:17:59Z

Hatshepsut: /* AL Branch 2.1 for Moodle 1.6 (Stuart Mayor) */

=Overview=
This page is an attempt to consolidate and explain the available activity locking (AL) code that is present for Moodle 1.5.x and 1.6.x. This page will hopefully help explain all the available versions and their respective features. Some of the reference here will overlap with the existing MoodleDoc page covering [[Conditional activities]].

Please be patient as this page is new and under development. See page comments for reference material.

=Types of activity locking code=
For the purpose of this MoodleDoc article: AL is any code that allows the user to make decisions on the next available resource or item the student will be able to use based on student events or quiz performance. There is some activity locking code that is very quick and dirty to simply lock future activities and then there is much more complex code based on the conditional activity though structure which attempts to progress the student through the course in a thought out progression based on activities and performance. Again we hope to clarify some of this here.

==AL Branch 1.0 (Bernard Boucher)==
Bernard started all this with a hack to lock the certificate based on a quiz score in 2004. It was a great start!

== AL Branch 2.1 for Moodle 1.6 (Stuart Meyor)==
*This has been virtually a complete rewrite and as such there are areas of functionality the were available in older versions of AL that are not in this.

* Conditional locking: Lock based on a user's performance in previous activities. You can also choose to unlock and activity if a user scores less than a certain grade.
* Show activity completion: The checkbox that appears before each activity to show it have been done.
* A variation on this also hides future activities, see AL Branch 2.1 for Moodle 1.6 (John Gschnaidner-Chardelle Busch) below.
* Bernard Boucher reworked Stuart's version and on June 20, 2006 posted [http://206.167.134.155/bb/authoring1/activity_locking_v2_for_16_20060620.zip '''Activity_locking_v2_for_16_20060620.zip'''] on [http://moodle.org/mod/forum/user.php?id=1323&course=5 Activity Locking v3 or v2 for testing only]. The link is outside moodle.org and the link was not working on June 29, 2006. Bernard Boucher's version is not based on Stuart's version 3 anyway.--[[User:N Hansen|N Hansen]] 13:17, 2 July 2006 (WST)

===Installation for 2.1 for Moodle 1.6(Stuart Meyor)===
'''activitylocking20051201.zip''' the initial version

* Firstly, you need the stable build of Moodle 1.6. This version of AL might work on earlier releases but I didn't write it with them in mind and I certainly can't support them.
Next, you need to modify one table in the database and add a new one (I use phpmyadmin for this).

* The table you need to modify is mdl_course_modules and you need to add the following fields:
completedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '0'
completedscore VARCHAR(255) NOT NULL
completedstyle VARCHAR(255) NOT NULL
lockedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
lockedstyle VARCHAR(255) NOT NULL DEFAULT 'locked'
lockedvisible TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
delay INT(10) UNSIGNED NOT NULL DEFAULT '0'

* The table you need to create is as follows:
CREATE TABLE `mdl_course_locks` (
`id` int(10) unsigned NOT NULL auto_increment,
`courseid` int(10) unsigned NOT NULL default '0',
`locktype` varchar(10) NOT NULL default '',
`targetid` int(10) unsigned NOT NULL default '0',
`locks` longtext NOT NULL,
PRIMARY KEY (`id`)
) TYPE=MyISAM COMMENT='Contains locks for sections and modules';
* Lastly, you need to copy the following files from the zip file:
lib/moodlelib.php to moodle/lib/moodlelib.php
lib/locklib.php to moodle/lib/locklib.php
course/lib.php to moodle/course/lib.php
course/lock.php to moodle/course/lock.php
course/mod.php to moodle/course/mod.php
course/settings.html to moodle/course/settings.html
pix/t/open.gif to moodle/pix/t/open.gif
pix/t/closed.gif to moodle/pix/t/closed.gif
lang/en/lock.php to moodle/lang/en/lock.php

==AL Branch 2.2 for Moodle 1.6 (John Gschnaidner-Chardelle Busch and others)==
John's versionincludes the settings tab--making it possible to set the hide/visible options, as well as the completion (a checkmark in front of a resource/activity) options, says Chardelle.
* A variation on Stuart Mayor's 2.1, it hides topics dependent upon conditions set on specific activities/resources '''ALV2_1_debug.ZIP''' (John). Had bug which Benard tweaked out.
* A build of Stuarts Mayor's 2.1 it locks and/or hides specific activities depending upon conditions set on specific activities/resources. Was posted by Chardelle in [http://proemployees.com/ActivityLockingWithHide-1.6.zip '''ActivityLockingWithHide-1.6.zip''']. Probably same as above. Had bug which Benard tweaked out.
* A tweak by Bernard Boucher on June 27, 2006 was posted [http://moodle.org/mod/forum/discuss.php?d=35488&parent=222516 moodle/lib/locklib.php file] and called '''locklib.zip''' seems to fix known bug in both the above downloads.

==AL Branch 3.s for Moodle 1.6 (Stuart Mayor)==
Similar to the 2.x versions. Major difference is that a question to the student unlocks activities. Being actively developed and tested.

==CA Branch 1.0 for Moodle 1.5.2 (David Delgado)==
Details and discussed in the thread "NEW research on CONDITIONAL ACTIVITIES in Moodle"

= Table of Versions, to be completed... =
{| border="3" padding="4"
|+ Activity Locking updated 29 June 2006 10:00 AM EST
! -Version-
! Moodle version
! Who
! Status
! MySql Install
! Docs
! Comments
! Feature
! Feature
! Feature
! Feature
! Bug
! Bug
|-----
| AL 3.0
| 1.5.2
| Stuart Mayor
| not finished
|
|[http://moodle.org/mod/forum/discuss.php?d=46863]
|
| AL
| A/R dep on questions
|-----
| AL 2.3
| 1.6
| Stuart Mayor, Benard Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
|
| AL
| A/R/T dep on A/Rs
|-----
| AL 2.2
| 1.6
| Gschnaidner, Mayor, Busch, Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488#220946]
| almost
| AL
| A/R dep on A/Rs
| +Hide
|
| bug fix
|-----
| AL 2.1
| 1.6
| Stuart Mayor, Benard Boucher
| base
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
| see above
| AL
|-----
| C A 1.0
| 1.5.2
| David Delgado Borja Rubio Reyes
|
|
| [http://moodle.org/mod/forum/discuss.php?d=36697]
|
| AL
|}

=General installation instructions DRAFT=
Installing AL on a localhost (desktop) machine was not difficult! Some months ago I must have downloaded and connected phpAdministration and that came in handy for step 6. I just did a conversion and it took me less than 30 minutes (actually I think the AL part was done in 3 minutes ) because I wanted to install the latest version of Moodle 1.6 and then zipped my entire Moodle16 file structure before I attempted the AL installation.
*1. Perform any backups you think are necessary (I zipped everything in my localhost path).
*2. Select the zip file flavor of AL you want and download it (I used Chardelle's zip plus Bernards tweak found in 2.2 above)
*3. Unzip it to a non Moodle place. (Like to keep the folder structures option)
*4. Locate the MySQL.sql file so you can find it again.
*5. In Moodle as admin, go to Administration, Configuration and turn on Maintence Mode.
*6. Go to Administration, Database. In the home query window, on the left, click on moodle (mine says Moodle16 and has a bunch of mdl_ listings under it).
*7. Best: Click on the SQL tab. In the location of the text file, browse to the file in #4, then click go.
*7. Alternative: use the MySQL document and make or changes in
*8. Leave Moodle, shut that browser window.
*9. Now you need to move the files in the folders located in #3 to your Moodle file structure. (See my tip below). In your non moodle area you have unpack the file to a folder called ActivityLockingWithHide. It has a folder called Moodle in it, with sub folders under it, for example ActivityLockingWithHide\Moodle\Course. You should copy ever file from there to your local host file structure in the same spot. (Mine is Moodle16\Moodle\Course ).
*10. Go back into Moodle, log in as Admin, go to Administration. Moodle will adjust itself.
*11 Check in Administration, Configuration, Maintence to make sure it is disabled.
*12. You are done, check out a lesson with weeks or topics, go to lesson settings and notice the new tabs.
* TIP? There is probably a slicker way but after I unzipped the file in #3, I went down a level and zipped the Moodle folder. Then I unpacked the files to Moodle16\, told the unzip program to keep the folder structure and overwrite existing files.

=See Also=
*[[Adding_activity_locks]] will give the reader an idea of what one of the flavors of Activity Locking looks like for a student and teacher setting it up.

Please visit the Moodle Forum for more information concerning Activity Locking and Conditional Activities-

*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
* http://moodle.org/mod/forum/view.php?id=4295
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

There is a very specialized-limited type of activity locking under a lesson (activity) setting called dependency in 1.6. See: *https://docs.moodle.org/en/Adding/editing_a_lesson#Dependent_on .

Activity Locking

2006-07-02T05:17:44Z

Hatshepsut: /* Installation for 2.1 for Moodle 1.6(Stuart Mayor) */

=Overview=
This page is an attempt to consolidate and explain the available activity locking (AL) code that is present for Moodle 1.5.x and 1.6.x. This page will hopefully help explain all the available versions and their respective features. Some of the reference here will overlap with the existing MoodleDoc page covering [[Conditional activities]].

Please be patient as this page is new and under development. See page comments for reference material.

=Types of activity locking code=
For the purpose of this MoodleDoc article: AL is any code that allows the user to make decisions on the next available resource or item the student will be able to use based on student events or quiz performance. There is some activity locking code that is very quick and dirty to simply lock future activities and then there is much more complex code based on the conditional activity though structure which attempts to progress the student through the course in a thought out progression based on activities and performance. Again we hope to clarify some of this here.

==AL Branch 1.0 (Bernard Boucher)==
Bernard started all this with a hack to lock the certificate based on a quiz score in 2004. It was a great start!

== AL Branch 2.1 for Moodle 1.6 (Stuart Mayor)==
*This has been virtually a complete rewrite and as such there are areas of functionality the were available in older versions of AL that are not in this.

* Conditional locking: Lock based on a user's performance in previous activities. You can also choose to unlock and activity if a user scores less than a certain grade.
* Show activity completion: The checkbox that appears before each activity to show it have been done.
* A variation on this also hides future activities, see AL Branch 2.1 for Moodle 1.6 (John Gschnaidner-Chardelle Busch) below.
* Bernard Boucher reworked Stuart's version and on June 20, 2006 posted [http://206.167.134.155/bb/authoring1/activity_locking_v2_for_16_20060620.zip '''Activity_locking_v2_for_16_20060620.zip'''] on [http://moodle.org/mod/forum/user.php?id=1323&course=5 Activity Locking v3 or v2 for testing only]. The link is outside moodle.org and the link was not working on June 29, 2006. Bernard Boucher's version is not based on Stuart's version 3 anyway.--[[User:N Hansen|N Hansen]] 13:17, 2 July 2006 (WST)

===Installation for 2.1 for Moodle 1.6(Stuart Meyor)===
'''activitylocking20051201.zip''' the initial version

* Firstly, you need the stable build of Moodle 1.6. This version of AL might work on earlier releases but I didn't write it with them in mind and I certainly can't support them.
Next, you need to modify one table in the database and add a new one (I use phpmyadmin for this).

* The table you need to modify is mdl_course_modules and you need to add the following fields:
completedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '0'
completedscore VARCHAR(255) NOT NULL
completedstyle VARCHAR(255) NOT NULL
lockedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
lockedstyle VARCHAR(255) NOT NULL DEFAULT 'locked'
lockedvisible TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
delay INT(10) UNSIGNED NOT NULL DEFAULT '0'

* The table you need to create is as follows:
CREATE TABLE `mdl_course_locks` (
`id` int(10) unsigned NOT NULL auto_increment,
`courseid` int(10) unsigned NOT NULL default '0',
`locktype` varchar(10) NOT NULL default '',
`targetid` int(10) unsigned NOT NULL default '0',
`locks` longtext NOT NULL,
PRIMARY KEY (`id`)
) TYPE=MyISAM COMMENT='Contains locks for sections and modules';
* Lastly, you need to copy the following files from the zip file:
lib/moodlelib.php to moodle/lib/moodlelib.php
lib/locklib.php to moodle/lib/locklib.php
course/lib.php to moodle/course/lib.php
course/lock.php to moodle/course/lock.php
course/mod.php to moodle/course/mod.php
course/settings.html to moodle/course/settings.html
pix/t/open.gif to moodle/pix/t/open.gif
pix/t/closed.gif to moodle/pix/t/closed.gif
lang/en/lock.php to moodle/lang/en/lock.php

==AL Branch 2.2 for Moodle 1.6 (John Gschnaidner-Chardelle Busch and others)==
John's versionincludes the settings tab--making it possible to set the hide/visible options, as well as the completion (a checkmark in front of a resource/activity) options, says Chardelle.
* A variation on Stuart Mayor's 2.1, it hides topics dependent upon conditions set on specific activities/resources '''ALV2_1_debug.ZIP''' (John). Had bug which Benard tweaked out.
* A build of Stuarts Mayor's 2.1 it locks and/or hides specific activities depending upon conditions set on specific activities/resources. Was posted by Chardelle in [http://proemployees.com/ActivityLockingWithHide-1.6.zip '''ActivityLockingWithHide-1.6.zip''']. Probably same as above. Had bug which Benard tweaked out.
* A tweak by Bernard Boucher on June 27, 2006 was posted [http://moodle.org/mod/forum/discuss.php?d=35488&parent=222516 moodle/lib/locklib.php file] and called '''locklib.zip''' seems to fix known bug in both the above downloads.

==AL Branch 3.s for Moodle 1.6 (Stuart Mayor)==
Similar to the 2.x versions. Major difference is that a question to the student unlocks activities. Being actively developed and tested.

==CA Branch 1.0 for Moodle 1.5.2 (David Delgado)==
Details and discussed in the thread "NEW research on CONDITIONAL ACTIVITIES in Moodle"

= Table of Versions, to be completed... =
{| border="3" padding="4"
|+ Activity Locking updated 29 June 2006 10:00 AM EST
! -Version-
! Moodle version
! Who
! Status
! MySql Install
! Docs
! Comments
! Feature
! Feature
! Feature
! Feature
! Bug
! Bug
|-----
| AL 3.0
| 1.5.2
| Stuart Mayor
| not finished
|
|[http://moodle.org/mod/forum/discuss.php?d=46863]
|
| AL
| A/R dep on questions
|-----
| AL 2.3
| 1.6
| Stuart Mayor, Benard Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
|
| AL
| A/R/T dep on A/Rs
|-----
| AL 2.2
| 1.6
| Gschnaidner, Mayor, Busch, Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488#220946]
| almost
| AL
| A/R dep on A/Rs
| +Hide
|
| bug fix
|-----
| AL 2.1
| 1.6
| Stuart Mayor, Benard Boucher
| base
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
| see above
| AL
|-----
| C A 1.0
| 1.5.2
| David Delgado Borja Rubio Reyes
|
|
| [http://moodle.org/mod/forum/discuss.php?d=36697]
|
| AL
|}

=General installation instructions DRAFT=
Installing AL on a localhost (desktop) machine was not difficult! Some months ago I must have downloaded and connected phpAdministration and that came in handy for step 6. I just did a conversion and it took me less than 30 minutes (actually I think the AL part was done in 3 minutes ) because I wanted to install the latest version of Moodle 1.6 and then zipped my entire Moodle16 file structure before I attempted the AL installation.
*1. Perform any backups you think are necessary (I zipped everything in my localhost path).
*2. Select the zip file flavor of AL you want and download it (I used Chardelle's zip plus Bernards tweak found in 2.2 above)
*3. Unzip it to a non Moodle place. (Like to keep the folder structures option)
*4. Locate the MySQL.sql file so you can find it again.
*5. In Moodle as admin, go to Administration, Configuration and turn on Maintence Mode.
*6. Go to Administration, Database. In the home query window, on the left, click on moodle (mine says Moodle16 and has a bunch of mdl_ listings under it).
*7. Best: Click on the SQL tab. In the location of the text file, browse to the file in #4, then click go.
*7. Alternative: use the MySQL document and make or changes in
*8. Leave Moodle, shut that browser window.
*9. Now you need to move the files in the folders located in #3 to your Moodle file structure. (See my tip below). In your non moodle area you have unpack the file to a folder called ActivityLockingWithHide. It has a folder called Moodle in it, with sub folders under it, for example ActivityLockingWithHide\Moodle\Course. You should copy ever file from there to your local host file structure in the same spot. (Mine is Moodle16\Moodle\Course ).
*10. Go back into Moodle, log in as Admin, go to Administration. Moodle will adjust itself.
*11 Check in Administration, Configuration, Maintence to make sure it is disabled.
*12. You are done, check out a lesson with weeks or topics, go to lesson settings and notice the new tabs.
* TIP? There is probably a slicker way but after I unzipped the file in #3, I went down a level and zipped the Moodle folder. Then I unpacked the files to Moodle16\, told the unzip program to keep the folder structure and overwrite existing files.

=See Also=
*[[Adding_activity_locks]] will give the reader an idea of what one of the flavors of Activity Locking looks like for a student and teacher setting it up.

Please visit the Moodle Forum for more information concerning Activity Locking and Conditional Activities-

*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
* http://moodle.org/mod/forum/view.php?id=4295
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

There is a very specialized-limited type of activity locking under a lesson (activity) setting called dependency in 1.6. See: *https://docs.moodle.org/en/Adding/editing_a_lesson#Dependent_on .

Activity Locking

2006-07-02T05:17:27Z

Hatshepsut: /* AL Branch 2.1 for Moodle 1.6 (Stuart Mayor) */

=Overview=
This page is an attempt to consolidate and explain the available activity locking (AL) code that is present for Moodle 1.5.x and 1.6.x. This page will hopefully help explain all the available versions and their respective features. Some of the reference here will overlap with the existing MoodleDoc page covering [[Conditional activities]].

Please be patient as this page is new and under development. See page comments for reference material.

=Types of activity locking code=
For the purpose of this MoodleDoc article: AL is any code that allows the user to make decisions on the next available resource or item the student will be able to use based on student events or quiz performance. There is some activity locking code that is very quick and dirty to simply lock future activities and then there is much more complex code based on the conditional activity though structure which attempts to progress the student through the course in a thought out progression based on activities and performance. Again we hope to clarify some of this here.

==AL Branch 1.0 (Bernard Boucher)==
Bernard started all this with a hack to lock the certificate based on a quiz score in 2004. It was a great start!

== AL Branch 2.1 for Moodle 1.6 (Stuart Mayor)==
*This has been virtually a complete rewrite and as such there are areas of functionality the were available in older versions of AL that are not in this.

* Conditional locking: Lock based on a user's performance in previous activities. You can also choose to unlock and activity if a user scores less than a certain grade.
* Show activity completion: The checkbox that appears before each activity to show it have been done.
* A variation on this also hides future activities, see AL Branch 2.1 for Moodle 1.6 (John Gschnaidner-Chardelle Busch) below.
* Bernard Boucher reworked Stuart's version and on June 20, 2006 posted [http://206.167.134.155/bb/authoring1/activity_locking_v2_for_16_20060620.zip '''Activity_locking_v2_for_16_20060620.zip'''] on [http://moodle.org/mod/forum/user.php?id=1323&course=5 Activity Locking v3 or v2 for testing only]. The link is outside moodle.org and the link was not working on June 29, 2006. Bernard Boucher's version is not based on Stuart's version 3 anyway.--[[User:N Hansen|N Hansen]] 13:17, 2 July 2006 (WST)

===Installation for 2.1 for Moodle 1.6(Stuart Mayor)===
'''activitylocking20051201.zip''' the initial version

* Firstly, you need the stable build of Moodle 1.6. This version of AL might work on earlier releases but I didn't write it with them in mind and I certainly can't support them.
Next, you need to modify one table in the database and add a new one (I use phpmyadmin for this).

* The table you need to modify is mdl_course_modules and you need to add the following fields:
completedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '0'
completedscore VARCHAR(255) NOT NULL
completedstyle VARCHAR(255) NOT NULL
lockedbox TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
lockedstyle VARCHAR(255) NOT NULL DEFAULT 'locked'
lockedvisible TINYINT(1) UNSIGNED NOT NULL DEFAULT '1'
delay INT(10) UNSIGNED NOT NULL DEFAULT '0'

* The table you need to create is as follows:
CREATE TABLE `mdl_course_locks` (
`id` int(10) unsigned NOT NULL auto_increment,
`courseid` int(10) unsigned NOT NULL default '0',
`locktype` varchar(10) NOT NULL default '',
`targetid` int(10) unsigned NOT NULL default '0',
`locks` longtext NOT NULL,
PRIMARY KEY (`id`)
) TYPE=MyISAM COMMENT='Contains locks for sections and modules';
* Lastly, you need to copy the following files from the zip file:
lib/moodlelib.php to moodle/lib/moodlelib.php
lib/locklib.php to moodle/lib/locklib.php
course/lib.php to moodle/course/lib.php
course/lock.php to moodle/course/lock.php
course/mod.php to moodle/course/mod.php
course/settings.html to moodle/course/settings.html
pix/t/open.gif to moodle/pix/t/open.gif
pix/t/closed.gif to moodle/pix/t/closed.gif
lang/en/lock.php to moodle/lang/en/lock.php

==AL Branch 2.2 for Moodle 1.6 (John Gschnaidner-Chardelle Busch and others)==
John's versionincludes the settings tab--making it possible to set the hide/visible options, as well as the completion (a checkmark in front of a resource/activity) options, says Chardelle.
* A variation on Stuart Mayor's 2.1, it hides topics dependent upon conditions set on specific activities/resources '''ALV2_1_debug.ZIP''' (John). Had bug which Benard tweaked out.
* A build of Stuarts Mayor's 2.1 it locks and/or hides specific activities depending upon conditions set on specific activities/resources. Was posted by Chardelle in [http://proemployees.com/ActivityLockingWithHide-1.6.zip '''ActivityLockingWithHide-1.6.zip''']. Probably same as above. Had bug which Benard tweaked out.
* A tweak by Bernard Boucher on June 27, 2006 was posted [http://moodle.org/mod/forum/discuss.php?d=35488&parent=222516 moodle/lib/locklib.php file] and called '''locklib.zip''' seems to fix known bug in both the above downloads.

==AL Branch 3.s for Moodle 1.6 (Stuart Mayor)==
Similar to the 2.x versions. Major difference is that a question to the student unlocks activities. Being actively developed and tested.

==CA Branch 1.0 for Moodle 1.5.2 (David Delgado)==
Details and discussed in the thread "NEW research on CONDITIONAL ACTIVITIES in Moodle"

= Table of Versions, to be completed... =
{| border="3" padding="4"
|+ Activity Locking updated 29 June 2006 10:00 AM EST
! -Version-
! Moodle version
! Who
! Status
! MySql Install
! Docs
! Comments
! Feature
! Feature
! Feature
! Feature
! Bug
! Bug
|-----
| AL 3.0
| 1.5.2
| Stuart Mayor
| not finished
|
|[http://moodle.org/mod/forum/discuss.php?d=46863]
|
| AL
| A/R dep on questions
|-----
| AL 2.3
| 1.6
| Stuart Mayor, Benard Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
|
| AL
| A/R/T dep on A/Rs
|-----
| AL 2.2
| 1.6
| Gschnaidner, Mayor, Busch, Boucher
| Testing
|
| [http://moodle.org/mod/forum/discuss.php?d=35488#220946]
| almost
| AL
| A/R dep on A/Rs
| +Hide
|
| bug fix
|-----
| AL 2.1
| 1.6
| Stuart Mayor, Benard Boucher
| base
|
| [http://moodle.org/mod/forum/discuss.php?d=35488]
| see above
| AL
|-----
| C A 1.0
| 1.5.2
| David Delgado Borja Rubio Reyes
|
|
| [http://moodle.org/mod/forum/discuss.php?d=36697]
|
| AL
|}

=General installation instructions DRAFT=
Installing AL on a localhost (desktop) machine was not difficult! Some months ago I must have downloaded and connected phpAdministration and that came in handy for step 6. I just did a conversion and it took me less than 30 minutes (actually I think the AL part was done in 3 minutes ) because I wanted to install the latest version of Moodle 1.6 and then zipped my entire Moodle16 file structure before I attempted the AL installation.
*1. Perform any backups you think are necessary (I zipped everything in my localhost path).
*2. Select the zip file flavor of AL you want and download it (I used Chardelle's zip plus Bernards tweak found in 2.2 above)
*3. Unzip it to a non Moodle place. (Like to keep the folder structures option)
*4. Locate the MySQL.sql file so you can find it again.
*5. In Moodle as admin, go to Administration, Configuration and turn on Maintence Mode.
*6. Go to Administration, Database. In the home query window, on the left, click on moodle (mine says Moodle16 and has a bunch of mdl_ listings under it).
*7. Best: Click on the SQL tab. In the location of the text file, browse to the file in #4, then click go.
*7. Alternative: use the MySQL document and make or changes in
*8. Leave Moodle, shut that browser window.
*9. Now you need to move the files in the folders located in #3 to your Moodle file structure. (See my tip below). In your non moodle area you have unpack the file to a folder called ActivityLockingWithHide. It has a folder called Moodle in it, with sub folders under it, for example ActivityLockingWithHide\Moodle\Course. You should copy ever file from there to your local host file structure in the same spot. (Mine is Moodle16\Moodle\Course ).
*10. Go back into Moodle, log in as Admin, go to Administration. Moodle will adjust itself.
*11 Check in Administration, Configuration, Maintence to make sure it is disabled.
*12. You are done, check out a lesson with weeks or topics, go to lesson settings and notice the new tabs.
* TIP? There is probably a slicker way but after I unzipped the file in #3, I went down a level and zipped the Moodle folder. Then I unpacked the files to Moodle16\, told the unzip program to keep the folder structure and overwrite existing files.

=See Also=
*[[Adding_activity_locks]] will give the reader an idea of what one of the flavors of Activity Locking looks like for a student and teacher setting it up.

Please visit the Moodle Forum for more information concerning Activity Locking and Conditional Activities-

*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
* http://moodle.org/mod/forum/view.php?id=4295
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

There is a very specialized-limited type of activity locking under a lesson (activity) setting called dependency in 1.6. See: *https://docs.moodle.org/en/Adding/editing_a_lesson#Dependent_on .

Talk:Activity Locking

2006-07-01T20:38:15Z

Hatshepsut: /* Releases */

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayer. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

It would be helpful if when someone creates and lists a new version here they state what version their new version is based on.--[[User:N Hansen|N Hansen]] 04:38, 2 July 2006 (WST)

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]

'''AL v2.1(john)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006, based on the version of activity locking released by Stuart Meyor on October 19, 2005. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Johns Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them.[http://moodle.org/mod/forum/discuss.php?d=46863#220125 AL v2.1-M1.6]

'''AL v2.1 for 1.6(chardelle)''' - link posted by Chardelle on 25 June 2006, 03:35 PM. This flavor has a hide future activity function and seems to be functioning on some Moodles but is being tweaked for others. See forum discussion: [http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 Certificate 1.6 with Security discussion in Activity Module forum].The link for the external website is: [http://proemployees.com/ActivityLockingWithHide-1.6.zip AL v2.1 for 1.6(chardelle)].

[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Locking a topic is an all-or-nothing proposition. If you lock at topic, you cannot have individual conditions on locking of the items inside that topic. It would be nice if this were not the case.

Talk:Activity Locking

2006-07-01T20:36:59Z

Hatshepsut: /* Releases */ fixed bad links

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayer. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]

'''AL v2.1(john)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006, based on the version of activity locking released by Stuart Meyor on October 19, 2005. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Johns Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them.[http://moodle.org/mod/forum/discuss.php?d=46863#220125 AL v2.1-M1.6]

'''AL v2.1 for 1.6(chardelle)''' - link posted by Chardelle on 25 June 2006, 03:35 PM. This flavor has a hide future activity function and seems to be functioning on some Moodles but is being tweaked for others. See forum discussion: [http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 Certificate 1.6 with Security discussion in Activity Module forum].The link for the external website is: [http://proemployees.com/ActivityLockingWithHide-1.6.zip AL v2.1 for 1.6(chardelle)].

[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984 AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863 AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Locking a topic is an all-or-nothing proposition. If you lock at topic, you cannot have individual conditions on locking of the items inside that topic. It would be nice if this were not the case.

Talk:Activity Locking

2006-06-29T12:22:26Z

Hatshepsut: /* Future of Conditional Activities */

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayer. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(john)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006, based on the version of activity locking released by Stuart Meyor on October 19, 2005. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Johns Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them.[http://moodle.org/mod/forum/discuss.php?d=46863#220125: AL v2.1-M1.6]

'''AL v2.1 for 1.6(chardelle)''' - link posted by Chardelle on 25 June 2006, 03:35 PM. This flavor has a hide future activity function and seems to be functioning on some Moodles but is being tweaked for others. See forum discussion: [http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 Certificate 1.6 with Security discussion in Activity Module forum].The link for the external website is: [http://proemployees.com/ActivityLockingWithHide-1.6.zip AL v2.1 for 1.6(chardelle)].

[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Locking a topic is an all-or-nothing proposition. If you lock at topic, you cannot have individual conditions on locking of the items inside that topic. It would be nice if this were not the case.

Talk:Activity Locking

2006-06-29T11:34:26Z

Hatshepsut: /* Releases */ adding extra information and correct misstatement I made

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayer. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(john)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006, based on the version of activity locking released by Stuart Meyor on October 19, 2005. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Johns Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them.[http://moodle.org/mod/forum/discuss.php?d=46863#220125: AL v2.1-M1.6]

'''AL v2.1 for 1.6(chardelle)''' - link posted by Chardelle on 25 June 2006, 03:35 PM. This flavor has a hide future activity function and seems to be functioning on some Moodles but is being tweaked for others. See forum discussion: [http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 Certificate 1.6 with Security discussion in Activity Module forum].The link for the external website is: [http://proemployees.com/ActivityLockingWithHide-1.6.zip AL v2.1 for 1.6(chardelle)].

[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Developer notes

2006-06-27T18:40:30Z

Hatshepsut:

'''Note for contributors:''' This area is for developers to work on various bits of code and documentation as necessary. Once material has matured it should be linked to from the main [[Developer documentation]] page.
Initial text has been taken from [http://moodle.org/course/view.php?id=5 Using Moodle] Developer Wiki. If you find any text missing, please email docs AT moodle DOT org.

*[[Forum development|Forum functional upgrade]]
*[[Other lang issues|Language issues]]
*[[MoodleDocs development]]
*[[Datalib Notes]]
*[[Usability]]
*[[Blogs and forums|Blogs, forums and the nature of discussion]]
*[[Document Management API]]
*[[Filters schema]]
*[[Filterall support]]
*[[Application/session variables]]
*[[Wiki development|Wiki module development]]
*[[Conditional activities]]
*[[Roles]]
*[[Improved Payment Plugin]]

Talk:Activity Locking

2006-06-26T23:54:42Z

Hatshepsut: /* Releases */

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005
*[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayer. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(john)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Johns Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them. Does not allow you to lock entire topics. [http://moodle.org/mod/forum/discuss.php?d=46863#220125: AL v2.1-M1.6]

'''AL v2.1 for 1.6(chardelle)''' - link posted by Chardelle on 25 June 2006, 03:35 PM. This flavor has a hide future activity function and seems to be functioning on some Moodles but is being tweaked for others. See forum discussion: [http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 Certificate 1.6 with Security discussion in Activity Module forum].The link for the external website is: [http://proemployees.com/ActivityLockingWithHide-1.6.zip AL v2.1 for 1.6(chardelle)].

[http://moodle.org/mod/forum/discuss.php?d=47906&parent=221613 AL v2.1 wH1.6] titled Re: Certificate for 1.6 with security in Activity Modules forum

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Talk:Activity Locking

2006-06-25T12:21:44Z

Hatshepsut: /* Releases */

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayer. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(jon)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Jons Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them.[http://moodle.org/mod/forum/discuss.php?d=46863#220125: AL v2.1-M1.6]

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Talk:Activity Locking

2006-06-25T12:18:14Z

Hatshepsut:

==Purpose of page==
I think others have an idea, but some of us are confused about what is what. I am going through the condiditional activity forum to track what has been posted. I started with the summary of Alvin Shaffer - Wednesday, 21 June 2006, 08:18 AM as the outline. Comments placed here are out of context and were made by others in the forum threads listed below. I would like to see the link to the best versions 1.5.3 and 1.6 versions of AL placed on the article page.--[[User:chris collman 2|chris collman 2]] 19:13, 23 June 2006 (WST)

AL 3.0 is conditional based vs AL 2.1 being more straight forward AL based.
==Forum Threads==
These threads link to the Conditional Activity forum.
*[http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] titled Activity Locking v2.1 (for Moodle 1.6)
*[http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] titled Activity Locking v3
*[http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD] titled NEW research on CONDITIONAL ACTIVITIES in Moodle
*[http://moodle.org/mod/forum/discuss.php?d=31627&parent=152788: AL v2.1 LALR] titled Latest Activity Locking Release started 19 October 2005

==Releases==
There seem to be several flavors of AL. v1 and v2 seemed to be started by Stuart Mayer. Then Stuart and David Delgado worked independently on v3. There are v2 and v3 for 1.5 and for 1.6.

'''AL v2.1(stuart''') - released by Stuart on Dec. 1, 2005 - Not a lot of success by forum (not sure if this version is based on pure AL or conditionals)
*zip
*zip 1 December 2005, 10:28 AM activitylocking20051201.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(jon)'''- released by Jon on June 1, 2006 - Modified 2.1 with hides for ver 1.6. Non Block installed based AL , must hack database , etc. Not sure a list of feature differences to V2.1(stuart)
*zip 12 May 2006, 09:02 AM ActivityLockingV2.1Moodle1.6.7z [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
*zip 15 May 2006, 02:23 AM AL2_1_debug.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]
**Tweak 23 June 2006, 01:45 AM lock.php [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6]

'''AL v2.1(benard)''' - released by Bernard on June 21st, 2006. A hack of the Block installer based AL (2.1). So far in testing this version seams to work in 1.6, just not sure what features from Jons Hack are not included (as Chardelle alluded to). Locking seems to work, but setting activity prerequisites to "no" still shows them.

'''AL v3.0(stuart)''' - Modified files to try to hack AL ver 3.0 for 1.6 released by Chardelle on June 15th, 2006 - (Stuart released Ver 3.0 AL for 1.5.X code) not a working version due to the quiz module changes and other issues (hopefully stuart is working on a 1.6 version)
*zip 29 April 2006, 11:42 AM activitylocking_1.6_beta3.zip [http://moodle.org/mod/forum/discuss.php?d=35488#220984: AL v2.1-M1.6] (posted Eduardo)
*zip 14 June 2006, 01:18 PM al_ver3_for16.ZIP [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted Chardelle)
**tweak 6 June 2006, 02:55 AM mysql.sql [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)
*zip 1 June 2006, 04:16 AM ActivityLockingWithHide.7z [http://moodle.org/mod/forum/discuss.php?d=46863: AL v3.0-Mx] (posted John G)

'''AL v3.0(david)''' - David Delgado's group
*zip 9 February 2006, 09:09 AM moodle-1.5.2.zip (for Windows) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip 9 February 2006, 09:09 moodle-1.5.2.tgz (for Linux and Unix) [http://moodle.org/mod/forum/discuss.php?d=36697 AL v3.0-DD]
*zip SOURCE CODE.

==Future of Conditional Activities==

Let's use this to brainstorm additional features of conditional activities we would like to see as well.--[[User:N Hansen|N Hansen]] 20:18, 25 June 2006 (WST)

One feature that is missing is related to choice module. Making a lock dependent on a choice module instance only makes it so that the student has to view the choice, not actually make a choice. It seems that answering the choice should be required.

Talk:Activity Locking

2006-06-25T12:15:23Z

Hatshepsut: /* Releases */

UTF-8 contrib

2006-06-22T13:32:02Z

Hatshepsut: /* Contrib modules which don't contain migration scripts */

[[UTF-8 migration]] > Contrib

==How to make your contrib module work for the UTF-8 migration process==

The UTF-8 migration script traverse Moodle modules same way as the module upgrade process.

For the purpose of making Moodle totally UTF-8, every field of type (varchar, text, enum) will need to be converted to UTF-8.

To do this, you need to put 2 files in the db folder, where the mysql.sql and postgres.sql files are.

*''migrate2utf8.xml'' defines what fields to be converted. Every field needs a type and a length, and if applicable, index information (see below). There are 3 methods associated with each field:

#-NO_CONV is for those fields that could only contain English Chars, written by Moodle.
#-PLAIN_SQL_UPDATE is used when you can find both the user language and course language for that record using 1 SQL conveniently. If you use this method you must include both sqls for the user lang and the course lang.
#-PHP_FUNCTION is used when the detection of userlang or courselang is more difficult, or more sophisticated methods are needed for the conversion (e.g. serialized objects, or when you need to append _utf8 to a lang field etc)

*''migrate2utf8.php'' defines each php function included to do the conversion.

Please look at ''forum/db'' for the exact formats of these files.

All indexes need to be dropped prior to (or at the same time) the processing this field. This can be done using dropindex or dropprimary. After the field is processed, you need to add the indexes back using addindex, adduniqueindex, or addprimary. If you don't have enough fields in the table to do addindex or dropindex, you can add arbitrary number of dummy fields (see ''scorm/db/migrate2utf8.xlm'')

To test the migration, please don't forget to turn debug on.

==Contrib modules which don't contain migration scripts==

Flashcard

''Please list names of other modules here...''

==Manually converting a table to UTF-8==

If you have extra tables that contain text in '''English''' or '''UTF encoding''' from Moodle 1.5,
and you want to convert them manually to be used under 1.6, you can do it using PhpMyAdmin (or direct SQL) here is a procedure: ('''Please make a backup first''')

1. For every textual field in the table, (i.e. varchar, char, text, longtext, enum etc), you need to change the column encoding to UTF8.

Before you can change the column encoding to UTF8, you have to make sure that this column is not associated with any index. If it is, you need to drop the index(es), and add them back later, so please remember what the index is before proceeding.

The SQL to drop an index is

ALTER TABLE 'tablename' DROP INDEX 'indexname';

Example,

'''ALTER TABLE mdl_forum_posts DROP INDEX forum_posts_subject_idx;'''

The SQLs to change column encoding to UTF8 is

ALTER TABLE 'tablename' CHANGE 'fieldname' 'fieldname' LONGBLOB;

ALTER TABLE 'tablename' CHANGE 'fieldname' 'fieldname' original_type CHARACTER SET utf8 NOT NULL DEFAULT defaultvalue;

Example,

'''ALTER TABLE mdl_forum_posts CHANGE subject subject LONGBLOB;

ALTER TABLE mdl_forum_posts CHANGE subject subject varchar(255) CHARACTER SET utf8 NOT NULL DEFAULT '';'''

Then, if applicable, you need to add the index back.

ALTER TABLE ADD INDEX 'indexname' 'indexvar';

Example,

'''ALTER TABLE mdl_forum_posts ADD INDEX forum_posts_subject_idx(subject(255));'''

2. After all columns have been converted to UTF8 encoding, you can change the table encoding to UTF8.

ALTER TABLE 'tablename' CHARACTER SET utf8;

Example,

'''ALTER TABLE mdl_forum_posts CHARACTER SET utf8;'''

3. And you are done!

[[Category:UTF-8|Contrib]]

Roles

2006-06-12T11:54:04Z

Hatshepsut: /* Teacher */

Roles

2006-06-12T11:43:50Z

Hatshepsut: /* Capabilities */

Roles

2006-05-16T11:29:24Z

Hatshepsut: /* Capabilities */

Roles

2006-05-16T11:27:15Z

Hatshepsut: /* Scenarios */

Roles

2006-05-16T01:17:07Z

Hatshepsut: /* Former Student */

Roles

2006-05-16T01:12:14Z

Hatshepsut: added former student role

Latest release notes

2006-05-10T13:08:00Z

Hatshepsut: /* New features */

{{About Moodle}}

==Moodle 1.6 (Coming soon, currently in Beta testing status)==

===New features===

* [[UTF-8 migration|Unicode]]
::Moodle is now 100% Unicode, which means any language can be mixed together and an end to a number of problems that different character sets caused us.
* [[MoodleDocs development|Documentation]]
::A new one-stop wiki site for ALL Moodle documentation, including links from Moodle itself
* [[Database module]]
::A new activity module that allows collaborative collection of structured data, useful for many things!
* [[LAMS]]
::Integrated via a course format and an activity module
* [[Blogs]]
::Allows reflection on an ongoing basis. Entries are marked and can be viewed by user, course, group, site etc. Contains first new support for [[Tags]].
* [[Reports]]
::All reports are now centralised under Course reports and Admin reports. New reports can be written as plugins and dropped in very easily. One big new report is the new course-based statistics system from Catalyst.
* [[Questions]]
::A centralized bank of questions with the potential to be (re-)used in a variety of modules.
* [[My Moodle]]
::A dashboard interface that allows an overview for each user of all their courses etc.
* [[Hive integration]]
::This initial integration with Hive allows teachers to upload, browse, search and select [[Resources|resources]] within the external repository.
* [[Multiple groups]]
::Users can be part of multiple groups within a course
* [[IMS content package]] resource type
::Supports the loading of any content package as a resource, plus special support for a repository of NLN materials
* [[Course backup|Granularised backup]]
* [[Chameleon|Chameleon theme]]
:: An interactive Moodle theme
* [[Enrolment plugins|Multi enrolment]]
::Moodle's enrolment plugins can be used simultaneously on the same site. Also new [[IMS Enterprise]] enrolment plugin.

'''See also'''
*[[Special:Whatlinkshere/Template:Moodle_1.6|List of pages including Moodle 1.6 features]]

==Moodle 1.5.4 (very soon)==

(Because this release contains important security fixes, we highly advise that sites using any previous version of Moodle upgrade to this version as soon as possible.)

===A few new things===

* EDIT ME!

===Various fixes===

'''General'''

* Various updates/improvements in the the Environmental Check allowing to check if your server suits future Moodle requirements.
* Bug 4619. Fixed one DB query not following coding rules.
* Bug 4607. Avoid duplication of course shortname on restore.
* Fixed one problem with auto-link filters and frames.
* Important fixes to muti-byte text handling routines.
* Small changes to the installer.
* Bug 3853. Some important improvements in the restore of log actions.
* Bug 4328. Prevent some warnings in the blocks system.
* Bug 4341. Extending multi-lang support to the "jumpto" menu (showed in collapsed mode).

'''Enrolment and metacourses'''
* Authorize.net: Postgres support was added.
* Authorize.net: Address Verification System (AVS) support was added.
* Authorize.net: $CGF->login_https must be ON for payment pages.
* Authorize.net: Shows two forms if the enrolment key of the course is set. (internal & authorize forms)
* Authorize.net: IIS https fix. It doesn't recognize empty($_SERVER['HTTPS']), but accepts HTTPS=off.

'''Forum Module'''

* Bug 4355. Solved one visualisation problem in the page showing the list of forums.

'''Glossary Module'''

* Bug 4543, 4713. Fixed some problems with entries and categories containing more than one word in their title.
* Bug 4858. Fixed one problem with formats, not being detected properly.
* Bug 4915. Entrylist format now displays the "Send Ratings" button.

'''Quiz Module'''

* Fixed bug 4250: Added missing percentages to the grade selector
* Fixed bug 4495: Don't apply lateness check when teacher previews
* Fixed bug 4544: Incorrect path to exported files in some language packs
* Fixed bug 4780: Bug in "Prevent late submissions" setting fixed
* Fixed bug 5070: Students can't see quizzes when they are closed
* Turned off regrading of quizzes that have the attemptonlast option set
* A number of other minor interface fixes

'''Resource Module'''

* Solved one problem on restore that was causing some links to become corrupted.
* Slightly changes to the delete_instance() function in resources to allow future improvements.

'''Wiki Module'''

* Solved one problem sending double-slashed info to DB.
* Bug 3830. Load of initial content from course file area is now allowed.

==Moodle 1.5.3 (11th November, 2005)==

(Because this release contains important security fixes, we highly advise that sites using any previous version of Moodle upgrade to this version as soon as possible.)

===A few new things===

* We now have SCORM 1.3 (SCORM 2004) support!
* Much improved Assignment grading interface, including "quick grading" options
* A new Single-Sign-On API is available

===Various fixes===

'''General'''

* Contains warnings when Moodle is used on an PHP configuration known to be insecure
* Contains fixes for some recently reported security problems (see [http://security.moodle.org/ security.moodle.org])
* Backups now runs a lot faster medium/large installs. Many issues fixed in this area
* Listing of directory sizes can be made much faster on Linux/Unix servers, thanks to a performance fix you can enable from Admin->Variables: "path_to_du"
* We now log more meaningful IP addresses when the server or the clients are working behind a proxy
* Fixed some issues with PHP accelerators
* Upgrade scripts have been refined and work much better for PostgreSQL installations
* General PostgreSQL port code cleanup
* Upgrading to 1.5.3 will fix any legacy Journal to Online Assignment upgrade issues
* RSS libraries now support RSS 2.0 categories, see bug 3654
* Better accesibilty in file uploads, see bug 3662
* Better support for site-wide HTTPS, see bug 3848
* We now send away bots (like Googlebot) from that try mangled URLs, see bug 3958
* Better DST support for non-logged-in users
* Better DST support for repeat events in Calendar
* Small fixes to the lesson, choice and grade modules
* Minor CSS improvements to formal_white and orangewhite themes
* Better pagination in course listing and loglive pages
* Fixed an IE-only bug related to HTMLArea content where user-edited tables could float and hide part of the UI.

'''Authentication'''

* Fixes to change password/forgotten password with external auth
* Data fetched from external DB or LDAP is now truncated correctly
* Fixed bug 4305 -- better login block behaviour when using secureforms
* Better support for utf-8 user data from external auth
* LDAP: General fixes covering sync_users script and logging of errors
* LDAP: Fixed bug 3141 - Can't update external data with LDAP authentication
* LDAP: Fixed bug 3992 - LDAP password including a quote does not work - credits go to Kita
* LDAP: Better support for ActiveDirectory.
* LDAP: Fixed bug #3594
* LDAP: Better handling of multi-source field mapping
* LDAP: Fix for using DN as idnumber - thanks fo Jeff Graham - http://moodle.org/mod/forum/discuss.php?d=28840

'''Enrolment and metacourses'''

* Metacourses: Prevent normal users to gain access to meta courses via manual enrolment
* Metacourses: better support for MySQL v3.23.x
* DB: Enrolment lookups now work reliably with Moodle on MySQL and Postgres
* DB: Non-MySQL databases work again as external enrolment databases
* LDAP: Fixed a wrong call to add_teacher in LDAP plugin.
* LDAP: Servers being down or unavailable no longer prevent logins
* LDAP: Course auto-creation works again
* LDAP: Fixed several bugs reported by Jeff Graham and Barron Koralesky -- including bugs 3912 and 3974
* LDAP: We can now bind non-anonymously to LDAP
* Authorize.net: several fixes

'''Resources'''

* Bugfix: Avoid linking to empty or unlinkable activity names

'''Forums'''

* Big and small optimizations to tracking of read/unread messages, specially for PostgreSQL
* Fixed some PostgreSQL bugs
* Some more actions are now supported by backup/restore when processing log records, see bug 3582
* Now message forum RSS feeds are including category data -- useful under some RSS agregators able to group messages, see bug 3654
* Fixed paging on forum search

'''Blocks'''

* Several performance improvements
* Fixes to the upgrade process, including PostgreSQL syntax and lower memory usage
* Brought in several bugfixes from 1.6dev
* Fixed bug 3478: Cannot add RSS feed as course creator
* Fixed bug 3793: Prevent warning message when configuring a glossary_random block in a course which has no glossaries

'''Quiz'''

* Some CSS style fixes
* Better compatibility with themes that contain forms in the headers
* Highlighting of correct answers can now be turned off
* Fixed bug 3986: Too many random questions. (mindforge)
* Fixed missing action icons
* Fixed bug 3899 and removed some 'missing course object' messages
* Fixed bug 3950: Ee-attempt button inconsistency for multi-attempt quizzes
* Fixed bug 3953: Quiz/report.php pagesize can be set to 0, credits to Jean-Michel
* Fixed potential data data corruption bug 3915
* Fixed bug 3884: Quiz correct highlights missing for 2 of 3 options.
* Fix for the Student review highlight doesn't seem to work bug
* Fixed bug 3804: Differences in question types between 1.5 and 1.6
* Fixed bug 3822: don't count previews as attempts
* Fixed bug 3807: Question numbering issue
* Fixes for the item analysis plug-in, assembled by Jean-Michel
* Now we reset the timeout counter to avoid timeouts
* Several improvements contributed by Jean-Michel Vedrine. You can now change the number of attempts per page displayed on screen, and download results to Excel/text file, including detailed grades
* Fixed export bug with non-English languages

'''SCORM'''

* We now support SCORM 1.3 (SCORM 2004)!
* Fixed a bug with next and prev SCO search
* Fixed bugs related to masteryscore
* Fixed a problem in AICC course tracking

'''Wiki'''

* Now paging of older versions is showed and working properly, see bug 3750

'''Filters'''

* Mediaplugin filter now finds multi-line links in HTML code
* Censor filter: Added original word as title to the blacked-out version. The filter can obscure actual important words by mistake (eg Dickens) and there needs to be some way to recover the meaning

==Moodle 1.5.2 (16th July, 2005) ==

=== Various fixes ===

* Journal -> Assignment upgrade now works properly :-/
* Assignment submodules now upgrade as expected
* Various other bugs with new Assignments fixed
* Journal module is now disabled by default on new installations
* Login page is now 100% HTTPS if required
* Various small standard theme tweaks
* Fix for recent matching questions display bug in Quiz
* Language editor no longer creates empty files when not necessary (caused country list bug)
* Fixed some manifest parsing problems in SCORM module
* Multilang filter now deals with pack names that contain numbers
* Files are now force-downloaded (fixes IE problems and some security issues)
* Relinking debugging output is escaped
* Large MP3 player now displays ID3 tags properly again
* Some chat daemon improvements

=== Some new things ===

* Orangewhite theme optimised for use on PDA
* Forum user posts page can be called without userid
* Altavista BabelFish now allowed in as guest when Google is

==Moodle 1.5.1 (8th July, 2005) ==

===Various fixes===

* Several potential security problems solved
* Allowobjectembed setting now works correctly
* Speed problem on IE, caused by tab hover fixed.
* Cut and paste in editor on Firefox has a more helpful warning message
* Fixed a session problem when logged on as admin during upgrade from very old Moodle version
* Fixed editing problem in Main menu of site
* Minor CSS display problems in a few areas were fixed
* Fixed the adding of a single discussion forum
* Fixed Lesson problems with calculating grades, and dates
* Fixed Lesson problems with entering a cluster after a page
* Censor filter was fixed to make it work better with old themes

===Some new things===

* New theme: Wood
* Metal theme updated for 1.5
* Many language updates for most languages, including a new language: Khmer
* Block classes can now run custom code when an instance is created/deleted (this is useful for blocks that need to set up non-trivial data structures)
* Wizard for Calculated Questions in Quiz was rewritten
* Backup/Restore module selection is now improved and much easier
* Backup/Restore module has much improved relinking support, it's now faster and easier to implement in new modules

==Moodle 1.5 (5th June, 2005) ==

Here you can find the release notes of the current stable version of Moodle. '''If you experience any bugs in this release, please report them at [http://moodle.org/bugs moodle.org/bugs] so we can fix them in the next release.'''

=== Headline features ===

* Web pages are compliant with XHTML Transitional 1.0
* Improved '''Accessibility''', aiming for compliance with WAI (W3C), SENDA (UK) and Section 508 (US) criteria.
* Very strong '''new Themes system''', allowing cascading themes, user themes, course themes, with very fine control of every page in Moodle via CSS.
* Integrated '''Messaging''' feature for direct communication between all users in the site, featuring realtime popup windows, notification, email copies, blocking, history, WYSIWYG editor, etc
* Forum read/unread tracking with highlights allows you to see new postings at a glance and to control how these are displayed (per forum, per user or per site).
* New '''Blocks''' system, allowing multiple copies of blocks and better block configuration
* Full support for '''Daylight Savings Time''' in every locality around the globe, so everyone always see the correct local time for all events.
* New '''extended gradebook''' allowing custom weighting of different activities, setting extra grades (or taking out others) and improved display and sorting options
* Users can be required to agree to a '''Site Policy
'''

=== Other major system-wide improvements ===

'''Admin'''

* New "maintenance mode" allows the admin to temporarily disable a site (during upgrades, for example).
* Moodle can automatically download a new list of timezones from moodle.org or elsewhere and install it to the database (Olson files are supported too)
* New version of Moodle MySQL Admin module (available separately)
* New calendar options page provides user interface to configure the behavior of the calendar

'''Authentication'''

* New Shibboleth Support
* New CAS Support
* New PAM Support
* Improved LDAP integration, so that LDAP can now control course creation, group assignments. Increased performance and scalability performing user synchronisation.
* Certain user fields can be locked by the admin when using external authentication
* Improved session handling now detects "crossover" sessions that we have found in some buggy PHP installations and prevents them
* Sessions can now be stored in the database (good for clustered installations!)
* Users can be forced to change their password

'''Files'''

* Standardised file browsing in all areas
* Improved uploading, with support for automated Virus scanning of new documents using ClamAV.
* Slasharguments now work also on IIS (upgrade to PHP 4.3.11 needed for ISAPI)

'''Filters'''

* Standardised filter library makes it trivial to write new filters that require searching and highlighting of text.
* Huge efficiency improvements for complex filters like the Glossary filter
* New Tidy filter uses the W3C Tidy program to (optionally) clean all user-entered texts throughout the site and convert it to valid XHTML code
* Improved censorship filter, now "blacks out" words using styles and uses a word list from the language packs.
* Improved Flash MP3 player, now shows progress bar while downloading and playing
* Improved Multi-language filter is faster, more forgiving of syntax errors, and uses new editor-friendly syntax: 
* Auto-linking filters (glossary, activities) can work to link all the occurrences (old behaviour), once for each text block or only once for the whole page ($CFG->filtermatchonepertext, $CFG->filtermatchoneperpage).
* More text can now be filtered in Moodle, including activity names, headings and other such small texts. This makes it possible to design completely multi-lingual sites in Moodle that fully appears in the user's chosen language.

'''Themes'''

* Modules can provide standard styles
* Themes can override required styles of other themes
* Users and courses can choose their own themes if the admin allows it
* Implementation of tabs interface on many pages
* Modules, Blocks and Languages can define their own standard styles

'''HTML Editor'''

* The toolbuttons offered in the editor toolbar are now configurable by the admin
* Search and Replace text within the editor text area (with optional use of regular expressions)

'''Course management'''

* Transparent Blackboard 5.5 course importing (partial 6.0 support)
* The new meta-courses allow to get users automatically enroled in a general course (the metacourse) when enroled in any of the metacourse-linked courses
* New tool to copy content from a course to other.

'''New blocks'''

* HTML block: allowing to place arbitrary content (text, images links) in any course mainpage
* Remote RSS feed: allows to display external news channels inside a Moodle course
* Glossary Selection: to choose and display content from a Moodle glossary in course mainpage

'''Calendar'''

* Major speed improvements for sites with a large number of courses using groups
* Repeating events can now be modified or deleted all at the same time or separately as before
* New "remember filter settings" preference that allows calendar filters to remember their status between logins

=== Activity module improvements ===

'''Assignment'''

* Completely refactored into a new class-based design, allowing new plugin-assignment types
* New Online Text assignment type that doesn't require files and allows inline comments when grading - this new type effectively replaces the old Journal module
* Vastly improved grading interface for handling large classes
* New configuration options to disable late submission and to e-mail alerts to teachers when students submit new work

'''Chat'''

* Streamlined interface looks smoother, works faster, even without using the optional server daemon
* Blocks can now be added to chat pages (e.g. for additional information)

'''Choice'''

* Rewritten to allow any number of choices
* The number of users per choice can be limited, which allows it to be used as tool for "signing up" to an array of options.
* You can now download the results of the choice to XLS or a TXT file

'''Forum'''

* Powerful new Google-like forum searching tools
* Forum read/unread tracking - unread messages are highlighted on the course page, forum page, discussion listing and the discussion view
* The tracking system may be disabled by teachers/users
* User profiles show all posts by a user, as well as all discussions
* When admins edit user messages, a notice is attached
* Discussion listing shows the last user who posted to each discussion and when it was, with a direct link to that post
* In group-enabled forums the discussion listing shows the group the thread applies to, with a link to the group description page.

'''Glossary'''

* New setting to enable/disable the print view of each glossary.
* New search system looks for words everywhere (instead of doing exact phrase match).
* More information is sent to logs to be able to track activity better.

'''Journal'''

* The Journal module has not changed since 1.4, and is now deprecated. The upgrade procedure will convert all your Journal activities into Online Assignments, and hide all the old Journal activities. If you don't want this to happen, then define this in your config.php: $CFG->noconvertjournals = true;

'''Lesson'''

* Now supports timed Lessons
* Can create practice Lessons (grades are not stored)
* Option for students to view points earned while taking the Lesson
* Allow students to review their answers before submitting the Lesson
* New Slide Show Mode (only branch tables are displayed as slides)
* New Left Menu (for enabled branch tables only)
* Lessons can now be Password Protected
* A Tree View can be used for the Lesson creation screen
* Students can post their high scores
* New option to save a Lesson's settings as defaults for new lessons in the same course
* Can delete a student's attempts
* New page Jumps:
** Previous Page
** Unseen question within a branch
** Random question within a branch
** Unseen question within a cluster
* Added functionality to view Lesson statistics
* New question type: Essay. Teachers can view each essay and write comments, assign a grade, and then email it all to the student
* New question creation interface

'''Quiz'''

* Can handle adaptive questions, i.e., questions that allow the student to interact with them repeatedly within the same quiz attempt and that can change in response to student answers.
* Student can be allowed to try a question again immediately within the same quiz attempt until they get the answer right.
* There is a penalty mechanism that deducts a specified fraction of the mark for each wrong attempt at a question.
* Allows questions rendered and scored externally (e.g., by mathematical assessment engines) to be integrated seamlessly into Moodle quizzes via the RQP web services protocol.
* Is prepared for the handling of IMS QTI questions once web services for these become available.
* New tabbed teacher interface for previewing, editing, and reviewing quizzes.
* New "improved security" mode shows quiz in a separate full-screen window, with many browser features disabled
* Quizzes can be presented to students in several pages. The number of questions per page is selectable by the teacher.
* Blocks can now be added to quiz pages (to show results table, or additional information etc)
* Better and cleaner interface for question selection and management in the database. Selected questions can be added to quiz, moved to other categories or deleted en mass.
* Random questions are now added to the quiz question list with a dedicated button, leaving a cleaner interface at questions database without phantom placeholders
* Final grade can be a fractional number, with teacher-defined decimal figures
* Improved results page with user-selectable display of columns, cleaner sorting and new mark display options
* Questions can be edited with one click from the improved quiz preview and question preview screens.
* Questions can be copied with one click, to allow question variations to be created with ease.
* Revamped question categories structures and editing interface.
* Categories now can contain nested subcategories and can be re-ordered.
* It is possible to select whether questions from categories, and or their subcategories are displayed on the question edit page.
* It is now possible to select whether to add random questions from a parent category alone, or from a parent category and its sub-categories.
* Quiz creators are prevented from changing the question set of quizes that have had student responses.
* Recognition, and rejection, of overlapping/redundant questions has been improved.
* The display of questions in longer quiz categories on the quiz editing page is now paginated.
* New export types - IMS QTI (2.0) and xhtml. Improvements & fixes to others.
* New import type - Hot Potato. Improvements & fixes to others.

'''Scorm'''

* The module is now fully conformant with the SCORM 1.2 standard.
* User result data storage and reporting was improved.
* AICC packages can now be imported.

'''Survey'''

* Graph formatting has been improved (labels are more readable)

'''Wiki'''

* Changes to wiki pages are now monitored and displayed in Recent Activity block
* Several under the hood improvements to backup/restore and other routines that enhance the reliability of wikis

== See also ==

*[[Old releases|1.4.5 release notes]]

[[Category:Core]]
[[Category:Administrator]]

[[es:Notas de versiones]]
[[fr:Notes de mise à jour]]

Developer documentation

2006-04-22T23:53:54Z

Hatshepsut: /* How you can contribute */

==Guidelines==
The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:
*[[Coding|Coding guidelines]] have to be followed by all Moodle developers
*[[Moodle architecture]] spells out the basic design goals behind Moodle
*[[Interface guidelines]] aim to provide a common feel to the Moodle user interface
*[[CVS (developer)|Moodle CVS for developers]] explains how to work with the Moodle code in CVS

== Resources and tools ==

*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle
*[http://moodle.org/bugs/ Moodle bug tracker] - bug reports, feature requests and other tracked issues
*[http://moodle.org/mod/forum/view.php?id=55 General developer forum]
*[http://cvs.sourceforge.net/viewcvs.py/moodle/moodle/ CVS code] - browse the Moodle code via the web
*[http://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code
*[http://moodle.sourceforge.net/dhawes-phpdoc/ Moodle PHP doc reference] - automatically generated documentation
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD

==How you can contribute==

The M in Moodle stands for 'Modular'. There are many different types of components that you can contribute that can be plugged into Moodle to provide additional functionality. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. The following types of plugins currently exist (in alphabetical order):
*[[Modules (developer)|Activity modules]]
*[[Assignment types]]
*[[Authentication|Authentication methods]]
*[[Blocks Howto|Blocks]]
*[[Course formats]]
*[[Database fields]]
*[[Database presets]]
*[[Enrolment plugins]]
*[[Filters (developer)|Filters]]
*[[Question import/export formats]]
*[[Question types]]
*[[Quiz reports]]
*[[Resource types]]
*[[SSO plugins]]

There are also ways you can contribute that don't involve PHP programming:
*[[Themes]]
*[[Translation|Translations]]
*[[Database Schemas|Database schemas]]

You can also help a lot by
*[[Tests|Testing]]
*[[Bug tracker|Participating in the bug tracker]]

==Plans for the future==
Ideas for and details of planned future features of Moodle are initially discussed on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course at moodle.org. That developer discussions are intermixed with user discussions in the same forums may seem strange at first but is one of the reasons for the success of Moodle. It is important that both end-users and developers discuss the future features together.

Once ideas begin to crystalize on the forums they can be summarized in this wiki, either as part of the [[Roadmap]] or in the form of [[Developer notes]]. These pages then form the basis for further discussion in the forums.
*[[Roadmap]]
*[[Developer notes]]
*[[Student projects]]
*[[Developer conference|Developer conferences]]

==Documentation for core components==
This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the [[Developer notes]] or on the [[Roadmap]].

*[[UTF-8 migration|Migration to UTF-8]]
*[[Question engine]]
*[[Quiz developer docs|Quiz module]]
*[[SCORM schema|SCORM module 1.5 schema]]
*[[Authentication API]]
*[[Stats package]]
*[[Email processing]]
*[[Cookieless Sessions]]

==Documentation for contributed code==
Many Moodle users contribute code for the benefit of other Moodle users. This can take the form of new activity modules, blocks, themes, resource plug-ins, assignment plug-ins, question type plug-ins, question import/export formats, quiz report plug-ins, course formats, ... This code is initially posted on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course and then often go into the [http://cvs.sourceforge.net/viewcvs.py/moodle/contrib/ contrib area] of the Moodle [[CVS]] repository. When you have developed a new component please publish it in the [http://moodle.org/mod/data/view.php?id=6009 database of Moodle modules and plugins]. Developer documentation for these components should be listed here.

==See also==
*[http://security.moodle.org/ Moodle Security Centre]
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services

[[es:Documentación para Desarrolladores]]

User:N Hansen

2006-02-18T14:51:17Z

Hatshepsut:

Teaching hieroglyphs online at Glyphdoctors[http://www.glyphdoctors.com]

User:N Hansen

2006-02-18T14:50:53Z

Hatshepsut:

Teaching hieroglyphs online at [http://whww.glyphdoctors.com]

Developer documentation

2006-01-29T03:34:03Z

Hatshepsut: /* See also */

*[[Developer notes]]
*[[Coding|Coding guidelines]]
*[[CVS|Moodle CVS for developers]]
*[[Moodle architecture]]

===Documentation for specific modules===

*[[Quiz developer docs|Quiz module]]
*[[SCORM schema|SCORM module 1.5 schema]]

===How you can contribute===

Even if you are not a programmer there are things you can change or help with.
*[[Activity modules]]
*[[Themes]]
*[[Translation]]
*[[Database Schemas|Database schemas]]
*[[Course formats]]
*[[Bug tracker|Participating in the bug tracker]]

== See also ==

*[http://moodle.org/blocks/HOWTO.html A step-by-step guide to creating blocks]
*[http://moodle.org/bugs/ Moodle bug tracker] - bug reports, feature requests and other tracked issues
*[http://cvs.sourceforge.net/viewcvs.py/moodle/moodle/ CVS code]
*[http://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code
*[http://moodle.org/mod/resource/view.php?id=1267 Core API]
*[http://moodle.sourceforge.net/dhawes-phpdoc/ Moodle PHP doc reference]
*[http://security.moodle.org/ Moodle Security Centre]
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services

[[Category:Core]]

User:Hatshepsut

2006-01-29T03:11:26Z

Hatshepsut:

Teaching Egyptian hieroglyphs online at http://www.glyphdoctors.com