ToDoList Documentation

Download Zipped documentation file - 38.8 KB

Introduction to bpsToDoListDocumentation

Here is documentation for AbstractSpoon's ToDoList which can be opened within ToDoList itself.

Note: Starting with version 5 of ToDoList, .dan.g is distributing a version of this help file with the executable.

Information to build this file was taken from:

Source code resource files from version 4.x.
Observation of versions 4.10 and 5.0 Beta.
The pbwiki referenced in the documentation.

It is recommended that you do not use the Sort functions on this file. An attempt has been made to keep the menus and preferences in order as shown in the ToDoList Graphical User Interface.

I also have posted a sample XSL Transform for ToDoList which can be viewed on CodeProject.com.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Brad Sherwood

United States

No Biography provided

Article Top

Poor

Excellent

Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

You must Sign In to use this message board.

Search this forum
	Profile popups Spacing Noise Layout Per page

Thanks so much Brad,

This is something that I've been wanting to do for ages. I've also wanted to make a 'How To...' section.

Would it be okay for me to include this file with the ToDoList download? I'm happy to be reponsible for updating the file via this page.

Ideas that spring to mind include extending ToDoList to open tasklists stored on the internet and then hosting this file remotely.

ps. you can make links between help items using the 'tdl://<ID>' syntax from within the comments. I know it's not very neat but it should work.

.dan.g.

AbstractSpoon Software
abstractspoon2_at_optusnet_dot_com_dot_au

Thank you for the kind words Dan.

I'll help however I can. As I learn the features of ToDoList I'm happy to contribute by jotting them down.

I had already added a few tdl:// links but only through the FileRef field. Thanks for the comments field tip.

Yes you may use this file any way you like. While it's just a start, I felt a bit inspired by the possibilities.

I would personally like to see the Help menu / key bring up a "local" file such as this one. Maybe that's something that could be put into version 5.

If you're interested in adopting this "help file" technique, Perhaps the Help Menu could be:

--------------------------
ToDoList Help F1
Show Keyboard Map
--------------------------
ToDoList Online
ToDoList Wiki
ToDoList License
--------------------------
Feedback and Support
Contact Us
--------------------------
Check For Updates
--------------------------
About ToDoList
--------------------------

Some of the above may be redundant with the current online footprint.

Tools > Check for Updates and Help > Check for Updates could update the help file as well as ToDoList itself.

Brad Sherwood

Just to confirm. Correct as necessary.

Brad Sherwood wrote:
ToDoList Help F1

This new Help file.

Brad Sherwood wrote:
Show Keyboard Map

The keyboard shortcuts page in the preferences, or a cutdown version showing only the currently assigned shortcuts (easy to generate dynamically)?

Brad Sherwood wrote:
ToDoList Online

CodeProject article or ToDoList resources page?

Brad Sherwood wrote:
ToDoList Wiki

As-is.

Brad Sherwood wrote:
ToDoList License

As-is.

Brad Sherwood wrote:
Feedback and Support

CodeProject article or appropriately addressed email?

Brad Sherwood wrote:
Contact Us

Appropriately addressed email?

Brad Sherwood wrote:
Check For Updates

Moved from Tools.

Brad Sherwood wrote:
About ToDoList

As-is.

.dan.g.

AbstractSpoon Software
abstractspoon2_at_optusnet_dot_com_dot_au

Help F1 - Yes the new TDL file. FYI... I would like to copy the FAQ into here. Add How-To, and all other info which would make it searchable from within one place... and a place which is available to a laptop which is not connected to the internet.

Keyboard map (perhaps a pop-up large text box with "Copy To Clipboard" and "OK") showing only the assigned keys (those which show in preferences) and maybe showing the keys which you've "hardcoded" into the app. but are not visible or well known (ex: Alt-B moves focus from comments field to the Task List).

ToDoList Online - I would think the resources page.
Perhaps someday the mission of the CodeProject page would be for the "programmers" who want to learn from your "article" and the source code.
The "Resources" page would be for the User Community who want to utilize the program but who are not interested in the development technique. It might focus on add-ins, 3rd party tools, etc.

Wiki - yes http://abstractspoon.pbwiki.com/

License - Perhaps http://creativecommons.org/licenses/by-sa/2.5/ rather than the current pop-up

Feedback & Support - today... my thoughts are the "bottom" of the Code Project page. Maybe someday it would go to a "discussion board" / "bulletin board" or something like what http://www.phpbb.com/ provides

Contact Us... a MailTo link (if you want that... you may not) or a link to a web page which allows a user to fill out a form and submit to AbstractSpoon... this is probably not in your immediate future. But I put it there to establish an idea.

Check for Updates - Redundant with existing location. The Help menu is another common place for users to look for this feature.

About - as is.

Brad Sherwood

Thanks Brad, I'll implement as many of these as possible for the 5.0 release. .dan.g. AbstractSpoon Software abstractspoon2_at_optusnet_dot_com_dot_au
Sign In·Permalink