Note: This documentation is for Moodle 2.7. For up-to-date documentation see Guidelines for contributors.

MoodleDocs:Guidelines for contributors: Difference between revisions

From MoodleDocs
m (Guidelines for Contributors moved to MoodleDocs:Guidelines for contributors)
m (screenshots text moved)
Line 5: Line 5:
* If you've not done so already, please [[Special:Userlogin|create an account or login]].
* If you've not done so already, please [[Special:Userlogin|create an account or login]].
* Please note that all contributions are released here under [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License 1.2].
* Please note that all contributions are released here under [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License 1.2].
* Moodle 1.6 will have a button on each page that links to pages in the wiki with the same path as the pages in Moodle. You can see this already on [http://moodle.org moodle.org] in fact.
* Moodle 1.6 will have a button on each page that links to pages in the wiki 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].
* 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 welcome to create pages for additional documentation. Simply type <code><nowiki>[[New page]]</nowiki></code> and follow the link to start editing the new page. Please choose a short name (just one or two words) and capitalize the first word only.
* You are welcome to create pages for additional documentation. Simply type <code><nowiki>[[New page]]</nowiki></code> and follow the link to start editing the new page. Please choose a short name (just one or two words) and capitalize the first word only.
 
* You are encouraged to illustrate documentation with screenshots. Please refer to the [[MoodleDocs:Style guide|style guide]] for further information.
==Screenshots==
 
* You are encouraged to illustrate documentation with screenshots. Please use the official [http://demo.moodle.com/ Moodle demo site], or any other site or course using one of the standard themes, and ensure that the screenshot is as small as possible.
* Please do not apply effects such as borders, watermarks or drop shadows to screenshots. This will allow others to add or replace screenshots over time and still maintain a consistent look and feel to articles.
* Screenshots may be uploaded using the toolbox [[Special:Upload|Upload file]] link.
* For help on image placement and adding an image caption, please refer to the  [http://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial Wikipedia:Picture tutorial].


== Documentation discussions ==
== Documentation discussions ==
Line 25: Line 19:
* [[Documentation philosophy]]
* [[Documentation philosophy]]
* [[Help:Editing|Editing help]]
* [[Help:Editing|Editing help]]
* [[MoodleDocs:Style guide|MoodleDocs style guide]]
* [[Sandbox]] - for experimenting/playing ;-)
* [[Sandbox]] - for experimenting/playing ;-)


[[Category:MoodleDocs]]
[[Category:MoodleDocs|Guidelines for contributors]]

Revision as of 09:17, 31 January 2006

You are welcome to contribute to MoodleDocs. Find something that can be improved, either in content, grammar or formatting, and fix it!

Contributing to MoodleDocs

  • If you've not done so already, please create an account or login.
  • Please note that all contributions are released here under GNU Free Documentation License 1.2.
  • Moodle 1.6 will have a button on each page that links to pages in the wiki 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 welcome to create pages for additional documentation. Simply type [[New page]] and follow the link to start editing the new page. Please choose a short name (just one or two words) and capitalize the first word only.
  • You are encouraged to illustrate documentation with screenshots. Please refer to the style guide for further information.

Documentation discussions

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

See also