MoodleDocs - User contributions [en]

cmc/jobs

2007-07-11T18:18:15Z

Bmiller264:

The message processing page will show the current state of all messages being sent between your Student Information System (SIS) and Moodle.

The processes that can be scheduled are:

'''Terms'''
This process will get the current term definitions from your SIS system. Only terms that are selected as integrating to LMS will be selected.

'''Teachers'''
This process will synchronize all teacher accounts from your SIS to Moodle. The teacher's must have valid and unique e-mail addresses. The teachers will be added as user's in Moodle.

'''Class Sections'''
This process will get all classes in your SIS that are defined as LMS classes. The LMS provider must be selected and the extract status set to 'R' (Ready).

'''Process Class Sections'''
This process will add the messages received in the prior process to the list of classes available for linking to Moodle courses.

'''Registrations'''
This process will get all registration messages for students that have registered into a class that is designated as an LMS class. New registrations as well as changes to existing registrations will be added to the Moodle system.

'''Process Registrations'''
This process will go through the registration messages that have been received. The process will either enroll a student into an associated course (once the class is linked to a course) or for updates (drops, un-register, etc.) the student will be taken out of the Moodle course. During this process, if this is the first registration - the student information will also be added to the Moodle system as a user, and, if an Orientation Course is configured, the first time student will be added to the Orientation course as well.

'''Post Attendance'''
Activity in the Moodle system will be sent to the SIS to be posted as attendance. All activity in a course will be summed and multiplied by the value configured in the setup. Attendance is summarized by day.

cmc/jobs

2007-07-11T18:17:18Z

Bmiller264:

The message processing page will show the current state of all messages being sent between your Student Information System (SIS) and Moodle.

The processes that can be scheduled are:

'''Bold text'''Terms'''Bold text'''
This process will get the current term definitions from your SIS system. Only terms that are selected as integrating to LMS will be selected.

'''Bold text'''Teachers'''Bold text'''
This process will synchronize all teacher accounts from your SIS to Moodle. The teacher's must have valid and unique e-mail addresses. The teachers will be added as user's in Moodle.

'''Bold text'''Class Sections'''Bold text'''
This process will get all classes in your SIS that are defined as LMS classes. The LMS provider must be selected and the extract status set to 'R' (Ready).

'''Bold text'''Process Class Sections'''Bold text'''
This process will add the messages received in the prior process to the list of classes available for linking to Moodle courses.

'''Bold text'''Registrations'''Bold text'''
This process will get all registration messages for students that have registered into a class that is designated as an LMS class. New registrations as well as changes to existing registrations will be added to the Moodle system.

'''Bold text'''Process Registrations'''Bold text'''
This process will go through the registration messages that have been received. The process will either enroll a student into an associated course (once the class is linked to a course) or for updates (drops, un-register, etc.) the student will be taken out of the Moodle course. During this process, if this is the first registration - the student information will also be added to the Moodle system as a user, and, if an Orientation Course is configured, the first time student will be added to the Orientation course as well.

'''Bold text'''Post Attendance'''Bold text'''
Activity in the Moodle system will be sent to the SIS to be posted as attendance. All activity in a course will be summed and multiplied by the value configured in the setup. Attendance is summarized by day.

cmc/userlinking

2007-07-11T18:06:55Z

Bmiller264:

This page shows the user's that have been synchronized to Moodle user accounts. The user lists are separated by Student's and Teacher's.

Select the list to view. When displayed, the lists will show the information from your Student Information System and the information in Moodle to which the user is linked.

cmc/siteconfig

2007-06-08T22:47:41Z

Bmiller264:

Site configuration for integration.

Specify the web service locations to be used by this integration. The service locations are referring to the installed web services at your school site.

== Login Options ==
Select one or both of the login options for students. Allowing the student to directly access the LMS site will result in an e-mail being sent to the student when their user account is created in Moodle.

== Attendance Mode: ==

'''Simple''' - select this option if all that is needed is to record any course activity as 1 hour of attendance for the day. Recording the 1 hour will update the LDA and indicate that the student is still active in the course. The 1 hour will be recorded at 11:00pm for the day that the activity occurred. This option will keep the attendance folder "clean" - only one entry per day.

'''Full''' - select this option if you need to see each instance of an activity in a course. This option will record the exact minute that the activity occurred. 1 minute of attendance will be recorded for the event (as we really don't know how long the student kept the page open). This will result in a lot of information to view in the attendance folder.

cmc/siteconfig

2007-06-08T22:46:10Z

Bmiller264:

Site configuration for integration.

Specify the web service locations to be used by this integration. The service locations are referring to the installed web services at your school site.

Attendance Mode:

Simple - select this option if all that is needed is to record any course activity as 1 hour of attendance for the day. Recording the 1 hour will update the LDA and indicate that the student is still active in the course. The 1 hour will be recorded at 11:00pm for the day that the activity occurred. This option will keep the attendance folder "clean" - only one entry per day.

Full - select this option if you need to see each instance of an activity in a course. This option will record the exact minute that the activity occurred. 1 minute of attendance will be recorded for the event (as we really don't know how long the student kept the page open). This will result in a lot of information to view in the attendance folder.

cmc/index

2007-05-18T20:48:26Z

Bmiller264:

This page shows the current state of the integration.

Possible states are:

'''Installed, not configured''' - this indicates that the integration source module has been installed, but the service locations and database has not yet been configured.

'''Configured, not in use''' - this indicates that the integration source module has been installed, the database changes have been applied and the service locations may have also been set.

'''Operational, no students yet''' - this indicates that the integration source module has been installed, the database changes have been applied, the web service locations are set correctly and configuration data is being received by this site.

'''Fully Configured and In Use''' - Congratulations! You have a fully operational site. Configuration data is being received and students are successfully being enrolled into courses.

Links are provided for actions appropriate to the current state of the integration.

cmc/linktocampus

2007-05-18T20:46:23Z

Bmiller264: cmc link class to course

Use this page to link the Moodle courses to class sections where you are identified as the instructor. Once linked, students registered into the class sections will begin to be automatically added to the Moodle course that is linked to the class section.

cmc/index

2007-05-18T20:42:58Z

Bmiller264: cmc module

cmc/siteconfig

2007-05-18T20:36:54Z

Bmiller264: cmc site configuration

Site configuration for integration.

Specify the web service locations to be used by this integration. The service locations are referring to the installed web services at your school site.

Development:Developer documentation

2007-05-07T01:08:36Z

Bmiller264:

'''Note:''' New developer documentation pages should be added to the ''Development namespace'' by typing <code>Development:</code> before the new page name i.e. <code><nowiki>[[Development:New page name]]</nowiki></code>. If you are a developer, you probably want to change your [[Special:Preferences|preferences]] to include the Development namespace in searches.

==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 design goals]] 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
*[[Unit tests]] explains how to run the unit tests, and how to write new test cases.
*[[Tracker]] explains the Moodle Tracker for keeping track of bugs, issues, feature requests etc
*[[Development:Working with the Community|Working with the Community]] explains how to engage with the dev community and discuss changes

== Resources and tools ==

*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle
*[http://tracker.moodle.org/ Moodle tracker] - bug reports, feature requests and other tracked issues
*[http://moodle.org/mod/forum/view.php?id=55 General developer forum]
*[http://moodle.cvs.sourceforge.net/moodle/moodle/ CVS code] - browse the Moodle code via the web
*[http://xref.moodle.org/index.html Cross reference] - phpxref output for browsing Moodle source code
*[http://phpdocs.moodle.org/ Moodle PHP doc reference] - automatically generated documentation
*[[Development:Database Schema|Database Schema]] - for recent releases
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course
*[http://developer.yahoo.com/yui YUI documentation] - YUI is the official AJAX library in moodle.
*[[Setting up Eclipse for Moodle development]] - Eclipse is a great editor to use for php development, if you can work out how to set it up.
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD
*[[Firefox tracker search]] - How to setup a firefox quicksearch to easily navigate to moodle bugs
*[[Development:ctags|Ctags]] - Using a tags file to navigate code

==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]]
*[[Development:Admin reports|Admin reports]]
*[[Assignment types]]
*[[Authentication|Authentication methods]]
*[[Development:Blocks|Blocks]]
*[[Course formats]]
*[[Database fields (developer)|Database fields]]
*[[Database presets]]
*[[Enrolment plugins (developer)|Enrolment plugins]]
*[[Development:Filters|Filters]]
*[[Development:Question engine|Question engine]]
*[[Development:Question import/export formats|Question import/export formats]]
*[[Quiz reports]]
*[[Resource types]]
*[[SSO plugins]]

There are also ways you can contribute that don't involve PHP programming:
*[[Themes]]
*[[Translation]]
*[[Database Schemas|Database schemas]]

You can also help a lot by
*[[Tests|Testing]]
*[[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]].

===Core components that affect everything===

* lib/moodlelib.php
* lib/weblib.php for outputting stuff.
*[[Development:XMLDB_Documentation|Database abstraction layer]] @ v[[1.7]]
*[[Development:Roles|Roles and Capabilities system]] @ v[[1.7]] for controlling who can do what.
*[[Development:lib/formslib.php|Forms library]] @ v[[1.8]] for creating accessible and secure HTML forms that let users edit things.

===Core libraries with a more specific uses===

*[[Authentication API]]
*[[Cookieless Sessions]]
*[[Development:Moodle Network|Moodle Network]]
*[[Email processing]]
*[[Development:Environment checking|Environment checking]] before install, check the user's server to ensure Moodle will work there.
*[[Question engine]]
*[[Stats package]]
*[[UTF-8 migration|Migration to UTF-8]] @ v[[:Category:Moodle 1.6|1.6]]

===Modules included in the standard distribution===

*[[Quiz developer docs|Quiz module]]
*[[SCORM schema|SCORM module 1.5 schema]]

==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 goes into the [http://moodle.cvs.sourceforge.net/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

[[Category:Developer]]
[[es:Documentación para Desarrolladores]]
[[fr:Documentation développeur]]
[[zh:开发者文档]]
[[ja:開発者ドキュメント]]

User:Bob Miller

2007-05-05T12:00:58Z

Bmiller264:

http://www.runawaygeeks.com/public/bmiller/pics/2002/img_0668x.jpg 
Bob Miller Software Architect [http://www.campusmanagement.com Campus Management Corporation]

Development:Code Cross-Reference

2007-05-05T07:48:11Z

Bmiller264:

There used to be a code cross-reference at http://xref.moodle.org (generated from the Moodle source code using [http://phpxref.sourceforge.net/ PPHPXref])

Unfortunately it can no longer be maintained on that server. If you create a replacement site please link to it from this page.

To have xref.moodle.org pointed to your site, please contact Martin Dougiamas via the http://moodle.com/helpdesk

'''Access the Moodle 1.8''' Code [http://72.15.209.135/index.html cross-reference here]

Development:Code Cross-Reference

2007-05-05T07:46:16Z

Bmiller264: Add link to moodle docs hosted at Campus Management's CampusNet site

There used to be a code cross-reference at http://xref.moodle.org (generated from the Moodle source code using [http://phpxref.sourceforge.net/ PPHPXref])

Unfortunately it can no longer be maintained on that server. If you create a replacement site please link to it from this page.

To have xref.moodle.org pointed to your site, please contact Martin Dougiamas via the http://moodle.com/helpdesk

Access the Moodle 1.8 Code [http://72.15.209.135/index.html cross-reference here]