revUp - Updates and news for the Revolution community
Issue 137 | August 3rd 2012 Contact the Editor | How to Contribute

New Coding Plugin: lcTaskList
lcTasklist joins the Marketplace. Smoothing the path of programmers everywhere by keeping track of all your coding tasks.

by Bill Vlahos

Have you ever forgotten where you last left off in your scripts? Need a better way to manage the code you need to write, or code that needs fixing, or maybe make a quick note of a future feature?

Now there is an easy standardized way of doing all these things with the help of the simple to use Task List plug-in! This plug-in will help to create and manage a list of programming tasks by simply imbedding tasks into your script's comments.

tasklists
Zoom

Click on any entry in the Task List to immediately take you to that line of code in the Script Editor.

Code example

How it Works

Add specific comments in your scripts and this plugin will automatically index, display, and link to them in the Script Editor - just click!

The lcTaskList plugin has common standardized root terms set by default but the list is fully editable (add or delete) to suit your needs.

This method for setting tasks is available in a number of other progarmming languages but is particularly useful in LiveCode where scripts can be anywhere. See this Wikipedia entry for wider context.

How to Use lcTaskList

  1. Add comments to your code just like always but start the comment with one of the commented terms (see example below).
  2. Open lcTaskList plugin
  3. Click on line to edit script or right-click to open card or stack

That's it!

You can use any of the standard LiveCode comment formats (--, #, //) except /*.

on mouseUp
   --MARK Here is where I left off
   put the date into vVar --FIXME Dates do not appear correctly
end mouseUp

Library of commonly used index words

The default included terms and common definitions for them are (CASE SENSITIVE):

  • MARK to mark the script you are actively working on so it is easy to go back to it
  • TODO to indicate planned enhancements.
  • FIXME to mark potential problematic code.
  • NOTE to document significant sections of your code.
  • REVIEW to review before release

Other commonly used terms that are not on by default but you can add are:

  • HACK to mark code that works but should be improved
  • BUG to mark known bugs
  • XXX to warn of problematic or misguiding code.
  • ??? indicates there is an unknown problem that needs to be solved
  • !!! signifies a very important task that needs to be dealt with ASAP

Fully customizable preferences

  • Add your own word(s): Double click the Library field to edit the list.
  • Change color stripes, font size, and set transparency
  • Automatically index and hide
  • Index just open stacks or all stacks in memory (openStacks vs mainStacks)
  • Edit list of excluded stacks from indexing
  • More

This handy little headache cure and workflow smoother is now available in the LiveCode Marketplace for the extremely modest fee of $10. Save hassle, notepaper, pixels and headache pills by picking up your copy now!

Bill Vlahos

About the Author

Bill Vlahos is is a longtime LiveCoder and the power behind Infowallet.

Main Menu

What's New


Get Your RunRevLive.13 Ticket Today