MoodleDocs:Guidelines for contributors

2008-03-29T22:09:21Z

Tgilmore:

{{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!
* 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]].
* 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.
* You are encouraged to illustrate documentation with screenshots. Please refer to the [[MoodleDocs:Style guide|style guide]] for further information.
* If you find any page requiring deletion, please type <code><nowiki>{{Deletion}}</nowiki></code> 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 <code><nowiki>[[New page name]]</nowiki></code> on an existing page and follow the link to start editing the new page. Alternatively, you may type in your browser address bar: <code><nowiki>https://docs.moodle.org/en/New_page_name</nowiki></code> (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 <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. THG, March 29, 2008
* 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, <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==

* When adding documentation about a new feature, please add a Moodle version template by typing, for example, <code><nowiki>{{Moodle 1.9}}</nowiki></code>.
* 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 [http://download.moodle.org/ 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 <nowiki>~~~~</nowiki>.
* For longer discussions about the documentation, please use the Using Moodle [http://moodle.org/mod/forum/view.php?id=5838 Documentation forum].

[[Category:MoodleDocs|Guidelines for contributors]]

[[es:MoodleDocs:Normas para colaboradores]]
[[fr:MoodleDocs:Recommandations pour contributeurs]]
[[ja:MoodleDocs:寄稿のガイドライン]]
[[ru:MoodleDocs:Путеводитель_для_разработчиков_документации]]
[[zh:MoodleDocs:贡献者指引]]
[[sv:MoodleDocs:Riktlinjer för bidrag]]
[[pt_br:MoodleDocs:Manual para Colaboradores]]

MoodleDocs - User contributions [en]

MoodleDocs:Guidelines for contributors