Note: You are currently viewing documentation for Moodle 2.3. Up-to-date documentation for the latest stable version is available here: Add-on FAQ.

Add-on FAQ: Difference between revisions

From MoodleDocs
(added template)
(rewording)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Extending standard Moodle}}
{{Installing Moodle}}==What is an add-on?==
{{Improve}}
==What is contributed code?==


Contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution.
An add-on, previously known as a contributed plugin, contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution.


==Where can I download contributed modules and plugins from?==
Moodle code = core code + plugins. Plugins may be either standard plugins (included in the Moodle distribution) or add-ons.


The [http://moodle.org/mod/data/view.php?id=6009 Modules and plugins database] is a comprehensive reference of all known Moodle modules, hacks and plugins.
==Where can I download add-ons from?==


==How do I install a contributed module or plugin?==
The [http://moodle.org/plugins Moodle plugins directory]


See [[Installing contributed modules or plugins]] for instructions. Often the Module and plugin database will also have instructions for a specific contributed code.  Some, but not all, contributors include a "Read me" file with instructions in their contributed code package.   
==How do I install an add-on?==
 
See [[Installing plugins]] for instructions. Some, but not all, contributors include a "Read me" file with instructions in their plugin package.   


In a typical install, you will probably copy some php files into one or more areas of you Moodle site's code, then click on the Site administration link called "Notifications" to start the install process.
In a typical install, you will probably copy some php files into one or more areas of you Moodle site's code, then click on the Site administration link called "Notifications" to start the install process.
Line 17: Line 17:
==How do I apply a patch?==
==How do I apply a patch?==


See [[Development:How to apply a patch]].
See [[:dev:How to apply a patch]].


==Why doesn't my newly installed module show up in the list of modules?==
==Why doesn't my newly installed add-on show up in the list of plugins?==


Firstly, check that you have visited your admin index page <nowiki>http://your_moodle_address/admin/index.php</nowiki> to complete the installation. Next, see the section on installation trouble-shooting in [[Installing contributed modules or plugins]] for further things to check.
Firstly, check that you have visited your admin index page <nowiki>http://your_moodle_site.org/admin/index.php</nowiki> to complete the installation. Next, check that you unzipped the archive to the correct folder, and that the new plugin folder is not contained within another folder.


==How do I contribute code to Moodle?==
==How do I contribute code to Moodle?==


See our [[Development:Guidelines for contributed code|Guidelines for contributed code]].
See [[:dev:Guidelines for contributed code|Guidelines for contributed code]].
 
==Is there any information on creating a new module or plugin?==
 
See [[Development:Modules]], [[Development:Blocks]] and [[Development:Authentication plugins]].


==How do I upgrade my contrib code to Moodle 2.0?==
==Is there any information on creating a new add-on?==


See [[Development:Migrating contrib code to 2.0]].
Yes! See [[:dev:Developer documentation]]. More coming soon!


==See also==
==See also==


* Using Moodle [http://moodle.org/mod/forum/view.php?id=44 Contributed modules and plugins forum]
* Using Moodle [http://moodle.org/mod/forum/view.php?id=44 General add-ons forum]
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=138573 Converting custom modules to 2.0] forum discussion


[[Category:Contributed code]]
[[Category:Contributed code]]
[[Category:FAQ]]
[[Category:FAQ]]

Latest revision as of 13:04, 31 January 2013

What is an add-on?

An add-on, previously known as a contributed plugin, contributed code, or "contrib" for short, is understood to be all code contributed to Moodle which is not included in the standard Moodle distribution.

Moodle code = core code + plugins. Plugins may be either standard plugins (included in the Moodle distribution) or add-ons.

Where can I download add-ons from?

The Moodle plugins directory

How do I install an add-on?

See Installing plugins for instructions. Some, but not all, contributors include a "Read me" file with instructions in their plugin package.

In a typical install, you will probably copy some php files into one or more areas of you Moodle site's code, then click on the Site administration link called "Notifications" to start the install process.

How do I apply a patch?

See dev:How to apply a patch.

Why doesn't my newly installed add-on show up in the list of plugins?

Firstly, check that you have visited your admin index page http://your_moodle_site.org/admin/index.php to complete the installation. Next, check that you unzipped the archive to the correct folder, and that the new plugin folder is not contained within another folder.

How do I contribute code to Moodle?

See Guidelines for contributed code.

Is there any information on creating a new add-on?

Yes! See dev:Developer documentation. More coming soon!

See also