Docs2

Moodle 2 Docs objectives

• Have a set of clear, user-friendly Docs for people to contribute to and read.

• Have a broad structure/overview (including a Table of Contents below) to:

- make it easy to clone/archive for each future version of Moodle and its dedicated Docs wiki.

- make it easier for community members to see where to create and find content (while free to edit and add pages, of course).

- make it easier to see what documentation is missing/outdated/irrelevant

- make it easier to link page URLs in Moodle releases to appropriate Docs page

Table of Contents - a map of pages and templates

The Table of Contents below is a map of pages and templates that appear on (some of) them.

Imagine a template (box of links on the right side, example) on the page for each indented item. For example (using the table below), Page 1. will have a template with items 1.1.1 - 1.1.7, page 1.1.4 will have items 1.1.4.1 - 1.1.4.4 etc).

If we want a stricter control over templates as the organising feature of Table of Contents, we could perhaps lock them and only a few people can make changes to keep a reasonable structure (will help in cloning new version wikis).

The useful links in creating each page (check the initial Docs 2.0 draft) will be inserted into page comments for each page to help community members build the wiki but with information customised for Moodle 2.x.

Templates for activities explained:

• 'Activity' Settings

Corresponds with Settings [block]-> 'Activity' administration menu -> Edit settings, hence the name used. Include permissions.

This is the first stage (add/update) of two-step activities (Database, Lesson, Feedback, Quiz).

Guide the user through the options available ON THIS PAGE ONLY, before they click 'Save and display'.

• Building 'Activity' (Database, Lesson, Feedback and Quiz only)

What the creator (eg. teacher) needs to know after the initial setup ('Activity' settings) in building the activity before it is opened to participants (eg. students).

• Using 'Activity'

Everything AFTER the activity is open to participants. Things like viewing, posting, grading, results, analysis, reports, good practices, examples, pedagogical implications.

This should provide enough 'room' for community members to create new pages and content without being too prescriptive in what they should write.

Strange remarks

Legend to remarks, temporary only from a doc that helps (Tomaz) keep track of what (template) links to what. These will be deleted in the final wiki.

[P] = Primary article
[link] = Link to primary article. No editing here, only edit the primary article [P].
[RD] = Redirect. From similar (sounding) articles.
[Eq. to …] = Equivalent to ...

Introduction to Moodle

About Moodle

About_Moodle - intro, links in menu to existing Background,
add Features

Philosophy

existing Philosophy - links nicely into five_key_principles,

License

existing License,

Usage

existing Usage and update info useful - Large_installations

Versions of Moodle

basic text at Teacher_documentation#Versions_of_Moodle, can draw on Moodle_version_history  and Release Notes

[Current, eg. Moodle 2.1] Release Notes

existing Release Notes , adjust for each release

Moving to Moodle 2

Upgrading_to_Moodle_2.0 - GU, Feb 11, more for Admins but some useful info here for teachers to be aware of (eg. some 3rd party mods 
n/a etc) need a doc with main differences between Moodle 1.x and 2 (maybe need one earlier, not just here...), list of main issues people 
need to be aware of when moving 1.9 to 2.0, even examples, links to discussions?

Future versions

existing Future, update to reflect CURRENT plans 

Glossary of Moodle terms

need one, link Glossary of common terms - GU, 
urgent update needed, many key Moodle 2 items not there

Moodle community

basic text at Teacher_documentation

Moodle.org forums

overview of forums at Moodle.org and how to use them, see any related pages

Moodle Docs

Only a brief overview, launchpad for menu/template items
Docs MoodleDocs:Guidelines_for_contributors - very useful

How to use Moodle Docs

Write in line with NEW wiki, not old. How to find things, search, browse, navigate, Table of Contents etc.

How to contribute to Moodle Docs

Docs MoodleDocs:Guidelines_for_contributors - very useful, but keep in mind Moodle Docs article - avoid (over)duplication

MoodleDocs FAQ

Moodle_documentation_FAQ - P, 

QA Testing

QA_testing - re-use!

Moodle Tracker

Tracker - G, Feb 11, check to reflect the CURRENT workflow

Report a bug

see Tracker for this sub-item, can expand the basics here 

Suggest improvements

see Tracker for this sub-item, can expand the basics here 

Moodle Mobile

Mobile_Moodle_FAQ - O, April 11, update & expand

Moodle accessibility

accessibility - PU, 2009, ancient and in bad need of update!
useful link: Accessibility forum

Moodle myths

Top 10 Moodle Myths could keep these in menu and include [http://moodle.org/mod/page/view.php?id=7742 5 Myths about teaching and
learning with Moodle], see Teacher_documentation

Getting your Moodle [link]

link to larger section

Managing Moodle site [link]

link to larger section

Managing courses [link]

link to larger section

Learning and evaluation tools [link]

link to larger section

Managing content [link]

link to larger section

Moodle FAQ

Link to Category FAQ, entry page to all FAQ, existing 

Getting your Moodle [P]

Roughly the main start-up items here. They should all inform the reader what to do 
before they install Moodle and during installation. Once Moodle is successfully 
installed the person can move on to info in the next main topic 'Managing your 
Moodle' 

Download packages

link to Downloads page and explain the basics, put in useful links

Installation guide

Installing_Moodle_2.0 - very similar to Installing_Moodle
see existing Docs on Apache, IIS, PHP, MySQL, 
User_site_capacities , PHP_settings_by_Moodle_version, Installing_Apache,_MySQL_and_PHP and more
many of these terms could simply go in the Glossary of Moodle terms
much duplication in the existing menu at Installing_Moodle clean up the structure,
useful menu items there, useful list of links but please CHECK for quality and relevance to Moodle 2 

Moodle directory

useful Moodle_site_moodle_directory, check for any changes in Moodle 2	

Moodle site database

useful -> Create_Moodle_site_database - changes in Moodle 2?

Moodle site data directory

Moodledata_directory - G, Moodle 2 specific, use it!

Installation FAQ

Installation_FAQ - Include installation troubleshoot, common problems, point to [http://moodle.org/mod/forum/view.php?id=28 Installation 
Problems] forum !? Some troubleshooting already at Installing_Moodle#Troubleshooting,
CHECK for accuracy of info relating to Moodle 2
consider breaking up FAQ page into sections (eg. before installation, troubleshooting, upgrading ...)
consider also a range of installation guides for different systems, examples:
Step by Step Installation on a Mac OS X Server
Step-by-step Guide for Installing Moodle on Mac OS X 10.4 Client
Step-by-step Install Guide for Debian
Step-by-step Install Guide for Ubuntu using apt-get
Step-by-step Installation Guide for Ubuntu

Upgrading Moodle

Upgrading - general page with common info
Upgrading_to_Moodle_2.0 - Moodle 2 specific, linked from Upgrading, mentioned above in Moving from Moodle 1.x

Site registration

Site_registration - OU, Aug 10, good, re-use. Mainly hubs, any other purposes of registration 
(eg. registered sites stats, versions running...). Mention that registration of site = registration on MOOCH.

Moodle Partners

Moodle_Partners - Could expand this a bit, include info on hosting, mention 'free hosting' offers and pros and cons ?

Try Moodle

Demo, School Demo, maybe Partner offers?

Useful demo sites

Must mention School Demo, Demo, QA and a course at Moodle.org dedicated to these sites

Free Moodle

M, often asked for! Need a page

Choosing a web host

Finding_and_Selecting_A_Web_Host - GU, Aug 10, detailed, check for currency and accuracy of this information!
could incorporate info from Decision_FAQ
also very useful:
Hosting_for_moodle_teachers - GU, Aug 08, very useful, well written
Hosting_for_moodle_admins - GU, 09, the 'basic' page, solid
Hosting_for_moodle_admins_advanced - incorporate this with [[Hosting_for_moodle_admins really...

Managing a Moodle site [P]

This section is about managing things the entire site. It contains 
information about many features only Moodle Admin can manipulate but which may be 
of use to users, particularly teachers and administrative staff in various 
organisations (eg. managers),  - useful as a reference point & see what Docs exists but
make Moodle 2 relevant!

Basic structure of a Moodle site

create this, links nicely with glossary above; stuff like context, role, 
course, category etc but KEEP IT SIMPLE and use DIAGRAMS, examples
Something along the lines of these slides.
These will be very short, introductory, pointing to parts where we expand on each 
(eg. from 'Roles' to 'Roles and permissions' section

Context

Context - OU, Nov 09, 1.8 VI, update this, simplify, some info useful

Category

M! We DON'T have a page dedicated to Categories yet! I suppose this one is IT -> 
Add/edit_course_categories - OU, Oct 10, some useful general 
info on categories,  Admin but good for teacher to know what they are and how they 
work borrow from/link to 

Navigation

Brief intro, mention main navigation options, mention that using 'Back' button may not refresh 
eg. the latest forum posts.

Navigation block

Navigation_block - G, Jan 11, Moodle 2 specific (of course :D )
Structure of a Moodle site - forum thread, started 
by Tim Hunt see anything else related in  

Navigation bar

Navigation_bar redirect from Breadcrumbs - OU, 08, a screenshot would help plus explanation of changes in Moodle 2 since 1.x 

Custom menu items

M, need a page on Custom menu items - really part of Themes but essentially a good way to navigate hence the inclusion here. Link from themes to here. 

Navigation display

Navigation display - M, need a page, perhaps an annotated screenshot of Site administration->Appearance->Navigation page
create a page with screenshots, provide/extend the context on that screen for each item, see the same thing for Blog and Calendar 

Editing settings

extract from Adding/editing_a_course, mention Settings block (new in Moodle 2), basics of editing, the turn edit on-change/create-set cycle...

Settings block

Settings_block - GU, Nov 10, rightfully mentions Context but Context page needs work, Context described in-depth elsewhere under Manage site

'Turn editing on' button

Turn_editing_on - OU, Dec 08, basic OK, icons mentioned, update to reflect Moodle 2, mention 'advanced web features' (Ajax) 

Editing icons and menus

shown and described Adding/editing_a_course#Editing_a_course,
M, no special page(s) on what each icon does or menu (eg. Add a resource...), would be useful. Include new items (eg. Ajax/Adv web button) not
included at Adding/editing_a_course#Editing_a_course 

My Profile

customisable, point location in Navigation,
Moodle_2.0_release_notes#User_profile_pages - pointers, handy
View_profile - Jan 11, Admin-focused but some aspects useful,
we need some images and examples, link to 

My Moodle

My_Moodle - OU, Feb 11, needs an update to reflect big changes in Moodle 2, user customisation possible etc
[[1]] - handy pointers

Managing site users

General intro, flag what's in this section...max 200 words, mostly links.

Information mostly for Administrators, but useful for eg. management team to know 
what can be done with Moodle

Accounts

Browse list of users

Browse_list_of_users -OU, Jul 09, basics OK, mention different views in Moodle 2, new screenshot

Bulk user actions

Bulk_user_actions - OU, Jul 10, OK, mostly Admin, some use in enrolment
need to mention Cohorts  as an option too in enrolment.
Bulk_course_upload - another 'bulk' item, may not be relevant here...

Add a new user

Add_a_new_user - stub, needs...everything

Upload users

Upload_users - G, Jan 11, detailed, includes Upload_users#Deleting_accounts useful links

Upload user pictures

Upload_user_pictures - GU, Jun 08, 1.9 VI, basics OK, defaults, screenshot?

User profile fields

Edit_profile - GU, Oct 10, references to 1.9, check but some useful info, a useful run down the profile page, changes in Moodle 2?  

Roles and permissions

Roles - OU, Sep 09, 1.8 VI (!) update to reflect changes in Moodle 2, handy 
menu, in intro already flag how pedagogically useful and powerful they can be, 
link to Useful_things_a_teacher_can_do_with_roles and more ... import from 
other parts of this doc

Uses of roles

Useful_things_a_teacher_can_do_with_roles is a start but this one needs expanding to really take Moodle 2 roles for a ride!

Permissions

Role_permissions - OU, Jul 08, 1.7 VI (!),  
although flagged in Roles need a separate page since we are bunching Roles & Permissions together in this section. Just 
a basic intro will do!

Standard roles

Standard_roles - Aug 08, need Manager here 

Administrator

Administrator - OU, Apr 10, basics OK, would be useful to mention Manager role in Moodle 2 - similar to Admin

Manager

Manager_role - stub, 11, basics OK, need to expand & link

Course creator

Course_creator_role - OU, Nov 09, basics OK, put in format with others

Teacher

Teacher role - G, just shape a bit

Non-editing Teacher

M, no page about this role, only references to it..?

Student

Student role - U, has links to Students (teacher's view of a student), Student FAQ, Student tutorials, 
must mention this role can be renamed (like any other)

Authenticated user

Authenticated_user - OU, Nov 08, 1.8 VI, shape a bit to format with others

Guest

Guest - G, Dec 10

Manage roles

*Define roles menu item

• Assign roles menu item

Manage_roles - GU, Nov 10, good, has reference to changes in role archetypes in Moodle 2, handy links to examples
of custom roles, would be great to link to actual examples
Allow_role_assignments - OU, Sep 08, 1.7 VI (!!), old UI for changing roles (tabs)
Allow_role_overrides - OU, Jul 08, does this all play with M2? Very 'Admin' but important for teachers to know this 
can be done, perhaps a screenshot, example, then link to this article from M2 Docs, merge assignments & overrides?
Assign_roles - GU, Feb 11, useful info but a bit ... disorganised, equal headings make it difficult
Override_permissions - G, May 10, copy but check and leave mostly as is
need to match Assign system roles item in the menu, new wiki page for this and include on the menu on Manage_roles 
Risks - OU, Nov 09, any more than these? Include 'how to recognise' &
'what to do'. We are talking tech risks, not risks with innovative teaching methods...
Role_permissions - OU, Jul 08, 1.7 VI (!), 
Roles_FAQ - GU, Sep 10, great set of Q, mix of admin/teacher, update with more Moodle 2 related Q 
(What's new in M2? is there :D )

Create custom roles

useful info in the following pages (but try to avoid [over]duplication):

Manage_roles - GU, Nov 10, good, has reference to changes in role archetypes in Moodle 2, handy links to examples
of custom roles, would be great to link to actual examples
Allow_role_assignments - OU, Sep 08, 1.7 VI (!!), old UI for changing roles (tabs)
Allow_role_overrides - OU, Jul 08, does this all play with M2? Very 'Admin' but important for teachers to know this 
can be done, perhaps a screenshot, example, then link to this article from M2 Docs, merge assignments & overrides?
Assign_roles - GU, Feb 11, useful info but a bit ... disorganised, equal headings make it difficult
Override_permissions - G, May 10, copy but check and leave mostly as is
sample non-standard roles (maybe this would be better in Manage course roles and permissions section...teachers use, 
Admins create though)
Useful_things_a_teacher_can_do_with_roles - GU, Oct 10, excellent, can add more examples, link to them? 
Inspector_role - for providing external inspectors with permission to view all courses (without being required to enrol)
Parent_role - for providing parents/mentors/tutors with permission to view certain information about their children/mentees/tutees
[[[Useful_things_a_teacher_can_do_with_roles]] - GU, Oct 10, good collection, maybe add, link to example(s)
Demo_teacher_role - for providing a demonstration teacher account with a password which can't be changed
Forum_moderator_role - for providing a user with permission in a particular forum to edit or delete forum posts, 
split discussions and move discussions to other forums
Calendar_editor_role - for enabling a user to add site or course events to the calendar
[[Blogger_role] - for limiting blogging to specific users only (this changes in Moodle 2 and Blog Association...)
Quiz_user_with_unlimited_time_role - for allowing a user unlimited time to attempt a quiz which has a time limit set
Question_creator_role - for enabling students to create questions for use in quizzes
Keyholder_role - someone who manages the Enrolment key in courses
Course_requester_role - for restricting users who can make course request 

Site-wide role settings

Brief intro to flag the items on the menu/template

User policies

User_policies - GU, Dec 10, check for compliance with Moodle 2

Site administrators

Administrator - OU, Apr 10, basics OK, would be useful to mention Manager role in Moodle 2 - similar to Admin

System permissions

Check_permissions equivalent to Check_system_permissions - OU, Dec 10, basic OK, mention that a teacher can do 
this at course and activity level too in Moodle 2

Capability report

Capability_report - stub, Moodle 2 but needs all the work

Unsupported role assignments

Unsupported_role_assignments - stub, Moodle 2 but needs all the work

Customising appearance

Front page [P - entire section]

Front_Page - GU, Dec 10, make it 2.0 specific, keep most info, very good

Front page settings

draw from Front_Page, room to expand the basics here

Front page roles

draw from Front_Page, room to expand the basics here

Front page filters

draw from Front_Page, room to expand the basics here

Front page backup

draw from Front_Page, room to expand the basics here

Front page restore

draw from Front_Page, room to expand the basics here

Front page questions

draw from Front_Page, room to expand the basics here

Front page FAQ

draw from Front_Page, room to expand the basics here

Site-wide display settings

Calendar display [link]

link to Calendar settings

Blog display [link]

link to Blog settings

Navigation display [link]

link to Navigation section and explain there briefly

Tags display [link]

link to Tags settings, write there

Security

Common security risks [P]

===Security overview

Site-wide communication tools

There to make things easier, can work across the site, overview and basics (!) to template items

Comments

Development:Comments_2.0 - Aug 10, developers page, handy main points intro the tool
mention Comments report 

Comments settings

M, include Comments display - missing for now, preferences, permissions, Comments report etc.

Uses of Comments

M, need it!

Comments block [P]

Comments_block - OU, Nov 10, basic, need examples, creative uses

Blogs [Eq. to 'Blog']

Don't forget to include Blog association, importing, Forum - Blog-like format too as an option ... lots of the material here can be re-used. 
Blogs - GU, Dec 10, has menu, good general intro 
Blogs_2.0 - G, Jan 11, up to date, maybe more links to examples
Blogs_and_forums - U, Jan 06, a well explained but horribly out of date page (06!), re-use some info though
menus will need a bit of work in this section
for 

Blog settings

Blog_permissions - PU, Jan 08, 1.7 VI, some use, check new permissions in Moodle 2
Blog display - M, need a page, perhaps an annotated screenshot of Site administration->Appearance->Blog page
Blog_preferences - incorporate this, silly to have this one-sentence standalone page
Blog=related blocks (mentioned in Blocks section anyway, linkto here from there)

Uses of Blogs

M, need it! Draw from exiting sources

Adding/editing a blog entry

Adding/editing_a_blog_entry - OU, Nov 09, basic OK, streamline 'how to' part, add a pic
Add/delete_blog_tags - OU, Jan 09, needs an update, reference to a capability (still there? changed?)

Blog association

Blogs_2.0#Blog_associations - re-use, expand with examples
Capabilities/moodle/blog:associatecourse - expand on this, examples and visuals welcome
Capabilities/moodle/blog:associatemodule - expand on this, examples and visuals welcome

External blogs

External_blogs - PU, Jan 11, basic OK, need pic, example, benefits? Exporting to external blogs? 

Blog menu block [P]

Blog_Menu_block - OU, Aug 10, up to date, include 'linked to activity' explanation/example (mentioned), links to old blog pages OK

Blog tags block [P]

Blog_Tags_block - OU, Jan 09, useful, add a pic, expand to include user and official tags

Recent blog entries block [P]

Recent blog entries - new in Moodle 2, construct the page according to the format for Moodle Docs on blocks, basic info there for now

Messaging [Eq to 'Messages', 'Messaging system]

Messaging - GU, Dec 10, useful info, can copy most but check M2 compatible, has link to Messaging_2.0 to flag changes in Moodle 2
menu items:
Message_history - PU, a sentence, no pics ...
Messaging_2.0 - OU, Dec 10, start of M2 doc, maybe same menu as Messaging

Messaging settings

M, Messaging display - create it
Messaging_permissions - capabilities only, has link to two forum threads on (dis)abling student messaging,
Messaging preferences and similar items 

Uses of Messaging

M, create

Messages block [P]

Messages_block - OU, Mar 10, bare bones How to there, need a pic at least, page part of Messaging menu
More about this below when talking about Messaging in general

Messaging FAQ

Messaging_FAQ - OU, Nov 10, update with Moodle 2 improvements/changes

Notes

Notes - OU, Oct 10, add some creative uses/link to examples to make the most of this (see Uses of Notes), 
can be a very useful function (eg keeping personal records, informing of changes in student/staff, TO DO lists etc...)

Uses of Notes

M, create it!

Site Notes

M, create it!

Course Notes

M, create it!

Personal Notes

M, create it!

Notes FAQ

M, create it!			

Tags

Tags - GU, Jun 10, 1.9 VI, re-use most of the info, could even keep most of the structure/heading, handy menu of 

Tags settings

Tags - OU, Jun 10, 1.9 VI, linked to from Tags_block, check for changes in Moodle 2 to this
related (menu on Tags page:
Search_tags - OU, Sep 09, 1.9 VI, what can the teacher do with this? Incorporate ...
Tag_editing - OU, Jan 09, 1.9 VI, OK, has link to capabilities, indicate why is this useful again?
Manage_tags - G, Jul 10, 1.9 VI, good, as above - add a scenario where this would be useful, state clearly this is Admin function
only but can be done if teachers request 
Tag_permissions - Jan 09, 1.9 VI, good note about allowing all/some to create tags
also see Search tags Tag editing  
Manage tags Tag permissions - all need checking, 
mention personalisation options in Moodle 2 (eg. you can have this on My Home, even My Profile), explain Tags pages
and who can edit them (Admin only?) and the fact that some blocks only appear on tags pages.

Uses of Tags

M, create it!

Tags block [P]

Tags_block - OU, Mar 10, OK but add a few possible uses & benefits, better pic needed

Tags display [P]

Admin item, needs a page but can draw on items in Tags section

Tags FAQ

M, need it

Calendar

Calendar - G, May 10, re-use, good menu (items below), mention that Admin can set sitewide calendar 
settings in Site administration -> Appearance -> Calendar settings 

Calendar settings

include items like Calendar preferences,
Calendar_permissions - PU, Moodle 1.7 VI (!), some capabilities there, link to Calendar_editor_role, check and update this please
also useful Calendar_editor_role
Calendar_preferences - G, check & re-use, some 'creative use' examples would be great in Uses of Calendar
Calendar display - M, need a page, perhaps an annotated screenshot of Site administration->Appearance->Calendar page

Uses of Calendar

M, related Calendar_editor_role - OU, Aug 08, useful, check the capabilities referred to, changes in Moodle 2 (?), example & pic

Adding/editing a calendar event

Adding/editing_a_calendar_event - G, check & re-use, mention possible use, customising options (eg put on My Home, make it sticky...) 

Calendar export

Calendar_export - OU, May 10, Moodle 1.8 VI, check and update with Moodle 2-relevant info

Calendar block [P]

Calendar_block - OU, Apr 08, basic OK, has menu. 
link to Calendar under Sitewide communication tools, more info on item 

Upcoming Events_block [P]

Upcoming_Events_block - OU, Jul 10, need a link to example (maybe that pic is enough, update for consistency?), link this item to Blocks 
section as well since this blocks is mentioned with all others 

Calendar FAQ

Calendar_FAQ - OU, May 10, look in the forum for more FAQ to add
Calendar forum - handy link

Sitewide Reports

Comments report

link to Comments settings section

Managing courses [P]

Brief basics, mention different understandings of a course: eg static 'to pass' or a dynamic community, keep it short. 
Flag (links in) this section.
Course - OU, Apr 10, need to insert a better set of links, even a menu perhaps
Manage_roles - permissions, mentioned in Enrolment, pull out some general info for this (eg. teacher, student, manager, parent ...)
Course_request - PU, Aug 09, OU, 1.6 VI (!!), some info OK but most needs update, some organisations/Admin may allow, 
mention course creator role (default in Moodle 2 install, check?)