Plugin documentation
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
Plugin developers, maintainers and users are welcome to write documentation about their plugin in the English user docs.
Where should the documentation go?
A new page may be created in the docs wiki by
- EITHER typing in the browser address bar:
https://docs.moodle.org/en/Plugin_name(where Plugin name is the name of the plugin in the plugins directory) - OR browsing to a page in Moodle for the plugin and then following the 'Moodle Docs for this page' link.
If you decide later that you want to change the name of the page or create redirects to the page, please email Helen (helen@moodle.org).
What should the documentation include?
The documentation should include
- A link to the plugin in the Moodle plugins directory
- A link to a forum or discussion thread where questions about it can be answered. If there is not yet any discussion thread about the plugin, a link to the Contributed plugins forum should be included.
[[Category:Contributed code]]typed at the bottom of the page
The documentation may also include
- A features overview with screenshots
- Installation instructions
Which version of the user docs should the documentation be added to?
Plugin documentation should be added to the most recent version wiki in which the plugin works, for example if the plugin works in Moodle 2.3, it should be added to the Moodle 2.3 docs wiki.
Please note that, as part of the 2011 docs wiki clean-up, documentation pages for older plugins (in the old modules and plugins database) were deleted from the newer version wikis. However, the documentation is still available in the Moodle 1.9 docs wiki. When a plugin developer updates their code, if the original documentation page was deleted it can be recreated in a newer version wikis.
I need help!
If any of the above sounds too complicated, please don't worry - just email Moodle Docs wiki admin Helen (helen@moodle.org) who will be happy to help you :-) (Restoring and redirecting pages etc. are quick and easy for a wiki admin to do!)
