Note: You are currently viewing documentation for Moodle 2.2. Up-to-date documentation for the latest stable version is available here: Guidelines for contributors.

MoodleDocs:Guidelines for contributors: Difference between revisions

From MoodleDocs
(subtitles, see also, moodledocs category)
(help files)
Line 6: Line 6:
* Please note that all contributions will be released here under [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License 1.2].
* Please note that all contributions will be released here under [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License 1.2].


== Documentation for every page in Moodle ==
== Documentation for every page ==


* 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.
* 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.
* 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.


== See also ==
== See also ==


* [[A plan for the documentation]]
* [[Help:Editing|Editing help]]
* [[Help:Editing|Editing help]]
* [[Sandbox]] - for experimenting/playing ;-)
* [[Sandbox]] - for experimenting/playing ;-)

Revision as of 21:31, 6 December 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

Documentation for every page

  • 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.
  • The Moodle help files will remain in each language pack and so their text need not be included in this documentation.

See also

External links