To Do List Global Settings
- Global Settings
- Description Title
- Field Set Title
- Date Format
- Number of items in list shown in user accounts
- Show action buttons
- Go To Action on Mark Finished
- Show actions on the side
- Show info after description
- Auto-change "Started" to "In Progress"
- Reminder events
- Number of days before unpublishing
- Number of days before deleting
- Delete any To do item
Global Settings
Global settings are found under Administer » Site configuration » To do list (admin/settings/to_do).
Only To Do List administrators can edit the Global Settings.
Description Title
The default To Do items theme outputs a field set with a statically defined title. This title is set to "Details" by default. This option let you change the default to better fit your website.
Field Set Title
By default, To Do items are displayed inside an HTML fieldset tag. That field set has a name that you can change here. The default is To Do Listing.
You may also clear the title completely (leave blank) to remove the field set altogether.
When a field set title is defined, it is shown on the To Do pages and in teasers. When looking at the teaser, the field set will be collapsed if the priority is Medium or Low.
Date Format
Format used to display dates. At this point the module only accepts dates as parameter and thus the format does not include time.
The date format uses the usual PHP date() function. which accepts many different letters to display the day, month and year.
In most cases, you will want to use d or j for the day, m or n for the month and Y or y for the year. The default is set to: Y/n/j which is often used in technical documentations and in Japan.
The usual US format is: n/j/Y
The usual European format is: j/n/Y
Number of items in list shown in user accounts
When a user goes to his account, he can see lists of To Do items. This value represents the number of items to display per page.
Note: This field will probably get moved to the user account Edit area instead, so that each user can have his own count.
Show action buttons
Whether or not the action buttons should be shown to the users. By default they are shown when the user has permission to see the button.
At this point, the available buttons are Mark Started and Mark Finished.
Show actions in the top-right corner instead of the bottom of the To Do information area.
Go To Action on Mark Finished
Description
By default, when the user clicks on Mark Finished, the To do item is marked finished and reloaded.
It is now possible to send the user to another page by entering one or more of the following action names separated by commas:
- first
- last
- next
- previous
- list
- front
- /path/to/destination
first
Send the user to his first To do item not yet marked finished and not canceled.
last
Send the user to his last To do item not yet marked finished and not canceled.
next
Send the user to the To do item following the item that was just marked as finished. The new item is not marked finished or canceled.
previous
Send the user to the To do item preceding the item that was just marked as finished. The new item is not marked finished or canceled.
list (Terminal except for anonymous users)
Send the user to his To do list (/user/%/to_do). This is the same as clicking on the hand in the To do block. If this is the anonymous user, do nothing.
front (Terminal)
Send the user to the front page of the website.
/path/to/destination (Terminal)
Enter a path to a page on your website. The path must start with a slash. For instance, you could have a view with a list of To do item named /to-do-view or a page letting people that they are done, /youre-done (in which case you probably want to first send them to their next or previous page!)
IMPORTANT NOTE
The path cannot include a space since those are removed when this entry is used. If you have a path with a space, use %20 instead.
Examples
There are quite many possibilities. The default is empty, which means that nothing happens (like before.)
The following are a few samples that we expect you'd want to use:
- next, previous, front
- previous, next, list, front
- next, previous, list, /to-do-view
- first, front
- last, list, /to-do-view
- next, previous, /youre-done
We assume that you have valid /to-do-view or /your-done pages in the examples showing those paths.
Show actions on the side
By default, actions are shown under the To Do item details.
This flag let you move them to the top-right corner. It saves some space and shows them close to the top when the task information are shown before the detailed description.
This feature expects the theme to be wide enough to support the actions on the right without having them pushed down below the details.
Show info after description
Show the To Do item information after the Detailed Description (assignment details.) By default, this option is set as it was like this in previous versions. It is also very similar to the CCK fields.
Auto-change "Started" to "In Progress"
By default, items are marked Not Started.
Once starting, you go to the To Do item and click on the action button Mark Started. At that point, the system sends an event to the other modules to let them know that the assigned users started to work on the task.
Whenever you edit a To Do item marked Started, the started event is regenerated at the time you save the item.
To avoid this problem, you have a state named In Progress. That specific status does not generate any event. Thus, if you edit an item currently marked Started, the system can automatically change the state in the form for you. This flag is used for that purpose, to change the state from Started to In Progress.
Reminder events
You can enter a number of days when a reminder for an existing To Do item should be sent. The reminders are sent except for To Do items that have their status set to Finished or Canceled.
The number of days is counted backward from the deadline. If there is no deadline, no reminders will be sent.
The system automatically orders the reminders appropriately so you can define them in any order.
Note that reminders uses the System Actions system. Thus, to make use of this feature, you must install the To Do Action module. The settings may get moved to the action sub-module, although it will be useful for Rules as well.
Number of days before unpublishing
Once a To Do item was marked Finished, you may want to have it automatically unpublished within a few days so it disapears from most of your To Do lists.
This is done by setting this value to zero or a positive number. This represents the number of days that are required before the node status is set to unpublished. Note that setting the number of days to zero will, in effect, immediately unpublish a node that was set to the Finished state.
Leave the input empty to avoid this feature altogether. This is the default.
IMPORTANT NOTE
Zero (0) and an empty input are two different things.
Zero means unpublish as soon as the node is marked as Finished.
An empty input means never auto-unpublish any To Do item.
Number of days before deleting
Once a To Do item was marked Finished or Canceled, it can automatically get fully removed from your system. This option is here just for that purpose.
Note that if you entered a number of days in the auto-unpublish field, then the number of days before the auto-delete happens must be larger. Otherwise, the auto-delete can be set to 1 or more.
Leave the input empty to avoid this feature altogether. This is the default.
NOTES
This is a really neat feature especially if you also have a database backup system available on your system. In other words, you'd still have the data available in your backups, but you'd trim your database as you move forward.
Delete any To do item
As a protection, the auto-delete feature will only delete unpublished To Do items.
When checking this option, the auto-delete feature ignores the current status of the node and deletes nodes whether or not they first were unpublished.
Note that this flag won't have much effect if you use the auto-unpublish.