Skip to content

Available todo.txt attributes and extensions

ransome edited this page Mar 16, 2024 · 10 revisions

Priority

To give essential tasks the prominence they deserve on your to-do list, just add a (A) at the start of the task. Remember that while (A) is one option, you can choose any letter from A to Z. However, only priorities A to C will display with a colored bar alongside them, while all other priorities will feature a neutral gray bar.

Contexts and projects

When dealing with projects that consist of multiple tasks, you can designate these tasks by adding a + sign followed by the project's name. Contexts, on the other hand, define the specific situations in which a particular task is relevant to you. Drawing inspiration from David Allen's Getting Things Done concept, contexts could be locations like home, work, shopping, or activities involving specific individuals or devices.

To incorporate a context, simply attach a @ symbol followed by the context's name. For further details on todo.txt, you can refer to this link.

Keep in mind that both projects and contexts should be written as single words without spaces. You have the flexibility to add as many projects and contexts as you need.

Dates

Due dates

Todos that have due dates will be prioritized higher on your list. As the due date approaches, they will ascend in the sorting order.

If the due date is set for today or a date in the past, it will be highlighted in red and remain at the top of your list. To incorporate a due date, simply append 'due:' followed by the desired date format (e.g., due:2021-03-07). Alternatively, you can use the date picker, which will handle the formatting for you.

Creation dates

When activated in sleeks settings, start dates will be appended to your todos, setting those equal to the creation dates by default. Should you wish to modify it, locate the first date in your todo, typically positioned just after the priority tag.

Completion dates

Upon marking a task as complete in sleek, it will automatically add the completion date, which corresponds to the day it was completed. If the task didn't already have a creation date, sleek will assign today's date as the creation date during the completion process. To illustrate this, consider a todo such as This todo will be marked as complete. After marking it as complete on 2023-09-26, it will be transformed into: x 2023-09-26 2023-09-26 This todo will be marked as complete. Another example: Marking 2023-09-01 This todo will be marked as complete as complete will create x 2023-09-26 2023-09-01 This todo will be marked as complete.

Threshold dates

https://github.com/ransome1/sleek/wiki/Deferred-todos-(t:)

Friendly/speaking date names

User-friendly date descriptions, such as tomorrow, next Tuesday, or end of February, will be transformed into correctly formatted dates. This works for threshold dates t:in one week and due dates due:tomorrow. The conversion can be deactivated in settings. You can refer to a comprehensive list of available friendly date options.

Recurrences

If you wish to create a recurring todo, you must define the recurrence interval using the rec: attribute, such as rec:d for daily recurrence. In the sleek user interface, you can easily set the rec: attribute using provided controls, or alternatively, manually include it in the todo text. Available values include d (daily), b (business days), w (weekly), m (monthly), and y (annually). You can also specify a custom interval, like rec:3m for every 3 months. Explore further details on recurring todos in sleek here.

Pomodoro timer

Currently, there isn't an actual function linked to this. Pomodoro intervals will be parsed and visualized solely to ensure compatibility with other tools.

The Pomodoro Technique is a time management strategy that enhances productivity by dividing work into concentrated sessions, usually lasting 25 minutes each, referred to as Pomodoros, followed by brief 5-minute pauses. You choose a task, set a timer, and fully engage in it until the timer signals a break. In sleek, you can track the Pomodoros dedicated to a specific task using the pm: extension. For instance, pm:4 signifies that you've already completed four 25-minute intervals on this particular todo.