MoodleDocs - User contributions [en]

Development:Developer documentation

2008-09-08T11:19:24Z

Raimondo:

'''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. A page may be added to the Developer category by typing <code><nowiki>[[Category:Developer|New page name]]</nowiki></code> at the bottom of the page.

==How Moodle development works==

This [[Development:Overview|overview of the Moodle development process]] may be handy in understanding how the development of Moodle occurs and how people become Moodle developers.

==Guidelines==

The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:
*[[Development: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
*[[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
*[[Development:Unit tests|Unit tests]] explains how to run the unit tests, and how to write new test cases.
*[[Development:Fast portable SQL]] shows SQL techniques that are fast, efficient, and known to work on all supported DBs.

==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 [[Development:Developer notes|developer notes]] or on the [[Roadmap|roadmap]].

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]. Moodle code should be easy to read and understand. Use the source, Luke!

===Core components that affect everything===

*[[Development:Database schema introduction|The database schema]]
*lib/moodlelib.php
*[[Development:lib/weblib.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]]
*[[Email processing]]
*[[Development:Environment checking|Environment checking]] before install, check the user's server to ensure Moodle will work there.
*[[Development:Groups|Groups system]]
*[[Development:Grades|Gradebook]]
*[[Development: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.
*[[Development:lib/graphlib|lib/graphlib]]

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

*[[Development:Lesson Specification|Lesson Specification]]
*[[Quiz developer docs|Quiz module]]
*[[SCORM schema|SCORM module 1.5 schema]]

==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:
*[[Development:Modules|Activity modules]]
*[[Development:Admin reports|Admin reports]]
*[[Development:Assignment types|Assignment types]]
*[[Development:Authentication plugins|Authentication plugins]]
*[[Development:Blocks|Blocks]]
*[[Course formats]]
*[[Development:Course Report Plugins|Course reports]]
*[[Development:Database fields|Database fields]]
*[[Development:Database presets|Database presets]]
*[[Development:Enrolment plugins|Enrolment plugins]]
*[[Development:Filters|Filters]]
*[[Development:Gradebook plugins|Gradebook plugins]]
**[[Development:Gradebook_Report_Tutorial|Gradebook report]]
**[[Development:Gradebook export|Gradebook export]]
**[[Development:Gradebook import|Gradebook import]]
*[[Development:Question engine|Question engine]]
*[[Development:Question import/export formats|Question import/export formats]]
*[[Development:How to write a quiz report plugin|Quiz reports]]
*[[Development:Resource types|Resource types]]
*[[Development:SSO plugins|SSO plugins]]
*[[Development:Search engine adapters|Search engine adapters]]

General information that applies to all types of plugins
*[[Development:Places to search for lang strings|Where to put language strings for your plugin]]
*[[Development:Installing and upgrading plugin database tables|Defining the database tables for your plugin]]

Please see the [[Development:Guidelines for contributed code|Guidelines for contributed code]] for an overview of how to contribute to the Moodle code.

===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|tracker]], and attach your change as a [[Development:How_to_create_a_patch|patch]]. It is also a good idea to discuss your ideas in the forums first. See [[Development:Overview#Major_Development]] for more details.

===Ways to contribute that do not involve PHP programming===

*[[Themes|Create Moodle themes]]
*[[Translation|Translate Moodle into other languages]]
*[[MoodleDocs:Guidelines for contributors|Help document Moodle]]
*[[Development:Database schemas|Database schemas]]
*[[Development:Tests|Join the testing effort]], which involves [[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 crystallize on the forums they can be summarized in this wiki, either as part of the [[Roadmap|roadmap]] or in the form of [[Development:Developer notes|developer notes]]. These pages then form the basis for further discussion in the forums.

*[[Roadmap]]
*[[Development:Developer notes|Developer notes]]
*[[Student projects]]
*[[Developer conferences]]

== Resources and tools ==

*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle
*[[Development:Finding_your_way_into_the_Moodle_code|Finding your way into the Moodle code]] - also aimed at newcomers
*[http://tracker.moodle.org/ Moodle tracker] - bug reports, feature requests and other tracked issues
**[[Firefox tracker search]] - How to setup a firefox quicksearch to easily navigate to moodle bugs
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD
*Browse the code online:
**[http://cvs.moodle.org/moodle/ the code with a complete change history from CVS]
**[http://xref.moodle.org/index.html the code, with links generated by PHPXref]
*[http://phpdocs.moodle.org/ Moodle PHP doc reference] - compiled from the comment attached to each class and function in the code
*[[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
**especially the [http://moodle.org/mod/forum/view.php?id=55 General developer forum]
**[[Filters used on the Moodle.org forums|cool tricks you can use in the moodle.org forums]]
*Some tools people use when working on Moodle code:
**[[Development:Setting_up_Eclipse|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.
**[[Development:vim|Setting up Vim for Moodle development]]
**[[Development:Setting_up_Netbeans|Setting up Netbeans for Moodle development]] - Netbeans Early Acces for PHP is a great out-of-the-box editor.
**[[Development:ctags|Ctags]] - Using a tags file to navigate code
**[[W3C_validation|W3C HTML validator]] - Moodle has built in support to make using it easier.
**Firebug plugin for Firefox.
*[[Development:Windows Installer|Windows Installer]] - Windows Installer documentation for developer.

==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]]
[[pt:Desenvolvimento:Documentação para programadores]]
[[zh:开发者文档]]
[[ja:開発者ドキュメント]]
[[fi:Ohjelmoijan opas]]

Administrator documentation

2008-09-08T11:11:33Z

Raimondo:

The purpose of this page is to list useful links by general topics for administrators.

== Installation & Upgrading ==

*[[Installation Quickstart]] for an overview of the installation steps
*[[Installing Moodle]] for detailed installation instructions
*[[Installation FAQ]]
*[[Installing AMP|Options for installing Apache, MySQL and PHP]]
*[[Upgrading|Upgrading Moodle]]

== System-specific Instructions & Packages ==

* [[SUSE Linux Server 10|Automated Installation Guide for SUSE Linux Enterprise Server 10]] operating system
* [[RedHat Linux installation|Step by Step Installation Guide for RedHat]] operating system
* [[Debian GNU/Linux installation|Step by Step Installation Guide for Debian GNU/Linux]] operating system
* [[Step-by-step Install Guide for Ubuntu]]
* [[Step-by-step Install Guide for Ubuntu using apt-get]]
* [[Step-by-step Install Guide for Zenwalk-5.0]]
* [[Step-by-step Install Guide for Solaris 10 with Oracle 10]]
* [[Windows installation|Windows installations with instructions for Windows NT/2000/2003 servers]]
**[[Windows installation using XAMPP|Windows installation using XAMPP: Apache, MySQL and PHP]]
* [[Installing Moodle on Windows Vista]]
* [[Complete Install Packages for Mac OS X | Complete Install Packages for Mac OS X 10.3/10.4/10.5]]
* [[Step-by-step Guide for Installing Moodle on Mac OS X 10.4 Client|Step by Step Installation on a Mac OS X 10.4 Client using the internal web server]]
* [[Step by Step Installation on a Mac OS X 10.5 Server]]
* [[1and1_MySQL_installation | Installation on 1and1 web hosting]]
* [[OLPC XS installation|Step by Step Installation Guide for the One Laptop per Child XS Server (Beta)]]
* [[Installing Oracle for PHP]]

==Security, Performance and Roles==

*[[Security]] contains important security procedures for a production site
*[[Performance | Performance and optimization]] for ideas on improving the speed of your installation
*[[Manage roles | Managing roles]] For Moodle 1.7 and later.
*[[suhosin]] is an advanced protection system for PHP installation. It was designed to protect servers and users from known and unknown flaws in PHP applications and the PHP core.

== FAQs ==

*[[Installation FAQ]]
*[[Administration FAQ]]
*[[Backup FAQ]]

== Configuration Settings ==
*[[Site administration block]] contains configuration setting links
*[[Notification page]] used to update versions
*[[Variables]]
*[[Site settings]]
*[[Themes]]
*[[Language]]
*[[Activity modules administration]]
*[[Blocks administration]]
*[[Filters]]
*[[Backup settings]]
*[[HTML editor settings]]
*[[Calendar settings]]
*[[Maintenance mode]]

* See also:
**[[Location of admin settings in 1.7|Comparison between configuration settings in Moodle 1.6 & 1.7]]

==User Management==

*[[Authentication]]
*[[Add new user|Add a new user]] - on a site
*[[Upload users]] - from a file to a site, and into existing course and group, some existing user global updates
*[[Enrolment plugins]]
**[[Flat file]] - enrol existing users in a course
*[[Roles and capabilities|Assigning user a role]] - typical assignments include:
**[[Students|Enrol students in a course]]
**[[Courses (administrator)|Assign teachers]] - to a course
**[[Assign creators|Assign course creators]] - in a site
**[[Assign administrators]] - in a site

==Other==

*[[Courses (administrator)|Courses]] and [[Course formats|course formats]]
*[[Reports (administrator)]] and [[Logs]]
*[[Site files]]
*[[Moodle database|Database]]
*[[Environment]]
*[[Moodle Network]] and Moodle [[Community hub]]
*[[Streaming Media]]
*[[Case studies (administrator)]]
*[[Anti-virus]]
*[[System Monitoring and Server Statistic Software]]

==See also==

*[[:Category:Administrator | Index of all Administrator-related pages]]
*[[Integrations]]
*[[CVS for Administrators]]
*[[Email processing]]
*[[Search engine optimization]]
*[[Messaging]]
*[[Migration]]
*[[Metacourses]]
*[[Block layout]]
*[[Customizing Moodle]]
*[[Administrator do's and don'ts]]
*[[Using Moodle book]] Chapter 16: Moodle Administration
*[[Administration hacks]]

[[Category: Administrator]]
[[cs:Rukověť správce]]
[[es:Documentación para Administradores]]
[[eu:Kudeatzaileentzako dokumentazioa]]
[[fr:Documentation administrateur]]
[[ja:管理者ドキュメント]]
[[ko:관리자 문서]]
[[nl:Documentatie voor beheerders]]
[[pt:Documentação para administradores]]
[[ru:Администраторам]]
[[sk:Dokumentácia pre správcov]]
[[zh:管理员文档]]
[[pl:Administrator documentation]]
[[fi:Ylläpitäjän opas]]

Student tutorials

2008-09-08T11:03:22Z

Raimondo:

{{Work in progress}}

The initial vision was to provide a tutorial for Moodle site access and course information for a [[Student|student]].

=Moodle site access and navigation=
* Logging in
* Site Navigation
* Finding a course
* Enrolling and Unenrolling

=Course information=
==Settings==
[[Image:Administration_Block_student.JPG]]
:Students can see information about themselves and edit some of it by using links in their administration block.
===Your Profile===

[[Image:Profile_Edit_icon_link.JPG]] The profile contains information about you. Other users on Moodle can see your profile if they click on your name. Profile information includes the description of yourself (if you have entered one) your name, location, email address (if you chose to make it accessible) and the list of courses you are enrolled on. When you view your profile you can edit it by clicking on the 'edit' tab. In your profile you can add a picture of yourself (or anything else you like). This image will appear next to your name in forum messages etc.
====Updating your Profile====
[[Image:Profile_Edit_Student_Tabs.JPG]]
In your profile you can also update information such as your location or email address and you can see your activity (so can your teacher).

Please update your profile if you change your email address, as this will enable you to receive updates or information sent out via Moodle. If you choose to automatically subscribe to forums, you will receive email copies of all new messages in forums you participate in. Forum tracking is useful to use as well, as it will let you quickly identify new messages in forums.

There are several settings that are accessible from your profile that will help make your use of Moodle more productive.

*'''Email format''': You can choose to have emails sent from Moodle in Plain text format or Pretty HTML format. HTML format will include images and the Moodle colour scheme in emails, but will be slightly larger in size.
*'''Forum auto-subscribe''': If you select yes for this it will mean that when you post a message to a forum, you will be subscribed to that forum and receive email copies of all messages for that forum. You may unsubscribe from forums if you wish as well.
*'''Email digest type''': You may choose to receive all emails from Moodle in one daily message. There is also the option to receive either the complete message or just the Subjects from forums you subscribe to.
*'''Forum tracking''': This is a useful option to enable. If it is enabled on your Moodle site it will highlight unread forum messages so you can easily see what is new.

==Gradebook==
[[Image:Grades_icon_link.JPG]] in your administration block links to the gradebook.
<nowiki>Insert non-formatted text here</nowiki>

==Activities==
[[Image:Activity_Block_Student.JPG]]
::The activities block shows the student all the activities available in a course. In the [http://demo.moodle.org Moodle Features Demonstration Course], all the activities are available to the demonstration student.

==Using text entry==
Creating a message or adding text to Moodle is usually through a text entry area.
[[image:editortools.jpg]]

==Messaging, blogs & forums==

==Using Participants block==

=See also=

* [[Student FAQ]]
* [[Student documentation]]
* [[Student documentation examples]]
[[Category: Student]]

[[es:Tutoriales_para_Estudiantes]]
[[fi:Opiskelijan opas]]

Help:Contents

2008-09-06T18:51:30Z

Raimondo:

{{Help}}

*You are welcome to explore Moodle Docs using the links on the [[Main Page|main page]] and/or browse the various [[Special:Categories|categories]]. Alternatively, you may try [[MoodleDocs:Searching|searching]] Moodle Docs.
*Please feel free to [[MoodleDocs:Guidelines for contributors|contribute]] to Moodle Docs and help create the best documentation for Moodle!
*If you wish to ask a question about Moodle, please visit the moodle.org [http://moodle.org/course/view.php?id=5 Using Moodle] forums.
*If you'd like to experiment with this wiki, please do so in the [[Sandbox|sandbox]].

[[Category:MoodleDocs]]

[[es:MoodleDocs:Ayuda]]
[[fr:Aide:Contenu]]
[[ru:Справка:Содержание]]
[[zh:帮助:目录]]
[[ar:مساعدة: محتويات]]
[[ja:Help:コンテンツ]]
[[pt:Ajuda:Conteúdo]]
[[de:Hilfe:Inhalte]]
[[fi:MoodleDocs:Ohje]]

Category:Help

2008-09-06T17:18:36Z

Raimondo: New page: Category:Help

Category:Help