Skip to content
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.

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

List of "Special tag / Additional Definitions" #8

Open
heX16 opened this issue Sep 7, 2017 · 17 comments
Open

List of "Special tag / Additional Definitions" #8

heX16 opened this issue Sep 7, 2017 · 17 comments
Labels

Comments

@heX16
Copy link

heX16 commented Sep 7, 2017

https://github.com/todotxt/todotxt#additional-file-format-definitions

due:2017-01-01
hide:1

Where can I find the full list? (And add to it)

@karbassi
Copy link
Member

karbassi commented Sep 7, 2017

@heX16 there is no full list since each person can use their own set of special tags.

The ones I've seen used across tools have been

  • due:YYYY-MM-DD to represent the due date
  • t:YYYY-MM-DD to represent the threshold date

Maybe it's time we set a few that are part of the standards, such as due and t.

Thoughts @todotxt/core

@ginatrapani
Copy link
Member

What's threshold date?

Anecdotally, and historically, due date has by far been the most-requested addition to the standard. I've pushed back on it for lots of reasons (I'm sure there are ancient discussion threads about this on the mailing list), but I'm fine with revisiting.

@karbassi
Copy link
Member

karbassi commented Sep 7, 2017

What's threshold date?

The t tag gives a start date to an item (also called a threshold, hence the t). It's another way of filtering.

Example

(B) Call mom about dad's birthday gift due:2017-05-06 t:2017-04-20

While the task is due on May 5, 2017, I don't want to see it on my list (via a tool) until April 20, 2017. Moreover, some tools allow customizing how far ahead you want to see a task. Such as, show me tasks that have thresholds X days in the future.

@ginatrapani
Copy link
Member

Ah okay, thanks for explaining.

My general view has been: as soon as more dates get involved things get pretty complex pretty fast. To me, todo.txt is a task list, not a reminder tool, or a calendar, so these two dates feel outside of the scope of the spirit of the app. Not to mention what a significant burden it would put on client developers to accommodate a not-small amount of date math and other complexity (like hiding tasks that aren't complete but haven't hit their threshold date yet -- that would confuse me if I opened the file in a text editor, and the point of the format is to offer a human-readable text file that can easily be manipulated in any editor).

Anyway, as always, open to dissenting opinions, but if we go back to guiding principles, I think something like threshold date is too much. There's probably a case to be made for due date, though.

@bram85
Copy link

bram85 commented Sep 8, 2017

I don't think we should enforce certain tags in the standard, but rather as a recommendation / common practice. Some tools share the same semantics, but that's about it.

Perhaps we could maintain a table of known todo.txt tools (perhaps a public Google sheet) with the tags that they use (syntax, semantics, and whether the tag name for that semantic is configurable).

@ginatrapani
Copy link
Member

I don't think we should enforce certain tags in the standard, but rather as a recommendation / common practice.

Oh, I think this is a good idea. Documenting the additional tags various clients have landed on as guidance for the community would be great.

@karbassi
Copy link
Member

karbassi commented Sep 8, 2017

I second this. If you look at the original task, @heX16 just wants a list of what's possible.

Moreover, it would really help get the tool developers in sync.

@bram85
Copy link

bram85 commented Sep 8, 2017

I made a brief start at https://docs.google.com/spreadsheets/d/11nqV2j8qc_O5SVsvkZ2JGZP98CABLQ6EwBxAQQi7Huc/edit?usp=drivesdk

Feel free to extend it with other clients.
Also, I'm not sure how to deal with the add-ons for the original CLI. Perhaps a comment referring to the add-on would do.

@evanp
Copy link
Member

evanp commented Sep 18, 2017

This is a great idea. I added the issue prefix to @bram85 's spreadsheet. Maybe get this moved to Github, though?

@thebluesnevrdie
Copy link

One that seems to be the most obvious missing to me is a dependency tag. I would think dependency and due date tags should even be considered officially supported per the format definition as those are pretty much universally supported in just about every task management tool ever built...

@tomByrer
Copy link

tomByrer commented Apr 4, 2018

So seems the most used tages are threshold, recurring, & hide.

most obvious missing to me is a dependency tag

I was thinking of using 'less than' & 'greater than' symbols:
> depending on / waiting for

@farvardin
Copy link

I'm quite surprise there is no "complete" (or completeness) status of a task in percent or in number of items to complete. It could be comp:17% and comp:5/7

It would be useful to quickly see if a task is near completion or not (like writing a book, painting a wall...)

If it was an official recommendation, some tools could implement it with a status bar for example.

Here is a basic exemple with a html rendering which parses a todo file:
image

@codingthat
Copy link

@farvardin Just to throw an alternative approach out there: All chapters for a book is a rather big task, so maybe it could be a subproject instead, consisting of tasks like "Write chapter 1" etc. (and further broken down, if you so desire). Then it should be relatively straightforward to ask the software what percentage of chapters are done, instead of you having to calculate it manually. In fact, I think that's exactly what the birdseye extension does for you...

@clach04
Copy link

clach04 commented Sep 11, 2022

Android SimpleTask, from https://github.com/mpcjanssen/simpletask-android/blob/master/app/src/main/assets/index.en.md#extensions (as of 2022-09-11):

Simpletask supports the following todo.txt extensions:

  • Due date as due:YYYY-MM-DD
  • Start/threshold date as t:YYYY-MM-DD
  • Recurrence with rec:\+?[0-9]+[dwmyb] as described here but with a twist.
    • By default Simpletask will use the date of completion for recurring as described in the link. However if the rec includes a plus (e.g. rec:+2w), the date is determined from the original due or threshold date..
    • rec:1b will recur after 1 weekday (mnemonic business-day).
    • The format is described by a regular expression, so in words the syntax is rec: followed by an optional + then 1 or more numbers and then followed by one of day, week, month or year. For example rec:12d sets up a 12 day recurring task.
  • Hidden tasks with the specified tag h:1, this allows dummy tasks with predefined lists and tags so that lists and tags will be available even if the last task with the tag/list is removed from todo.txt. These tasks will not be shown by default. You can temporarily display them from the Settings.

Simple task also has option uuid

@clach04
Copy link

clach04 commented Sep 11, 2022

Seen ttps://gitter.im/todotxt/Lobby?at=6284470aeaf3267f8566d9e3:

id:
blocks:1

I've also seen p:1 to show the parent (for sub-tasks).

@clach04
Copy link

clach04 commented Sep 16, 2022

Just realized spec has another one listed https://github.com/todotxt/todo.txt#rule-2-the-date-of-completion-appears-directly-after-the-x-separated-by-a-space as part of priority for completed tasks:

pri:A

@clach04
Copy link

clach04 commented Sep 25, 2022

wait:

https://lwn.net/Articles/824608/

Hide until wait date, essentially an expected start date

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

10 participants