MoodleDocs:Guidelines for contributors: Difference between revisions

Revision as of 13:35, 27 August 2008

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 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, though a small amount of duplicate information is ok.
You are encouraged to illustrate documentation with screenshots. Please refer to the style guide for further information.
There are tags you can place to ask for editing help from other contributors. These include requests for page deletion, updating and stub notations.

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: https://docs.moodle.org/en/New_page_name (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 Development: before the new page name i.e. [[Development:New page name]].
Please follow the style guide. If you categorize new pages it can make it easier for users to find, but the important thing is to put good content into the page.
Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.

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. With the exception of English, only related languages are interlinked. (If you feel that a related language is not included contact the Docs administrator.)

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, ...".

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.

@@ Line 14: / Line 14: @@
 * 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 categorized.
+* Please follow the [[MoodleDocs:Style guide|style guide]]. If you categorize new pages it can make it easier for users to find, but the important thing is to put good content into the page.
 * Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.