MoodleDocs:Guidelines for contributors: Difference between revisions

Latest revision as of 09:08, 9 February 2016

You are welcome to contribute to Moodle Docs. Find something that can be improved, either in content, grammar or formatting, and fix it! Note: You will need to login to edit pages.

Introduction

Please note that all contributions are released here under GNU General Public License.
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.
You are encouraged to illustrate documentation with screenshots. Please refer to the style guide for further information.
See MoodleDocs:Templates for ways of asking for editing help from other contributors.

Creating new pages

You are welcome to create pages for additional documentation about Moodle. 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).
Please follow the style guide. If you categorize new pages it can make it easier for users to find, but the important thing is to put good content into the page.
Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.

Inter-language linking

Inter-language links between pages in different languages may be added by typing, 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.

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 ~~~~. There's also a handy button for signing in the toolbar of the editing field:

For longer discussions about the documentation, please post on moodle.org in the Moodle community sites forum.

If you find an unsigned comment you can use the Template:Unsigned like so {{Unsigned|Username}} which will show as (The preceding comment was added by seri ayu)

Page protection

Certain pages, such as the Table of Contents, are protected from editing. Please use the page comments for suggesting additional content or other changes.

@@ Line 1: / Line 1: @@
-You are welcome to contribute to Moodle documentation :-)
+{{Help}}You are welcome to contribute to Moodle Docs. Find something that can be improved, either in content, grammar or formatting, and fix it! Note: You will need to [[Special:Userlogin|login]] to edit pages.
-Before you start, please read the following:
+==Introduction==
+* Please note that all contributions are released here under [[License|GNU General Public License]].
+* 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.net/ Moodle demo site].
+* You are encouraged to illustrate documentation with screenshots. Please refer to the [[MoodleDocs:Style guide|style guide]] for further information.
+* See [[MoodleDocs:Templates]] for ways of asking for editing help from other contributors.
-# Before you contribute to a page, read the '''Note for Contributors''' (if it exists) near the top of the page.
+==Creating new pages==
-# 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 documennation 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
+* You are welcome to create pages for additional documentation about Moodle. 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'').
+* Please follow the [[MoodleDocs:Style guide|style guide]]. If you categorize new pages it can make it easier for users to find, but the important thing is to put good content into the page.
+* Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.
-For help on using the wiki, click "Help" in the navigation menu on the left.
+==Inter-language linking==
+* Inter-language links between pages in different languages may be added by typing, 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.
+== 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>. There's also a handy button for signing in the toolbar of the editing field: [[Image:Signature Icon.png]]
+* For longer discussions about the documentation, please post on moodle.org in the [http://moodle.org/mod/forum/view.php?id=7135 Moodle community sites forum].
+* If you find an unsigned comment you can use the Template:Unsigned like so <nowiki>{{Unsigned|Username}}</nowiki> which will show as <small>(''The preceding comment was added by'' [[User:Username]])</small>
+==Page protection==
+* Certain pages, such as the [[Table of Contents]], are protected from editing. Please use the page comments for suggesting additional content or other changes.
+==See also==
+*[[Moodle documentation FAQ]]
+*[http://moodle.org/mod/forum/view.php?id=7135 Moodle community sites forum].
+[[Category:MoodleDocs|Guidelines for contributors]]
+[[ca:MoodleDocs:Recomanacions_als_ajudants]]
+[[de:Hinweise für Moodle Docs Autoren]]
+[[es:MoodleDocs:Normas para colaboradores]]
+[[fr:Contribution à la documentation]]
+[[ja:MoodleDocs:寄稿のガイドライン]]