Cards are created for all TODO, FIXME , HACK or anything else comments found in your project that have a list defined in imdone.

Creating cards

5 ways to create a card

1. Click the “Add a card” button on the bottom of a list to open the screen displayed above. (ctrl/cmd+s to save)
2. Press the space bar when you’ve selected a card in the list you want to add a card in.
3. Press shift + space and select a list to add a card in.
4. Add a TODO comment in a project file using your favorite text editor or IDE.

Removing cards

5 ways to remove a card

1. Click the trashcan icon on the card to remove the TODO from the file and its card from the project.
2. Press delete or backspace when you’ve selected a card to remove the TODO from the file and its card from the project.
3. When your project has a filter applied, click the Delete filtered cards link.

• All filtered cards will be removed by removing the TODO comments from your files.

1. Remove the TODO from the file and its card will be removed from the project.
2. Drag the card to an ignored list.

Editing cards

3 ways to edit a card

1. Hover over the in the top right corner of a card to open the card actions menu and then click the “Edit card” link the to open the screen displayed above. (ctrl/cmd+s to save)
2. Select the card you want to edit and press the return/enter key to open the editor displayed above. (ctrl/cmd+s to save)
3. To edit the card in your default editor, click on the file link (or press cmd/ctrl+o) to open the file. Before clicking the link you might want to select your editor in project settings

Edit all cards

1. To edit all cards on the board, click the Open files of all cards link on the main menu or press cmd/ctrl+shift+o. This will open all the cards source files in your default editor.
2. :warning: Warning: If you have a large project and don’t have a filter applied, this could be a lot of files.

Focusing/Viewing Cards

1. Hover over the in the top right corner of a card to open the card actions menu and then click the “View card” link the to open the screen displayed above.
2. Select the card you want to edit and press the v key to open the viewer displayed above.

Moving cards

1. Click on the card background and drag it to a new list and/or position.
2. Select the card you want to move using the arrow keys. Move the card by holding shift and using the arrow keys.
3. When your project has a filter applied, click the Move filtered cards link.
4. Change the list name and/or change the order metadata in the file.

Quick filtering with tags and contexts

To quickly filter your project by tag, context or metadata, click on the green tag, blue context or gray metadata you want to filter by in the card.

Card colors

You can change card colors based on filters added in project settings/card color filters

Card Syntax

Imdone will look for TODOs in all text files in your project folder. Card syntax is an extension of github flavored markdown. The basics of card syntax are provided below.

Only TODOs found in comments are recognized in code files, and they must be in CODE Style.

• Imdone recognizes the extensions referenced here as code files.
• You can add a language to your project by modifying your .imdone/config.yml

Only the HASHTAG and MARKDOWN style are recognized in plain text and markdown files.

CODE Style

// TODO This is a task
// TODO: This is a task
// TODO:5 This is a task
// TODO: A task with a description looks like this. This line is the title.
// Every line after the task is part of the description until we find another
// task, a blank comment line, or a line of code
// - A list item
// - Another list item
//  - [ ] A nested sub-task
// +docs @release

HASHTAG Style

#TODO A task with a description looks like this. This line is the title.
Every line after the title is part of the description until we find another
task, a blank comment line, or a line of code
- A list item
- Another list item
  - [x] A nested sub-task
<!-- order:10 -->

MARKDOWN Style

[A task with a description looks like this. This line is the title.](#TODO:30)
<!-- +tag -->
- A list item
- Another list item
  - [x] A nested sub-task

[This is a task](#TODO:)
<!-- order:10 -->

Tags

Adding tags to your cards is easy. A tag is just a #, followed by word characters (e.g. #feature #r1.2). Tags are displayed at the bottom of your cards in green. When you click on a tag, imdone will filter your project by that tag.

[This is a fake bug](#DOING:20)
#bug #1.4.2 #urgent`

Contexts

Adding contexts to your cards is easy. A tag is just a ‘@’, followed by word characters (e.g. @email @meeting). Contexts are displayed at the bottom of your cards in blue. When you click on a context, imdone will filter your project by that context.

[This is a fake bug](#DOING:30)
- +bug @infra #1.4.2 #urgent

Metadata

You can add metadata to cards for filtering and display. Imdone also uses metadata to modify behavior of a card (e.g. expand:1). Metadata should be in the form key:value or key:"value".

[This is a fake bug](#DOING:40)
<!--
created:01202020
#1.4.2 #ignore
-->

Due dates

Adding due dates and times to your cards is super simple. Just add a sentence that begins with the word “Due” and ends in a period. For example Due tomorrow at 3pm.. When saved, this gets converted to the metadata due:2020-01-20T22:00:00.000Z. Cards with due dates have a yellow or red tag at the bottom with a plain english representation of the due date. The tag is yellow if the due date is in the future and red if the due date is in the past. Use this due date for filtered lists like “What’s Due?”.

markdown file

## DONE :boom: Add due dates using due metadata and natural language processing.

- [chrono-node - npm](https://www.npmjs.com/package/chrono-node)
- [x] example `Due tomorrow at 1PM.`
  - Must start with `due` not case sensitive.
  - regex: `/due\s.*?\./i`
  - [x] Search globally in task.text
- [x] Provide a listing of cards by due date.
  - [x] Use a list that's configured with a filter.
  - [x] Don't allow dragg and drop in filtered list
  - [x] Need to refresh cards to account for time changes
  - [x] On a filtered list there should be a link to filter the project by the list filter.

<!--
completed:2020-02-27T17:13:37.071Z
due:2020-01-21T20:00:00.000Z
expand:1
#1.4.7
-->

Progress Bar

If you have GFM task list items in your cards, imdone will add a progress bar to the top of your card.

String interpolation

Imdone will interpolate javascript expressions in cards when surrounded by double curly braces. e.g. {{ }} or ${}. Default props and extension properties can be used in expressions. Use ${<prop or computed>} for permanent translation in the new card template and {{<prop or computed>}} for display only.

Default props available for string interpolation

Hiding String Interpolation

You can hide lines with {{ }} string interpolation from rendered markdown by wrapping them in <!--[ ]-->.

<!--[ Created: {{(new Date(source.createdTime)).toLocaleString()}} ]-->

This will display in imdone, but not in html rendered from your markdown.

Comments

You can leave a comment in your cards in two ways.

<!--
This is a comment that will appear in html output
-->

%%
This is a comment that will not appear in html output (obsidian flavored)
%%

Expanding Cards

Imdone truncates your cards at seven lines. If a card has been truncated, you can expand it by clicking the expand icon at the bottom of the card. Cards can be expanded by default by adding the expand:true metadata. For example, this will expand by default…

# Keyboard shortcuts
<!-- expand:true -->
| Action                    | Shortcut      |
|---------------------------|---------------|
| Zoom in                   | cmd+shift+[+] |
| Zoom out                  | cmd+[-]       |
| Zoom reset                | cmd+0         |

Markdown support

Use Markdown anywhere in your TODO comments and descriptions to enhance card formatting on your project board.

Markdown Task Lists

Sometimes you need sub-tasks in your cards. Imdone supports github style task lists. Checking a task in your card will update the source with an x. e.g. - [x] sub-task

Highlight text

You can highlight text using ==Highlighted text==

Emoji

Nature

Objects

Places

Symbols