Account

Info Module

Introduction

The Info module is designed to hold project information in tree structured lists. It has been designed to be able to be used for:

Software Bug management
New Features management
Todo lists
FAQ lists

The system manages a database of items. Each item has a set of fields that can be modified as wanted as listed in the "Item Edit Fields" section below. Each item can have a set of sub items attached to it. These are used for comments or sub-todo's etc. These sub items share most of the head items fields apart from the state and description fields.

Usage

The main /info page provides a selection box at the top which provides the ability to select the information items to be viewed. and a menu in the left hand menu pane. The following selections can be made.

Category: The category of the information. This could be "bugs", "faq", "todo" etc. Categories can bee added as wanted. Sub categories can be added using a "/" as a separator. If using subcategories, selecting the main name will result in all sub categories being listed.
Completed: The completed state of the entry. Items that have been finished will have the completed flag set.
State: The state of the entry. This could be "infoNeeded", "done" etc. A blank field denotes all states.
Priority: This defines which priority of items to display. All items equal to or higher than this value are displayed. Priority 0 items are by default not listed.
Order: The order of the list of items displayed. The "!" symbol needs the reverse order of this field. All items have a lastUpdate field which is the datetime they were last modified.
Search: Any text here is searched for in the title and description fields

Once these parameters have been modified the "Search" button should be clicked to update the list of item.
Below the Selection box is the list of items selected. This shows up to 50 items. The "Next" and "Prev" buttons will move through the list. The list is ordered as per the selection order.
The left most column has three buttons marked "V", "E" and "D". These buttons perform the following functions:

"V": Views the item.
"E": Edits the item.
"D": Deletes the item.

The title can be clicked to view the item as well. When viewing an item it is possible to add "Sub Items" (perhaps comments or sub todo's) using the "A" button or the "Append to Item" link in the left hand menu. There is also an add item editor at the bottom of the page.
Sub Items can also be added to other Sub Items to form a tree hierarchy of items using its individual "A" button. The "P" button takes you to the parent item.

List	Lists a selection of items
List Formatted	Produces a list in HTML format for inclusion in documents etc.
Add New Item	Adds a top level item
Append to Item	Appends a sub-item to the current item.
Mark item as done	Marks current and all parent items up the tree to the top item to the state "done"
Configuration	Edits configuration parameters
Help	This help information.

Item Edit Fields

id	The unique item id
title	Overal title for item
priority	The priority level from 0 to 5 with 5 being the highest priority.
version	The version of the software this refers to if a bug
versionDone	When completed the version number the fix is included in
manDays	A rough estimation of the work involved.
completed	This item has been completed
state	The state of the item. Bugs generally move through the states: "added,pending,infoNeeded,test,info,duplicate,done"
description	A HTML description of the item.
attachment	This allows a file to be attached to the item. Various file types are supported.
User name	The user who generated this item
Mark all done	When saving mark this and all items above to the state "done" and set completed.
Marl all to state	When saving mark this and all items above to the state as given in the state field and set completed.
Email originator	Email the originator of this item when saving.
Email all	Email all users in the configured Email list when saving.

Emails

When adding or changing an item, an email can be sent to the originator of the item or to all interested users. The "Email originator" tick box emails the originator. and the "Email all" tick box emails all users who's email addresses are in the configured Email list.

Configuration

The configuration menu item in the left hand menu allows the system to be configured. The following parameters can be set:

Category List	This is the list of categories to use in order
Default Category	The default category to list
State List	The list of possible states of an item
Completed State List	The list of possible completed states of an item
Email List	The list of email addresses to send to when the "Email all" option is used.

Software Bugs

When being used to track and manage software bugs the following notes apply.

There will normally bugs and todo categories. Todo is used for new features/changes.
The priority level 0 is for "possible" items and are hidden from view normally as the minimun priority level is 1 by default.
Use sub-items for comments and resolution information. sub-sub-items can be used where useful.