MoodleDocs:Guidelines for contributors: Difference between revisions

Revision as of 17:34, 25 November 2005

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

Although it is possible to edit the documentation as an anonymous user, please create an account or login.
Please note that all contributions will be released here under GNU Free Documentation License 1.2.

Documentation for every page in Moodle

Moodle 1.6 will have a button in the header that links to pages in the wiki with the same path as the pages in Moodle. For example, the documentation page "Viewing and grading submissions" explains what can be seen on the page in Moodle where the teacher can view and grade assignment submissions. The URL of that page is something like yourmoodlesite.org/mod/assignment/submissions.php. When contributing to the documentation, if it contains part of a URL, say mod/assignment/submissions, it means that this documentation page refers to that page.
Use the Moodle help files as the starting point for writing this documentation.

External links

Moodle Demo Site

@@ Line 1: / Line 1: @@
-You are welcome to contribute to Moodle documentation :-)
+You are welcome to contribute to MoodleDocs! Find something that can be improved, either in content, grammar or formatting, and fix it.
-Before you start, please read the following:
+== Contributing to MoodleDocs ==
+* Although it is possible to edit the documentation as an anonymous user, please [[Special:Userlogin|create an account or login]].
+* Please note that all contributions will be released here under [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License 1.2].
-# Before you contribute to a page, read the '''Note for Contributors''' (if it exists) near the top of the page.
+== Documentation for every page in Moodle ==
-# Many of the documentation pages explain what can be seen on a particular page in Moodle. For example, the documentation page "Viewing and grading submissions" explains what can be seen on the page in Moodle where the teacher can view and grade assignment submissions. The url of that page is something like <u>moodlesite.com/mod/assignment/submissions.php</u>. Therefore, when contributing to the documentation, <u>always</u> pay attention to the heading of the documentation page. If it contains a part of a url (e.g. <u>mod/assignment/submissions</u>, it means that this documentation page refers to this page in a moodle site: <u>moodlesite.com/mod/assignment/submissions.php</u>. The reasons for this are explained [[A plan for the documentation|here]].
-# Whenever possible, make use of the help files which are built into Moodle (accessible via the yellow question mark icon) as the starting point for writing the documentation.
-# If you choose to contribute to this documentation, please note that all text and media (e.g. screenshots) you provide will be released here under [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License 1.2].
-# Preferably, all documentation text and media should be based on the '''1.5 release''' of Moodle. However, if you only have access to an older version of Moodle, don't worry, just contribute whatever you can. We'll just add all the 1.5-specific stuff later :-) (Oh, BTW, if you'd like to play with Moodle 1.5, you can do it on the [http://demo.moodle.com/ Moodle Demo Site])
-# The '''standard theme''' is preferred for making screenshots. However, if you do not have access to it, you may base your screenshots on another theme.
-# Follow the [[naming standards]]
-# Although it is possible to edit the documentation as an anonymous user, please, '''do create a user account''' and remember to log in before you start making changes.
-# For the time being, let's concentrate on creating the '''documentation for teachers'''. We'll move on to the other sections later.
-# If you need to discuss any issues relating to a particular page, use its "discussion" page (available through a tab at the top of the page).
-# If you are planning to write the content of a certain page, you may "reserve" it for yourself. Just write a notice at the top of this page, saying
-#* that you would like to reserve it
-#* by when you're planning to write the text
-#* your name
-# Firefox has a nice extension which adds a toolbar to help you with your wiki work: "[http://wikipedia.mozdev.org/ Wikipedia]"
-For help on using the wiki, click "Help" in the navigation menu on the left.
+* Moodle 1.6 will have a button in the header that links to pages in the wiki with the same path as the pages in Moodle. For example, the documentation page "Viewing and grading submissions" explains what can be seen on the page in Moodle where the teacher can view and grade assignment submissions. The URL of that page is something like <code>yourmoodlesite.org/mod/assignment/submissions.php</code>. When contributing to the documentation, if it contains part of a URL, say <code>mod/assignment/submissions</code>, it means that this documentation page refers to that page.
+* Use the [http://moodle.org/help.php?file=index.html Moodle help files] as the starting point for writing this documentation.
+== See also ==
+* [[A plan for the documentation]]
+* [[Help:Editing|Editing help]]
+* [[Sandbox]] - for experimenting/playing ;-)
+== External links==
+* [http://demo.moodle.com/ Moodle Demo Site]
+[[Category:MoodleDocs]]