MoodleDocs:Guidelines for contributors

Revision as of 23:15, 9 January 2008 by Jaime Villate (talk | contribs) (Link to Portuguese version)

Jump to: navigation, search


  • You are welcome to contribute to Moodle Docs. Find something that can be improved, either in content, grammar or formatting, and fix it!
  • If you've not done so already, please login.
  • Please note that all contributions are released here under GNU General Public License.
  • From Moodle 1.6 onwards, every page in Moodle has a link to a corresponding page in Moodle Docs. You can see this on and, from an administrator's perspective, on the Moodle demo site.
  • Please note that the Moodle help files will remain in each language pack and so their text need not be included in this documentation.
  • You are encouraged to illustrate documentation with screenshots. Please refer to the style guide for further information.
  • If you find any page requiring deletion, please type
    at the top of the page.

Creating new pages

  • You are welcome to create pages for additional documentation. Simply type the name of your new page between double brackets
    [[New page name]]
    on an existing page and follow the link to start editing the new page. Alternatively, you may type in your browser address bar:
    (i.e. replace spaces in the new page name with underscores).
  • Please choose a short name and capitalize the first word only (with a few exceptions, such as the word Moodle).
  • New developer documentation pages should be added to the Development namespace by typing
    before the new page name i.e.
    [[Development:New page name]]
  • Please follow the style guide, in particular ensuring that new pages are categorised.
  • Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.

Inter-language linking

  • You are welcome to add inter-language links between pages in different languages. Simply type, for example,
    [[es:Corresponding page title in Spanish]]
    in the English MoodleDocs, or
    [[en:Corresponding page title in English]]
    in the Spanish MoodleDocs, at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.

Moodle version templates

  • When adding documentation about a new feature, please add a Moodle version template by typing, for example,
    {{Moodle 1.9}}
  • In addition to highlighting differences in Moodle versions, Moodle version templates automatically categorize articles into version categories, for example Category:Moodle 1.9.
  • Templates for Moodle versions no longer available from Moodle downloads can be removed and replaced with ordinary text, for example "From Moodle 1.5 onwards, ...".

Page comments

  • For comments about a particular page, and/or short discussions, please use the corresponding talk page (click on the page comments tab). Please sign and date your talk page contribution by typing four tildes ~~~~.
  • For longer discussions about the documentation, please use the Using Moodle Documentation forum.