Don't jump into this idea. I think this may need some careful thinking.
The context help is meant to consist of very concise descriptions of what each feature or option provides (woo hoo, three con-words in a sentence!).
The programmer writes these, and all translations in 70 languages need to be as close as possible to the original description. When the programmer extends the features, they create a NEW help file version to match that version of that feature.
We can't go willy-nilly replacing these files with new content, or everything will get out of synch. At this stage I would like to keep the context documentation separate from the more free-flowing MoodleDocs stuff. However, I'm not against, as I said earlier, putting a link in each help file to "more information on moodledocs" for that help file.
Martin Dougiamas
Posts made by Martin Dougiamas
Moodle in English -> Moodle community sites -> Moodle documentation: Student documentation in MoodleDoc wiki? -> Re: Moodle documentation: Student documentation in MoodleDoc wiki?
by Martin Dougiamas -
a) The internal contextual help will not be changed and will continue to be developed as part of the language packs. We may even add links to the external documentation from the internal context help. Note that in 1.6 the language packs are no longer all included within Moodle, so you only need to download what you need.
b) The external links to documentation are optional. Even if you have them on, the admin can choose a different "root" to go to. So if you don't like http://docs.moodle.org/ you can choose http://docs.mysite.com instead and run your own documentation. Two things being thought about are a) providing a downloadable copy of the current wiki for mirrors to use, and b) adding a warning to the external links explaining that the docs being used are not the official ones.
b) The external links to documentation are optional. Even if you have them on, the admin can choose a different "root" to go to. So if you don't like http://docs.moodle.org/ you can choose http://docs.mysite.com instead and run your own documentation. Two things being thought about are a) providing a downloadable copy of the current wiki for mirrors to use, and b) adding a warning to the external links explaining that the docs being used are not the official ones.
Moodle in English -> Moodle community sites -> Moodle documentation: Student documentation in MoodleDoc wiki? -> Re: But how diffirintiate teacher's docs from student's?
by Martin Dougiamas -
Yes, I think the documentation regarding students in MoodleDocs will be more to the order of "what the student can or can't do", which is really aimed at the Teacher, not the student. As such it should be included on the same page (and in many cases there won't even need to be separate stuff about what students can see).
I believe the internal context-sensitive documentation is good enough for the basic usage that most students need.
I believe the internal context-sensitive documentation is good enough for the basic usage that most students need.
Moodle in English -> Moodle community sites -> Moodle documentation: Screenshots in the documentation -> Re: Moodle documentation: Screenshots in the documentation
by Martin Dougiamas -
I think the standard theme would be best, but any theme that is fairly plain would be OK by me. Very colorful themes or themes that change the default layout should be avoided, just to prevent confusion.
Some guidelines on size are also a good idea. They should be clear and visible but as small in bytes as possible. I'd like to see some opinions on hard numbers.
Also, the language in the screenshots should match the language of the page.
Some guidelines on size are also a good idea. They should be clear and visible but as small in bytes as possible. I'd like to see some opinions on hard numbers.
Also, the language in the screenshots should match the language of the page.