Note: You are currently viewing documentation for Moodle 2.8. Up-to-date documentation for the latest stable version of Moodle may be available here: Guidelines for contributors.

MoodleDocs:Guidelines for contributors: Difference between revisions

From MoodleDocs
m (Reverted edit of Winx.aki, changed back to last version by Aav)
(Moodle version templates, introduction)
Line 1: Line 1:
{{Help}}
{{Help}}
 
==Introduction==
You are welcome to '''contribute to Moodle Docs'''. Find something that can be improved, either in content, grammar or formatting, and fix it!
* 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 [[Special:Userlogin|login]].
* If you've not done so already, please [[Special:Userlogin|login]].
* Please note that all contributions are released here under [[License|GNU General Public License]].
* Please note that all contributions are released here under [[License|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 [http://moodle.org moodle.org] and, from an administrator's perspective, on the [http://demo.moodle.com/ Moodle demo site].
* From Moodle 1.6 onwards, every page in Moodle has a link to a corresponding page in Moodle Docs. You can see this on [http://moodle.org moodle.org] and, from an administrator's perspective, on the [http://demo.moodle.com/ Moodle demo site].
* Please note that the [http://moodle.org/help.php?file=index.html Moodle help files] will remain in each language pack and so their text need not be included in this documentation.
* Please note that the [http://moodle.org/help.php?file=index.html 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 [[MoodleDocs:Style guide|style guide]] for further information.
* You are encouraged to illustrate documentation with screenshots. Please refer to the [[MoodleDocs:Style guide|style guide]] for further information.
Line 21: Line 20:


* You are welcome to add inter-language links between pages in different languages. Simply type, for example, <code><nowiki>[[es:Corresponding page title in Spanish]]</nowiki></code> in the English MoodleDocs, or <code><nowiki>[[en:Corresponding page title in English]]</nowiki></code> in the [[:es:Portada|Spanish MoodleDocs]], at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.
* You are welcome to add inter-language links between pages in different languages. Simply type, for example, <code><nowiki>[[es:Corresponding page title in Spanish]]</nowiki></code> in the English MoodleDocs, or <code><nowiki>[[en:Corresponding page title in English]]</nowiki></code> in the [[:es:Portada|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==
* A Moodle version template may be added just above the description of a new feature by typing for example <code><nowiki>{{Moodle 1.9}}</nowiki></code>.
* Moodle version templates automatically categorize articles into version categories, for example [[:Category:Moodle 1.9]].


== Page comments ==
== Page comments ==

Revision as of 11:55, 19 June 2007


Introduction

  • 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.
  • 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]] 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, 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

  • A Moodle version template may be added just above the description of a new feature by typing for example {{Moodle 1.9}}.
  • Moodle version templates automatically categorize articles into version categories, for example Category:Moodle 1.9.

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.