Welcome Guest to Defaut site!

Todo System Documentation

Note: This documentation is also available in Markdown format.

Overview

The Todo System in Comserv is a comprehensive task management solution that allows users to create, view, edit, and track tasks across different projects. This document provides a complete overview of the Todo System's functionality, components, and recent enhancements.

Key Features

1. Todo Creation

Users can create new todo items with the following information:

2. Multiple Views

The Todo System offers several views to help users manage their tasks effectively:

List View

Day View

Week View

Month View

3. Filtering and Search

The Todo System includes comprehensive filtering options:

Important: By default, the Todo System displays only active todos (with status "new" or "in progress"). Completed todos are filtered out unless explicitly selected using the status filter. This ensures that the main view remains focused on actionable items while still allowing access to completed tasks when needed.

4. Todo Details and Editing

Users can view and edit todo details:

Details View

Edit View

5. Log Integration

The Todo System integrates with the Log System:

Technical Components

Templates

  1. addtodo.tt
    • Form for creating new todo items
    • Includes project selection dropdown
  2. todo.tt
    • Main list view template
    • Includes filtering options and view buttons
    • Displays todos in a tabular format
  3. day.tt
    • Day view template
    • Shows todos for a specific day
  4. week.tt
    • Week view template
    • Shows todos in a calendar-style layout
  5. month.tt
    • Month view template
    • Shows todos in a monthly calendar
  6. details.tt
    • Details view template
    • Shows all information about a todo item
    • Includes form for updating the todo
  7. edit.tt
    • Edit form template
    • Provides a comprehensive form for editing todo items
  8. project_list.tt
    • Reusable template for project selection
    • Used in addtodo.tt, edit.tt, and other templates

Controller Actions

  1. index
    • Main entry point for the Todo System
    • Handles filtering and displays the list view
  2. day
    • Displays the day view
    • Handles navigation between days
  3. week
    • Displays the week view
    • Handles navigation between weeks
  4. month
    • Displays the month view
    • Handles navigation between months
  5. addtodo
    • Displays the form for creating new todo items
  6. create
    • Processes the form submission from addtodo
    • Creates new todo items in the database
  7. details
    • Displays the details view for a specific todo item
  8. edit
    • Displays the edit form for a specific todo item
    • Pre-fills the form with the current todo data
  9. modify
    • Processes the form submission from edit or details
    • Updates todo items in the database

Recent Enhancements

1. Enhanced Navigation in Details and Edit Views

Added comprehensive navigation options to both the details and edit views:

These navigation buttons are displayed at both the top and bottom of the pages, ensuring users can easily return to their preferred view after viewing or editing a todo item.

2. Improved Filtering and Views

Enhanced the filtering and view options:

3. Project Selection and Log Creation

Fixed issues with project selection and log creation:

4. Todo Edit Functionality

Implemented a comprehensive edit functionality:

Usage Guidelines

Creating a New Todo

  1. Navigate to the Todo System by clicking on "Todo" in the main menu
  2. Click on "Add New Todo" button
  3. Fill in the required fields:
    • Site Name (pre-filled)
    • Start Date
    • Project (select from dropdown)
    • Due Date
    • Subject
    • Description
    • Estimated Man Hours
    • Priority
    • Status
  4. Click "Add Todo" to create the todo item

Viewing Todos

  1. Navigate to the Todo System
  2. Use the view buttons to switch between list, day, week, and month views
  3. Use the filter panel to filter todos by time period, project, status, or search terms

Editing a Todo

  1. Find the todo item you want to edit in any of the views
  2. Click the "Edit" button for that todo
  3. Update the fields as needed
  4. Click "Update Todo" to save your changes

Adding a Log Entry for a Todo

  1. Find the todo item you want to log time for
  2. Click the "Add Log" button for that todo
  3. Fill in the log entry form
  4. Click "Submit" to create the log entry

Conclusion

The Todo System in Comserv provides a comprehensive solution for task management. With its multiple views, filtering options, and integration with the Log System, it helps users effectively manage their tasks and track their progress.

Related Documentation