Linking Moodle and Docs
Note: You are currently viewing documentation for Moodle 3.1. Up-to-date documentation for the latest stable version of Moodle is probably available here: Linking Moodle and Docs.
Moodle Docs is an abbreviation for Moodle documentation.
By default, teachers and administrators have "Moodle Docs for this page" links at the bottom of each page in Moodle for accessing context-specific documentation.
The default path is to docs.moodle.org.. You can change this if you wish to have your own custom online documentation. However if you do, make sure that the paths in your documentation follow the same format as docs.moodle.org.
If the Moodle Docs document root field is left blank, no "Moodle Docs for this page" links will appear.
You may find that teachers prefer the documentation to open in a new window, so they can easily return to their page in Moodle. If so, click the "Open in new window" checkbox.
As you may have discovered, Moodle Docs contains many searchable pages which represents 1,000s of hours of refinement by the Moodle community. For example, it is common to see a link from a forum in Moodle.org to a specific page or section in a Moodle Docs page. Likewise, something can be added to Moodle Docs to cover a new feature or to give a more detail description of a process that is not possible or desirable in a forum or as part of the help files.
Moodle Docs is a living document that is constantly changing at docs.moodle.org . Anyone in the Moodle community who sees a need is invited to make an addition or add their opinion in the page comments tab.
- Access Site Administration > Users > Permissions > Define roles.
- Edit the teacher role and change the capability moodle/site:doclinks from allow to not set.
- Scroll to the bottom of the page and click the button "Save changes".
Tips and tricks
It is possible to download an HTML copy of Moodle documentation at wimski.org/docs to another server. While useful, these are not Wiki pages and do not follow the file structure of docs.moodle.org.
It is possible to export one or more docs.moodle.org pages and then import those to another wiki via functions found in Special pages, located in the wiki Toolbox, usually located on the left of each Moodle Doc page.
- Note: Information links are different than help links which are internal links. They can be found in the Moodle site file structure. For example a lesson question's feedback help file might be found at C:\moodle18\moodle\lang\en_utf8\help\lesson\feedback.html