diff --git a/doc/examples.txt b/doc/examples.txt index 769562e8..8f34bd09 100644 --- a/doc/examples.txt +++ b/doc/examples.txt @@ -44,13 +44,31 @@ then this creates overlapping intervals: Track time but backfill to the most recent interval end: - $ timew track fill tag1 + $ timew track :backfill tag1 Record yesterday's time: $ timew track yesterday tag1 -Defining Exclusions: + +Fill Examples +------------- +If the time is 12:13pm, the workday starts at 8:00am, and you have already +tracked a 9am-10am meeting, then this command will automatically backfill +the 8am-9am interval only: + + $ timew track 8am "Reading email" + +Similarly, this command will do the same thing: + + $ timew track 8:23am "Reading email" backfill + +These two example assume that there is no empty slot at the end of yesterday, +because it would also be filled. + + +Defining Exclusions +------------------- $ timew define holidays eng-USA $ timew define holidays work 2015-11-26 @@ -73,3 +91,13 @@ associated metadata: --- +- Need to break all these out into separate sections, where each is discussed in + sufficient detail to then generate user docs and code. + +- Need to differentiate ":fill", ":backfill" and automatic fill. + +- Outline case for double-tracking, perhaps where a manager tracks the time of + several employees. This would require that tracked time for a single tag has + no overlaps, but allowing overlapping intervals might need configuration to + allow this. + diff --git a/doc/project.txt b/doc/project.txt index c98626db..e0aea132 100644 --- a/doc/project.txt +++ b/doc/project.txt @@ -82,8 +82,6 @@ For example, this script clearly defines that it is a 'report' extension named --- -- Need Terminology for backwards and forwards tracking (backfill for the past, and just assume everything else is for the future)? - - Given this: $ timew track yesterday 9am - 5pm tag1 What does this do: @@ -122,26 +120,3 @@ P: Let’s explore that. Suppose “last week” is 39 hours of nothing, and 1 F: hm, b would be first choice. “a" would be second or third. -F: I think we could generally use it to “fill” around other already tracked events. -P: So a normal human only does one thing at a time. -F: Yes but then also to make a difference between this - say you had this: - timew track 9-10 meeting - so now a noon you realise that you don’t have anything tracked for 8-9 and 10-12. - If I then do timew track 8 "reading email” it either stops automatic tracking for email at 9 (or continues and erases meeting - whatever if that makes sence). - but with timew track 8 “reading email” fill it would do 8-9 mail and 10-12 mail around the 9-10 meeting. - I think it would be more logic to stop a tracking of an event if a new event comes along. -P: I like that: “timew track 8 read” fills in 8-9 and stops. “timew track 8 read :fill” fills in 8-9, 10-12. -F: Yes. -F: Perhaps this could be used in the same way for the yesterday example... So the double tracking would not occur. -P: Agreed. -F: Only when doing it explicitly. -P: There is a use-case for double tracking. Suppose I am a manager, and I do this: - $ timew track yesterday “paint the door” fredde - $ timew track yesterday “paint the window” paul - It’s a valid use case. So there would be some kind of configuration that says “this tag can overlap with that tag, but not itself”. -t I thought of this: Using a tag with pre-defining it is what we have discussed so far. - But if a tag is predefined somehow (timew define tag “…”) then it could live in configuration, and have metadata, such as an expiration date. This corresponds to “you can’t bill this client after EOM”. - It could have a start date, which means “cannot bill before next month”. - Could also define overlap. This could be implemented using Rules. -