Moodle documentation: Documentation for 'contrib' modules and blocks?

Moodle documentation: Documentation for 'contrib' modules and blocks?

by Ne Nashev -
Number of replies: 5
In Teacher page there are list of 'standart' modules and blocks.

How all looks to add some times in that list a some non-standart but useful add-ons like book, dfwiki, course menu, attendance and other things?
Average of ratings: -
In reply to Ne Nashev

Re: Moodle documentation: Documentation for 'contrib' modules and blocks?

by Martin Dougiamas -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers
They probably should be kept separate from that list, but there should definitely be documentation at http://docs.moodle.org/en/mod/book/index and so on!

The new context documentation links in Moodle 1.6 (similar to the ones at the bottom of this page in moodle.org!) should make this easy.
In reply to Martin Dougiamas

Re: Moodle documentation: Documentation for 'contrib' modules and blocks?

by Darren Smith -
Would a block go at something like http://docs.moodle.org/en/blocks/marking/index or just http://docs.moodle.org/en/marking/index ?

I would have thought the former but Helen told me to check first and I don't want to get told off smile

Darren
In reply to Darren Smith

Re: Moodle documentation: Documentation for 'contrib' modules and blocks?

by Helen Foster -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators
Hi Darren,

Thanks for asking about contrib block pages. The reason for http://docs.moodle.org/en/mod/book/index is that this page would link to http://yourmoodlesite.org/mod/book/index. Activity module page URLs include module names e.g. book, whereas this is not the case with blocks.

Overall, MoodleDocs consists of pages linking to pages in Moodle e.g. mod/forum/index and pages not linking to pages in Moodle e.g. Online Users.

Please note that all contributions to MoodleDocs are welcome, including the creation of additional pages. Just as spelling mistakes may be corrected, pages may easily be moved/re-named. As the existing block pages are named simply with the block title, I would suggest you create a marking block page with URL http://docs.moodle.org/en/Marking (and don't worry about getting told off! wink)

PS. All comments regarding a MoodleDocs page-naming policy are welcome... smile
In reply to Helen Foster

Re: Moodle documentation: Documentation for 'contrib' modules and blocks?

by Dan Stowell -
Helen - Does this mean that the page I titled "Jmol filter" should really be "filter/jmol"?

If so, how do I change its name?
In reply to Dan Stowell

Re: Documentation for 'contrib' filters

by Helen Foster -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators
Hi Dan,

Your page named "Jmol filter" is fine, thanks. approve

admin/filters links to the page Administration >> Configuration >> Filters. Jmol filter is comparable to MP3 player i.e. additional documentation pages without corresponding pages in Moodle.

Regarding changing the name of a page, this may be achieved by moving the page i.e. creating a redirect. Currently, only MoodleDocs admin are able to move pages to ensure that link pages are not accidentally re-named. wink