joplin-plugin-inline-todo

Inline TODOs

A plugin that allows you to manage your TODOs anywhere in your notes and view a summary in one place.

This plugin was initially written before the plugin system and interacted with Joplin through the API. I've been using it like that for the last few years. I finally took the time to translate it for the official Plugin system. Its implementation is pretty specific to my workflow and I don't plan to update it much, as it works for me.

The basic function of this plugin is to have a single note where you can view all your inline TODOs. This single note is identified by containing the following special comment <!-- inline-todo-plugin -->. This comment can be inserted by pressing Tools -> Create TODO summary note. Be careful not to place this in an existing note as the plugin will overwrite everything.

Installation

• Go to Tools -> Options -> Plugins(macOS: Joplin -> Preferences -> Plugins)
• Search for "Inline TODO" in the search box
• Click Install and restart Joplin
• Create a Todo Summary in your folder of choice (Tools -> Create TODO Summary Note)

Or

• Download the plugin jpl
• Go to Tools -> Options -> Plugins
• Click on the gear icon and select "Install from file"
• Select the downloaded jpl file
• Restart Joplin
• Create a Todo Summary in your folder of choice (Tools -> Create TODO Summary Note)

Configuration

TODO Types

Confluence Style

Inspired by this post on the Joplin forum. This is the preferred style because it uses the markdown checkbox format (making it trivial to check the box and hide the TODO from the summary).

The basic form is a checkbox, followed any (or all) of: @assignee (this is a primary filtering field, so there can only be one), //date, +tags, and finally the TODO content.

I take a lot of notes about various things. It can be helpful to
keep my TODOs together with the content they pertain to.

- [ ] @TODO Think about how to make a plugin to solve this +joplin

This way the TODO benefits from context.

- [ ] @TODO +joplin //2022-04-04 Release the TODO plugin!

I'd still like a way to view all these! See below.

Link Style

This is a simple TODO style that I've been using for the last few years. It intentionally uses the markdown link syntax which gives it highlighting in the editor and the viewer. This format can accept a wider variety of date formats.

The basic form is a link, where the name is "TODO" and the date replaces the URL section. The TODO content just follows after.

I take a lot of notes about various things. It can be helpful to
keep my TODOs together with the content they pertain to.

[TODO]() Think about how to make a plugin to solve this

This way the TODO benefits from context.

[TODO](2022-04-04) Release the TODO plugin!

I'd still like a way to view all these! See below.

List Style

This style just uses markdown checklist items. What sets this apart from the Confluence style is the lack of support for categories and dates in this style. This style was created for users that are already happy using plain checklists for their tasks, but want an additional place to collect them. For most users, I recommend the Confluence style instead.

I take a lot of notes about various things. It can be helpful to
keep my TODOs together with the content they pertain to.

- [ ] Think about how to make a plugin to solve this

This way the TODO benefits from context.

- [ ] Release the TODO plugin!

I'd still like a way to view all these! See below.

Summary Types

There are two supported summary styles.

Plain

This is the basic style that I created for myself, and have been using for the last few years.

It starts by showing all the TODOs that have dates under the DUE section (sorted by date). After that, all the other TODOs are shown in no specific order under their respective category and parent notebook.

This style is meant for personal use, the table method (below) is recommended for more complex use.

# DUE
- [Note a](:/e710b7af31fc47c89ca5fc4d3c0ecb3a): 2022-01-13 Have some me time

- [Note b](:/beef7ed6d91649149751cea8d14af02d): 2022-03-12 Meat delivery +burgers

# Bob
## Folder 2
- [Note c](:/ef3aac56ffa246baa6a96cc94dd8f25e): Call Teddy +repairs

# Linda
## Folder 1
- [Note b](:/beef7ed6d91649149751cea8d14af02d): I'll get to this eventually

Table

This is particularly powerful when combined with hieuthi's table sorting plugin. (warning: if you use the "apply sorting" feature, the sort will be overwritten when a new summary is written, don't rely on it!)

| Task | Assignee | Due | Tags | Notebook | Note |
| ---- | -------- | --- | ---- | -------- | ---- |
| Have some me time | Linda | 2022-01-13 |  | Folder 3 | [Note a](:/e710b7af31fc47c89ca5fc4d3c0ecb3a)
| Call Teddy | Bob |  | repairs | Folder 2 | [Note c](:/ef3aac56ffa246baa6a96cc94dd8f25e)
| I'll get to this eventually | Linda |  |  | Folder 1 | [Note b](:/beef7ed6d91649149751cea8d14af02d)
| Meat delivery | Bob | 2022-03-12 | burgers | Folder 1 | [Note b](:/beef7ed6d91649149751cea8d14af02d)

Filtering

Todos can be filtered such that the plugin will only display Todos from specific notebooks. This can be done by adding notebook names inside the special comment. Notebooks that have a space in their name must be quoted. For example, to limit a search to only "Work" and "Special Project" notebooks, replace the default special comment with.

<!-- inline-todo-plugin Work "Special Project" -->

Roadmap

I consider this plugin to be finished (it meets my needs). But below are some ideas that I will implement in the future if I have some time.

Ideas

• Add in support for spaces in the assignee field of the confluence style. This will allow for assignees like @"Caleb John"
• Add in the fuzzy date handling (e.g. mid april)
• Add a renderer component that adds html ids (so we can scroll to TODOs)
• Add support for the Metis plugin (todo.txt)
• xit format