ToDo Cx v1.1.0
Charles Koch - August 29, 2017
Overview
ToDo CX is a simple to-do list web app with a focus on speed, efficiency, and usability. ToDo CX is a single-user app. As such, there are no users. All items enetered in ToDo CX are publicly visible to anyone who can access the URL.
Installation
ToDo CX is a Django web application. As such, it requires Django 1.9 or higher and follows the standard Django app installation:
- Place the todocx directory where your Django apps are stored
- Edit the settings.py and add todocx.apps.TodoCXConfig to the INSTALLED_APPS
- Migrate the models to your database via the migrate command of the manage.py script
- Collect the static files to your static root via the collectstatic command of the manage.py script
- Restart your Django server to populate the default settings
System Settings
ToDo CX has several system settings which can be adjusted to your preference. Click the System Settings button in the upper-right corner to view and edit these sttings. To return to the Main screen, click the ToDo CX logo in the upper-left corner.
| Purge Routine | Adjust the number of days before old items will be deleted from the database. An item's age is calculated from the last time it was updated |
| Update Definitions | Adjust the colors and timeframes that items will change as they age |
| Status Colors | Adjust the colors associated with the different status types |
| Priority Colors | Adjust the colors associated with High, Medium, and Low priority items |
Main Screen
The Main Screen displays all of the items in ToDo CX. Click the ToDo CX logo in the upper-left coner to return to the Main screen at any time. ToDO CX provides several fields that contain information about the items you hav eentered:
| Customer | For Work items, this is ususally a company name that the item is to be completed for. For Personal items, this field should always say Personal |
| Title | A breif description to identify the item |
| Last Update | The most recent detail about this item |
| Priority | The importance assigned to this item (High, Medium, or Low) |
| Created | The date this item was added to ToDo CX |
| Updated | The date the most recent update was added to ToDo CX. This changes color the longer the item goes without an update |
| Contact | The main person who should be contacted for any matters pertaining to this item |
| Status | The current status of the item |
Filtering Items
In the menu bar at the top, you can filter items based on their status or type. There are 2 types of items: Work and Personal. Personal items have the word Personal entered as the Customer. Any other items will be placed in the Work type. There are also 4 status types: Open, In Progress, On Hold, and Closed. Click the check boxes to show or hide items. The Work/Personal filters and the status filters are applied together, so if Work and In Progress are checked, then only items that are both Work and In Progress will show.
Sorting Items
The headings of the table can be clicked to sort items in ascending or descending order. Clicking the column header once sorts acsending and clicking the same header a second time sorts it descending.
Adding Items
In the upper-left corner, next to the ToDo CX logo, click the New Item button. This will take you to the Edit screen, where you can fill in all teh details of the item.
Editing Items
ToDo CX utilizes a Cerrax framework known as LiveEdit, which speeds up web applications by transmitting user input as soon as they finish entering it. Any changes you make will be saved immediately. Navigating to another page doesn't lose your data, or pester you with an annoying textbox warning about unsaved changes.
Adding an Update
One of the most common tasks in ToDo CX is to update an item. When you update an item, you are adding new details to it, such as accomplishing part of a task or commenting on a change that has occurred.
To add an update, simply click the Last Update cell of the item row. This will open a dialog box where you can enter your update.
| NOTE: | Updates are limited to 255 characters. If the update is very long, consider breaking it up into smaller parts and doing several updates in a row. |
When you add an update, the Updated column will change to reflect that this item has been updated.
Changing the Status or Priority
To change the status or priority of an item, click the cell and a dialog box will appear with the appropriate selections.
Changing the Customer, Title, or Contact
To change the customer, title, or contact of an item, click the cell. This will take you to the Edit screen, where you can veiw further details and edit all of the fields of the item.
Edit Screen
The Edit Screen provides the full history of the item, as well as the ability to edit all of the fields and updates. To return to the Main screen once you have finished editing an item, click the ToDo CX logo in the upper-left corner.
Editing Fields
Clicking on any of the fields on the screen allows you to edit that field. Changes made to these fields do not change the Updated value of the item. Only by adding an update will this value change.
| NOTE: | Editing the history (on the right side of the screen) does not keep track of changes made to it. Editing existing updates should never be done except to correct errors in the update itself. Any new information or changes to the item should be indicated by adding a new update. |
Adding an Update
Clicking on the textbox at the bottom of the left side of the screen allows you to enter the text for an update. Then click the Add Update button to add it to the item. When you first create an item, you must enter at least 1 update before you leave the screen, or the item will not be saved.
Deleting an Item
In the upper-left coner, next to the ToDo CX logo is the Remove Item button. Clicking this will delete the item and all updates permanently.
| NOTE: | Once an item is deleted, there is no way to recover it. This deletion is permanent. |
Generated 01:12PM 05 Mar 2018Documentation generated by Ketchup v1.5.1Developed by Charles Koch - 2017