Plugin documentation

Revision as of 06:57, 11 October 2013 by Aparup Banerjee (talk | contribs) (Where should the documentation go?)

Jump to: navigation, search

Note: This article is a work in progress. Please use the page comments or the Plugin documentation forum discussion for any recommendations/suggestions for improvement.


Plugin developers, maintainers and users are welcome to include documentation about their plugin in the English Moodle Docs. Of course it is fine to have documentation elsewhere, such as the Github wiki, however one advantage of including documentation in the English Moodle Docs is that 'Moodle Docs for this page' links in Moodle (when logged in as a teacher or admin) can lead directly to your plugin documentation (as explained in en:Header and footer).


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).

Only users who've contributed by editing other pages are able to create a new page.

What should the documentation include?

Example infobox: Stamp collection module

*New*: Copy and complete the following template code to obtain an infobox listing details of the plugin:

{{Infobox plugin
|type = Enter the plugin type e.g. activity, block, filter
|entry = Enter the plugins directory link
|tracker = Enter the bug tracker URL
|discussion = Enter the link to the forum or discussion thread
|maintainer = [[User:Maintainer name|Maintainer name]]
|float = Enter left or right to make the box float to that side (optional)
}}

Note: If there is not yet a discussion thread about your plugin, please create one in the General add-ons forum.

The documentation may also include

  • A features overview with screenshots or videos.
  • Installation instructions

Plugin documentation examples: en:Stamp collection module, en:Profile switches

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!)

See also