Project Manager

Home
Online demo
Features
Help
   Documentation
Design docs:
   Technical
   Interface spec
Downloads
Sourceforge
   Forums
   Mailing lists
   Bugs
   Tasks
   CVS
Contact

SourceForge Logo

Project Manager interface specification


introduction and format

This is the Project Manager interface specification. The interface specification defines everything that the user can do, and is a guide for the implementation of the functions. There are two parts: the files and pages, and the pages. The first part is a list of the files used and the pages each file can display, and the second part contains descriptions of each page.

As this is the initial version of the specification and we want to get a working version ready, it doesn't have all the features we want or need. In the second part, some pages will have possible future features listed, in this form:

part 1: files and pages

The interface uses 3 files and 16 'pages'. The files are:

  • index.html
  • db.html
  • admin.html

    and the 'pages' (the different views that the user can see) are:

    index.html

  • main view
  • node view
  • create node
  • edit node
  • add link
  • add file

    db.html

  • table listing
  • table search
  • create table
  • edit table
  • delete table

    admin.html

  • project admin
  • edit user
  • add user
  • user edit
  • user info
  • delete user

    part 2: the pages

    *** Suggested feature: add user permission check :
    Check if the user is allowed to view/create/edit/admin something.

    [ main view ]

    This is the main tree view, that shows the departments of the project as a tree view. Each node here can contain other nodes, and each node has a button beside it that will open or close it, to display or hide the children. Beside the button is a link with the node's name that will display the node view.

    [ node view ]

    Each node can have objects attached to it. So far, the objects available are database tables, links, and files. Each object will be displayed on one line, with the object name linking to the object (for tables and files) or to the target (for links). Under that will be a list of options (edit and delete) and a short description will be on the third line (these should be limited to a small paragraph).

    *** Suggested feature: have object summary :

    This would show object summary (like the number of items in a table, for example) below the object, or even (for tables) show one or two object of high priority to the current user, with links to the table entry page.

    *** Suggested feature: move objects :

    Have a link to send the object to another node

    [ create node ]

    Create node can be called from any tree or node view. If called from a tree view, it will create a level 0 node. If called from a node view, it will create a node as a child of the current node. When the create node link is first clicked, it will go to a page where the user can enter all the information (node name, node description), and then submit it to create the node.

    [ edit node ]

    The user can edit any node's information if they have permission. This page will display the node's currrent name and description, and the user can edit the information and then submit it.

    [ add link ]

    This page can be called from any node page. It will have a form to enter the link name, URL, and description. When the information is submitted, the link will be added to the current node.

    [ add file ]

    This page can be called from any node page. It will have a form to enter the file name, description, and path to upload the file. When it is submitted, the file will be uploaded and a link to download it will be added to the node page.

    [ db listing ]

    This will display a sorted list of all table entries. The number of table entries to display per page will be set in settings.php, and there will be previous and next links to see more entries. At the top of the listing, there will be a link to add search requirements (filter the table).

    When there are search requirements defined, they will be listed before the table entries (for example: "name contains 'tst', ID > 500, parents > 'asdf')

    [ db search ]

    This will display a sorted list of filtered table entries. On the initial page, the user can enter the search requirements, and then it will go to the db listing page, to list the search results. There will be a link at the top of the listing to add a search requirement, which will go back to the db search page.

    This page can be called from the table list in a node view or from the db listing page.

    [ create db ]

    The page will have a form where the user can enter the table information (name, description) and the fields. The fields are entered one at a time in another form at the bottom of the page. When the field information is submitted, that field is added to the field list and the page is reloaded.

    When the user has entered the table information, they can submit it to create the table. This page can be called from any node page, and will create the table in that node.

    The allowed field types are drop-down list, short edit field (40 chars max), long edit field (unlimited-length one-line edit field), text area, and comment area.

    [ edit db ]

    This page will edit the information for a table. It will have two parts: the table information and the table fields. They will both show the current information, and the information will be changed when it is submitted. In the fields section, fields can be deleted or edited (they will be deleted by a link beside the field information. When the edit link is used, the page will be reloaded with a field entry form under the list of fields, where the user can edit the field information and submit it). Under the field list, there will be a form to enter information for a new field and add it to the table.

    [ delete db ]

    When the user click on the delete table link, they will go to this page, where they will be asked to confirm the deletion. >From this page, they can delete the table or cancel and go back to where they were before.

    [ project admin ]

    This page will display the project information, and the project administrator(s) can edit and submit the information. It will list users and have links to add, edit, and delete users.

    This page is only available to the project administrator(s).

    [ edit user ]

    This page will show a user's information, and the project administrator(s) can edit and submit the information.

    The user information is name, username, password, access, email, and ICQ. The administrator(s) can set the user's password, but not see the current password.

    This page is only available to the project administrator(s).

    *** Suggested feature: user access edit :

    The user access will be a list of nodes and the permissions for those node (when the user has permission for one node, they have that permission for all the nodes under it, but if one of the nodes under that node sets different access permissions, the new permissions are used for that section of the tree.

    [ add user ]

    This page will have a form to enter user information. When the information is submitted, the user will be created, and the project admin page will be displayed.

    The user information is name, username, password, access, email, and ICQ.

    This page is only available to the project administrator(s).

    *** Suggested feature: user access edit :

    see [ edit user ].

    [ user edit ]

    This page is available to all users. It will have a form to display the current user's information, and the user can edit this information and submit it.

    The user information is name, username, password, email, and ICQ.

    [ user info ]

    This page will display the name, username, email and ICQ for a user.

    [ delete user ]

    When the "delete user" link is clicked in the [ project admin ] page (there is one link for each user, so the admin doesn't have to select a user), it will go to this page, where they can confirm or cancel the user's deletion.


    ChangeLog

  • version 0.3 December 12, 2000 - Richard Garand (krogoth2@softhome.net)
    Changed 'database' to 'table' and updated main view and node view
  • version 0.2 December 10, 2000 - Kenzaburo Ito (prescience@300baud.org)
    Converted text to HTML. Added tags and links
  • version 0.1 December 10, 2000 - Richard Garand (krogoth2@softhome.net)
    Initial submission






    FastCounter by bCentral