Development:Moodle User Interface Guidelines

Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.

The greatest risk of this effort is that developers may not find it when they need it, while designing parts of Moodle. Please help: look at what is here already now, and comment: How could it serve your development work better? What aspects of user interface design would you need clear guidelines on? If there is any reason you feel you can not benefit from the guidelines, please tell me about it in the developer forum thread. See also: Introduction

• Introduction
• Help requested: comment on these guidelines

Moodle basics

• Hierarchy of a Moodle site (one attempt)
• Page structure and different page types
• Roles
• Groups

Moodle UI library

UIs are built of Elements and Interaction Styles (bigger wholes, which are built of Elements).

Elements

• Big Select List
• Hierarchy Browsing List
• Data Listing

• Tabs
• Jump Navigation
• Tooltip
• Links and Buttons

• Command Popup Menu
• Dialog
• Popup Window

Interaction Styles

• Wizard
• Form
  • Radio button
  • Checkbox
• Blocks (not a technical guide but a guideline how what to take into account when using a block as a part of a design)
• Filters
• Modules (not a technical guide but a guideline how what to take into account when using a module as a part of a design)
• Help Popups
• Feedback
  • Feedback pages
  • See presentation (alternate link) of workshop by David Mudrak for the future direction of feedback

Guidelines that may one day be

These are plans to create new interaction styles, switch existing conventions for more usable ones, or to list multiple interaction styles for a single purpose to combine some of them into a more consistent guideline.

• Switch Button
• Add element
• Move Element
• Quick Inline Help ([1] for now)
• Further research required: Search
• Further research required: Editing modes

General design guidelines

• Progressive Disclosure
• User Data Always (Always) Safe (notes)
• Feedback

See also

About writing these guidelines

• Some pages use the Guideline template, others are freeform prose

Usability in Moodle

• Usability
• Usability FAQ
• Development:Major usability issues in Moodle (separate design projects)

Implementation advice

• Developer documentation
• UI coding: Development:Interface_guidelines

Todo

• Problem-Solution Summary Table (TODO: See [2])
• Glossary