burrokeet
 

User Interface

User Interface

This document outlines the user interface for the Burrokeet System.

This document describes functionality that is not yet complete. Each section indicates the stage of development for the functionality described within it.

Terminology

  • View - an individual graphical interface widget that provides a single editing function.
  • Perspecive - a collection of views that together provide common functionality for a user.

Perspectives

Content Editing

This is used when editing content, it is not intended for use when designing the structure of the learning object.

Content Editing Perspective
Status

This perspective does not currently exist. The Various views do exist, however, they are not yet integrated into a single perspective.

Content Pacakge Editing

This is used when working with the structure of a Learning Object. Editing of content is not available here, the focus is on editing the meta-data and content structure.

Content Package Perspective screenshot

Status

This perspective is complete although the functionality within it is not yet complete.

Views

Resources

This is a tree representation of all the resources available to the developer. Top level nodes will be either local or repository. Local nodes will represent items stored on disk and accessible through normal disk operatios. Repository nodes will represent items stored in a repository and only accesbile through the repository API.

Status

At present this is the default Resource Navigator provided by Eclipse. This provides most of the funcitonlaity we need, but also exposes some functionlaity we do not want (for example Java editing functions).

Content Package



Status

This view is implemented although full functionlaity is not yet available.

Editor

The editor is the place in which individual assets are edited. There are in fact a large number of editors representing many different formats supported by burrokeet.

status

The XML editor is implemented and functional.

Properties

This is a meta-data editor, it provides an interface to the most critical parts of the available meta-data for the currently selected node in the other views. That is, when an item is selected in the Resources view, it shows the meta-data for that resource, in the content view it will show the meta-data for the slected asset and in the Editview it will show the attributes associated with the current selected element.

Status

The properties editor is fully functional.

HTML Preview

This will show what the content package looks like when viewed in a typical browser using the defined HTML view.

Status

The HTML Preview is fully operational.

Roadmap

This section details the expected order of implementation of the functionlaity discussed in this document. The aim is not to restrict development but to help us think about the best order for development.

  1. HTML Preview (Complete)
  2. Editor View (XDoc/XHTML) (Complete)
  3. Content Package View (Complete)
  4. Properties View (Complete)
  5. Resources View (Complete)
  6. Content Editing Perspective (In Progress)
  7. Content Package Perspective (Complete)