Difference between revisions of "Developer documentation"

Jump to: navigation, search
(Guidelines)
(Documentation for core components)
Line 18: Line 18:
 
Speaking in English E-Learning Course
 
Speaking in English E-Learning Course
  
==Documentation for core components==
+
== Speaking in English E-Learning Course ==
  
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|developer notes]] or on the [[Roadmap|roadmap]].
+
Speaking in English E-Learning Course
 
 
The documents below give a general overview. For detailed function-by-function documentation, see the [http://phpdocs.moodle.org/ phpDocumentor] documentation that is automatically generated from the comments in the code.
 
 
 
And don't forget that the most up-to-date and detailed description of how the code works is the code itself, and you can [http://xref.moodle.org/nav.html?index.html browse the code online] using [[PHPXref|PHPXref]].
 
 
 
===Core components ===
 
 
 
*[[XMLDB_Documentation|Database abstraction layer]] @ v[[1.7]]
 
*[[Roles|Roles and Capabilities system]] @ v[[1.7]] for controlling who can do what
 
*[[lib/formslib.php|Forms library]] @ v[[1.8]] for creating accessible and secure HTML forms that let users edit things
 
*[[Using_the_file_API|File API]] @ v[[2.0]] for managing files stored by Moodle
 
*[[Database schema introduction|The database schema]]
 
*[[What happens when you require config.php|What happens when you require config.php]]
 
*[[lib/moodlelib.php|lib/moodlelib.php]]
 
*[[lib/weblib.php|lib/weblib.php]] for outputting stuff
 
 
 
===Core libraries with a more specific uses===
 
 
 
*[[Authentication API]]
 
*[[Cookieless Sessions]]
 
*[[Email processing]]
 
*[[Environment checking|Environment checking]] before install, check the user's server to ensure Moodle will work there.
 
*[[Groups|Groups system]]
 
*[[Grades|Gradebook]]
 
*[[Moodle Network|Moodle Network]]
 
*[[Question engine]]
 
*[[Stats package]]
 
*[[UTF-8 migration|Migration to UTF-8]] @ v[[:Category:Moodle 1.6|1.6]]
 
*[http://developer.yahoo.com/yui YUI JavaScript library] - YUI was selected as the official AJAX library for Moodle.
 
*[[lib/graphlib|lib/graphlib]]
 
*[[Admin settings|Admin settings]]
 
 
 
===Modules included in the standard distribution===
 
 
 
*[[Lesson Specification|Lesson Specification]]
 
*[[Quiz developer docs|Quiz module]]
 
*[[SCORM schema|SCORM module 1.5 schema]]
 
  
 
==How you can contribute==
 
==How you can contribute==

Revision as of 21:21, 26 April 2011

moodle-development-logo.jpg

This Developer section of Moodle Docs is aimed at developers who contribute to the Moodle code, plugins, themes, and so on.


Note: New developer documentation pages should be added to the Development namespace by typing

Development:
before the new page name i.e.
[[New page name]]
. If you are a developer, you probably want to change your preferences to include the Development namespace in searches.

A page may be added to the Developer category by adding the template
{{CategoryDeveloper}}
to the bottom of the page. - If required, you can use
[[Category:Sort key]]
to provide a sort key other than the default page name.

Speaking in English E-Learning Course

Speaking in English E-Learning Course

Speaking in English E-Learning Course

Speaking in English E-Learning Course

Speaking in English E-Learning Course

Speaking in English E-Learning Course

How you can contribute

Make a new plugin

The M in Moodle stands for modular, and the easiest, most maintainable way to add new functionality to Moodle is by using one of the many plugin APIs. There are many types of plugin you can write:

General information that applies to all types of plugins

Please see the Guidelines for contributed code for an overview of how to contribute to the Moodle code.

Sometimes it is not possible to write a proper plugin for what you want to do, in which case you may have to resort to using the local customisations hook.

Change core code

Some types of change can only be made by editing the core Moodle code. Such changes are much harder to maintain than plugins. If you want your core change to be considered for inclusion in the official Moodle release, you need to create an issue in the tracker, and attach your change as a patch. It is also a good idea to discuss your ideas in the forums first. See Overview#Major_Development for more details.

Ways to contribute that do not involve PHP programming

Plans for the future

Ideas for and details of planned future features of Moodle are initially discussed on the forums in the 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 crystallize 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.

Resources

Tools

Some tools people use when working on Moodle code:

IDEs

Browser add-ons

Miscellaneous

See also: Useful Development Tools forumin the Introduction to Moodle Programming course

See also