Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.89 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.89 KB
Raw

todo-lists-icon TODOlists v.1.2

TODOlists is a Coda webscript sidebar plugin for managing TODO comments

todo-lists

Installation

  1. Download TODOLists-master.zip.
  2. Unzip it.
  3. Double-click the "TODOlists.codawebscriptsidebar" icon.

TODOLists has been uploaded to the Panic PlugIns page, so you should recieve automatic updates when they are available.

Usage

TODOLists manages comments with the following label types, which are case insensitive:

  • TODO
  • TOFIX
  • FIXME
  • ISSUE
  • BUG
  • NOTE
  • OPTIMIZE
  • XXX
  • HACK
  • DONE

The following types of comment are recognised:

/* TODO lorem ipsum dolor sit amet… */
# TODO lorem ipsum dolor sit amet…
// TODO lorem ipsum dolor sit amet…
<!-- TODO lorem ipsum dolor sit amet -->

Comments can be configured to display the label type (by color and by name), the line number and a specifier (for example, the name of the person responsible for the comment). The specifier can be added in parenthesis directly after the label:

//note(@duncanmid): lorem ipsum dolor sit amet…

When a comment is selected in the sidebar, it's label type can be quickly modified using the mark as… menu. Comments can be filtered by label and by specifier using the label and specifier menus.

The plugin options can be accessed by clicking the gear icon options.

Requirements

Coda 2.5+

License

TODOlists is released under the MIT Licence