updated specs

In last week's meeting we updated the specs for the project:

dlp-design spec

--------------------

PURPOSE

--------------

This document outlines the current state of design decisions which inform the development the project.

CONTENT

--------------

- high level types of content

- data for each type stored in one database table

- subject type based on topicmap model

- project, module & resource types based on learning object model

subject:

- a single  thing or idea (as in a dictionary or encyclopedia)

- they are an ontology that represents a specialized listing for this version of DLP

- associated to at least one other subject via specific association types (eg: is-example)

- includes a description/definition (?)

- can have associations with projects, modules & resources (?)

- data     table subject= id,entry

        table relationship= id subject,id relationship,

            1. IS AN ASSOCIATE OF / HAS A MEMBER

            2. DEALS WITH / IS DEALT WITH

            3. INSPIRED (INFLUENCED) BY / INSPIRED (INFLUENCED)

            4. PROCEDURE/ELEMENT

            5. IS AN EXAMPLE OF/IS EXAMPLIFIED BY

            6. CONTAINED IN/CONTAINS

            7. CREATED BY

            8. INCLUDES

            9. IS A KIND OF

            10. IMPLIES

            11. IS A PROPERTY OF

            12. IS A (SUB)GENRE OF

            13. IS AN IMPLEMENTATION OF/IN

            14. IS ANALOGOUS TO

project:

- subjects are autolinked to the database from the project description
    - authors are able to see these links while creating projects as the matched subjects will appear highlighted
    - users are not able to see the links but see relationships via "related menu"
      which shows related projects, modules and resources

- aggregated content for one research initiative (eg: course)

- includes ordered list of links to associated modules, resources, subjects
    ? isnt this happening automatically through the "semantic engine" 
    (the algorythm that manages the associations between subjects and objects based on the topic maps)

- subjects appearing in description are auto-linked to page with a search result against the DLP
data = title, authors, description, content body, icon (attached file)

module:

- aggregated content about one specific area of interest (eg: lesson)

- modules can contain resources and can be contained by projects
- modules can also exist as independent objects

- either use contributor's description or make custom when linking to project, module

- includes ordered list of links to associated modules, resources, subjects
    ? isnt this happening automatically through the "semantic engine" 
    (the algorythm that manages the associations between subjects and objects based on the topic maps)

- subjects appearing in description are auto-linked to page with a search result against the DLP
data = title, authors, description, content body, icon (attached file)

resource:

- a reference to a single piece of media content

?- associated with at least one subject by contributor (in order to be findable)
    - perhaps authours submission is challenged to be sure that the description is descriptive enough to
    match a subject... submit button may not highlight until condition is met.

- includes standard metadata: title, creator, type, date, byline

- either use contributor's description or make custom when linking to project, module

- from a set of acceptable media formats (open standard/cross platform only):

-- text/pdf/jpg/png/qt (uploaded file)

-- text/pdf/jpg/png/qt (url link)

-- url reference (text in database)

-- bibliographic reference (text in database)

USERS

--------------

administrator

- access to all content

- create/modify users

- delete content

contributor

- create/modify any content

- associate other contributors with owned project (they control project)

- existing contributors can invite new contributors

-- they login and go to profile page where they fill in missing data before account activated

registered user

- view all content

- can collect 'my bookmarks' type links

public

- view all content

COMMON NAVIGATION ELEMENTS

--------------

- navigation tools which are not embedded in content

- should all be contained in same area of layout

- all are not present on every page

- navigation must be accessible within a 640 pixel wide window

search:

= (pulldown[hyperlinks on home]: project,module,resource,subject) + (pulldown: title,description,title+description,show all) + (text input: search terms) + (submit: search)

info:

= (pulldown: about,motivation,scenarios,team,glossary,timeline, support,weblog,links,contact) + (submit: go)

login:

= (text input: email) + (text input: password) + (submit: login)

home:

= (button: project logo)

SITE PAGE STRUCTURE

--------------

- types of pages & other pages which are linked from them

home (site intro & central navigation starting point):

-> found projects, modules, resources, or subjects (via search)

-> info (via hyperlinks)

-> manage (via login)

info (static background description pages):

-> home (via site icon)

-> other info (via pulldown)

found (listed result of search for one type of site content):

-> home (via site icon)

-> found projects, modules, resources, or subjects (via search)

-> view (via linked titles in found list)

view (content for a single element; one project, module, resource or subject):

-> home (via site icon)

-> associated content: modules, resources & subjects (via linked titles in lists)

manage (to add, modify and delete site content):

-> profile: modify

-> project    -> create

        -> modify

        -> associate: modules, resources, subjects

        -> delete

-> module -> create

        -> modify

        -> associate: resources, subjects

        -> delete

-> resource -> create

        -> modify

        -> associate: subjects

        -> delete

-> subject -> create

        -> modify

        -> associate: subjects

        -> delete

PAGE LAYOUT & DESIGN

--------------

- simple, understated visual design

- color backgrounds only

- low use of images: only site logo

- design characteristics defined in css

- standard navigation elements grouped together in layout

- background colors can be customized for projects

- consistent layout throughout: same element always in same place

PAGE CONTENT ELEMENTS

--------------

site logo:

- on every page in same location

- easy to see but not overwhelming

page type:

- the kind of page: found, view, info, etc

page title:

- title of actual content of page: name of course, module, resource, or subject

- dynamically generated text

navigation:

- combination of: search, goto or login depending on page

content:

- may contain heading(embedded) & paragraph tags(auto generated)

- contains different content fields depending on page: author, byline, description, content

list:

- zero or more different ones, depending on page

- contains list of titles (linked) & bylines for: projects, modules, resources, or subjects (title only)

copyright:

- at bottom (in footer)

- keep subtle: in small print & low contrast