Plugins FAQ: Difference between revisions

From MoodleDocs
(rewording)
Line 1: Line 1:
{{Installing Moodle}}==What is contributed code?==
{{Installing Moodle}}==What is an add-on?==


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.
 
==Where can I download add-ons from?==


The [http://moodle.org/plugins Moodle plugins directory]
The [http://moodle.org/plugins Moodle plugins directory]


==How do I install a contributed module or plugin?==
==How do I install an add-on?==


See [[Installing 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.   
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 19:
See [[:dev:How to apply a patch]].
See [[:dev:How to apply a patch]].


==Why doesn't my newly installed plugin show up in the list of plugins?==
==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_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.
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.
Line 25: Line 27:
See [[:dev: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?==
==Is there any information on creating a new add-on?==


Yes! See [[:dev:Developer documentation]]. More coming soon!
Yes! See [[:dev:Developer documentation]]. More coming soon!
Line 31: Line 33:
==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]


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

Revision as of 13:02, 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