Skip to content

Issue #20 - description of todo.txt format in plain text #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clach04 merged 1 commit into from
Dec 1, 2024
Merged

Issue #20 - description of todo.txt format in plain text #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions The-Todo.txt-Format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,22 @@ This is all possible inside `todo.txt`.

<img align="right" src="./todo.txt_summary.svg" alt="Format Quick Reference Image">

```
┌───────────────────────────────── Optional - Marks completion
│ ┌────────────────────────────── Optional - Marks priority
│ │ ┌─────────────────────── Optional - Completion date
│ │ │ ┌──────────── Optional - Creation date
│ │ │ │ (must be specified if completion date is)
│ │ │ │ ┌─── Mandatory - Description
│ │ │ │ │ Tags (optional) can be placed anywhere within it
│ ┌┴┐ ┌───┴────┐ ┌───┴────┐ ┌─┴────────────────────────────────────────────────────┐
x (A) 2016-05-20 2016-04-30 measure space for +chapelShelving @chapel due:2016-05-30
└──────┬──────┘ └──┬──┘ └──────┬─────┘
project tag ──────┘ │ │
context tag ──────────────────┘ │
special key-value tag ────────────────────┘
```

Your `todo.txt` is a plain text file. To take advantage of structured
task metadata like priority, projects, context, creation, and completion
date, there are a few simple but flexible file format rules.
Expand Down