Comment by EmptyMoon

5 years ago

I'm having trouble finding a canonical definition of .plan style files. From Carmack it seems like:

* complete

+ new task

notes

Is that it? Is there somewhere the file format is defined?

2 comments

EmptyMoon

Reply
keyle  5 years ago

Let's call it pretty open... I couldn't find one either, years ago, so I kind of went with what works for me.

Note that plan files aren't exactly a micro-blogging platform like some people seem to refer it to as. To me anyway, it's a way to capture work and todos in a simple digital journal.

This is the standard I followed for myself...

   This is a rolling plan file where things get moved on completion against a specific date (no backtracking, sliding tasks)

   - is todo
   * is done (for grepping)

   bugs are tagged [bug]
   other tags can be use as [tag]
   ~~is a cancelled~~ task or bug
   // is a comment or thought
   @next is upcoming work
   @later is backlog

   if it is not done, it's in next, later or ~~cancelled~~

   date is YYYY-MM-DDD followed by a rough recorded timesheet
   :0000-0000-XXm as in :start-end military time -minus XX mins of AFK.
   timesheet that is parsable by another program to get time spent /week /month /total

For example...

   ### 2021-01-10-sun :0900-2100-50m

   * ditched ~~passport~~ [wtf]
   * auth via bcrypt and jwt tokens
   * new vue app, trying water.css - nice [noteworthy]
   * JSDoc is awesome, makes typescript a lot less needed [noteworthy]
   * sign in with email / pass against db
   * register against db (not in vue yet)
   * validating jwt tokens properly
   * clean up package.json

Note that none of this is a replacement for actually doing the work ;)

http://programming-motherfucker.com

Jtsummers  5 years ago

It was just text. There was no definitive markup format, just what people conventionally used in other text-based forums (like newsgroups) at the time. So you'd have a variety of potential bullets (*, +, -), things like *foo* or _foo_ for types of emphasis, and whatever plaintext formatting they wanted besides that.