Difference between revisions of "MoodleDocs:Guidelines for contributors"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.2. Up-to-date documentation for the latest stable version is available here: Guidelines for contributors.

(Add Chinese interlink)
(Creating new pages: new developer documentation pages)
Line 12: Line 12:
 
==Creating new pages==
 
==Creating new pages==
  
* You are welcome to create pages for additional documentation. Simply type the name of your new page between double brackets <code><nowiki>[[New page name]]</nowiki></code> and follow the link to start editing the new page. Please choose a short name and capitalize the first word only (with a few exceptions, such as the word Moodle).
+
* You are welcome to create pages for additional documentation. Simply type the name of your new page between double brackets <code><nowiki>[[New page name]]</nowiki></code> and follow the link to start editing the new page. 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 <code>Development:</code> before the new page name i.e. <code><nowiki>[[Development:New page name]]</nowiki></code>.
 
* Please follow the [[MoodleDocs:Style guide|style guide]], in particular ensuring that new pages are categorised.
 
* Please follow the [[MoodleDocs:Style guide|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.
 
* Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.

Revision as of 06:59, 20 September 2006


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.
  • Moodle 1.6 will have a button on each page that links to pages in Moodle Docs with the same path as the pages in Moodle. You can see this already on moodle.org 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
    {{Deletion}}
    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]]
    and follow the link to start editing the new page. 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
    Development:
    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.

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.