Docs2

Docs 2 - Notes

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

• Just a table of contents below, '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.

• Imagine a template (box of links on the right side seen here) 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).

• Users will be able to navigate via:

- templates,

- links in the document,

- Table of Contents you see below,

- Categories (not specified here yet but can go via headings at a particular level eg. two-deep), or

- the normal search function.

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

• Have not included Developer Docs in here but have had conversations with Michael De Raadt regarding any possible links from here to Developer Docs.

• Legend to remarks, info only. These remarks are temporary and from a doc that helps (me) keep track of what (template) links to what. These will be deleted.

[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 ...

*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, Quiz).

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

• Building 'Activity' (Database, Lesson 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.

Getting your Moodle [P]

==Download packages

Managing Moodle site [P]

Basic structure of a Moodle site

Context

====Role==== [link -> 'Roles and permissions']

Category

====Course==== [link -> 'Managing courses'] ====Front page==== [link -> 'Front page' section]

Navigation

Navigation FAQ

===Editing=== [Eq. to 'Settings']

Managing site users

User authentication and access

Authentication methods [Eq. to Authentication plugins]

Shibboleth

=====Web services authentication===== [LINK?]

Customising appearance

Blocks

Blocks in Moodle [insert version number]

HTML block

=====Latest news block===== [link?]

Section links block

=====Self completion block===== [link?]

Security

Common security risks [P]

===Security overview

Extending standard Moodle

===3rd party contributed plugins, modules and filters