|
|
| (220 intermediate revisions by 60 users not shown) |
| Line 1: |
Line 1: |
| <p class="note">'''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>[[New page name]]</nowiki></code>.</p>
| | #redirect [[Main Page]] |
| | |
| ==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
| |
| *[[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
| |
| *[[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://moodle.org/xref/nav.html?index.html Cross reference] - phpxref output for browsing Moodle source code
| |
| *[http://phpdocs.moodle.org/ Moodle PHP doc reference] - automatically generated documentation
| |
| *[[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
| |
| | |
| ==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]]
| |
| *[[Admin reports|Admin reports]]
| |
| *[[Assignment types]]
| |
| *[[Authentication|Authentication methods]]
| |
| *[[Blocks Howto|Blocks]]
| |
| *[[Course formats]]
| |
| *[[Database fields (developer)|Database fields]]
| |
| *[[Database presets]]
| |
| *[[Enrolment plugins (developer)|Enrolment plugins]]
| |
| *[[Filters|Filters]]
| |
| *[[Question_engine]]
| |
| *[[Question import/export formats]]
| |
| *[[Question bank|Question bank teacher docs]]
| |
| *[[Question_engine#Question_types|Question types developper docs]]
| |
| *[[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]].
| |
| | |
| *[[Migration to Role-driven model|Migration to Role-driven model]] @ v[[1.7]]
| |
| *[[UTF-8 migration|Migration to UTF-8]] @ v[[:Category:Moodle 1.6|1.6]]
| |
| *[[Question engine]]
| |
| *[[Quiz developer docs|Quiz module]]
| |
| *[[SCORM schema|SCORM module 1.5 schema]]
| |
| *[[Authentication API]]
| |
| *[[Stats package]]
| |
| *[[Email processing]]
| |
| *[[Cookieless Sessions]]
| |
| *[[lib/formslib.php|Formslib]] for quickly writing code to display and process more accessible and secure forms.
| |
| | |
| ==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]]
| |
| [[fr:Documentation développeur]]
| |
| [[zh:开发者文档]] | |
