Task Note

Summary

Task notes are a special type of note that represent a task.

Use Case

Plain Tasks can be written in one line using the Markdown syntax - [ ] some text.

If a task's scope goes beyond what you can describe in a single line of text, task notes could help you organize extra information about it.

Task notes are same as regular notes, except that they contain some special keys in their frontmatter. These keys are inserted by default when you use the toggle or the command, but you can also add them yourself.

To learn more about task management using task notes, check out Task Notes

Getting Started

Creating a task note

There are 2 ways to create a task note, you can either use the toggle in your regular lookup bar, or you can use the Create Task Note command. They both achieve the same result, although the task create command comes with some default settings.

A screenshot displaying an open note that lists 3 tasks, each showing off different features of task notes. On the top right of the image is a lookup bar with the task toggle selected.

Task notes are same as regular notes, except that they contain some special keys in their frontmatter. These keys are inserted by default when you use the toggle or the command, but you can also add them yourself.

Whenever you link to a task note, these keys will display the status of that task: this works in the editor, preview, and published sites. You can disable the status view in preview and publishing by setting enableTaskNotes.

Setting task status / Marking a task as complete

You can use the Set Task Status and Complete Task commands to change the status of a task, or to mark it as complete. Alternatively, you can also manually edit the frontmatter to change the status to anything you want.

Keyboard shortcut for a task status

You can create a keyboard shortcut that sets the task to a specific status.

To do so, use the Preferences: Open Keyboard Shortcuts (JSON) command to open the shortcuts file. In this file, add a section so the file will look like the following:

[
  // ... other keybindings
  {
    "key": "ctrl+shift+t y", // or any other shortcut you want to use
    "command": "dendron.setTaskStatus",
    "when": "editorFocus && dendron:pluginActive",
    "args": {
      "setStatus": "y" // the status you want to set
    }
  }
]


Backlinks