From 345a813be8872b68f78b87ac4137e96040e2537e Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Wed, 30 Mar 2016 23:12:41 -0400 Subject: [PATCH] Docs: Added autofill example --- doc/examples.txt | 13 +++++++++++++ doc/grammar.txt | 6 ++++-- doc/project.txt | 1 + 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/doc/examples.txt b/doc/examples.txt index 8cf0b473..249c86d2 100644 --- a/doc/examples.txt +++ b/doc/examples.txt @@ -106,7 +106,20 @@ that extends all day today. Similarly 'tomorrow', 'next week' are bounded. [5.3] Fill: Autofill -------------------- +Given an exclusion that ends at 8am, and another that begins at 5pm (defining a +work day), then the following commands need to be explained: + $ timew track today ... + +This will create an open tracking interval starting at 8am, because of the lack +of a specific start time, and the presence of configured exclusions. + + $ timew track 7:45am ... + +This will create an open tracking interval starting at 7:45am, because of the +specific start time, which always overrides exclusions. This means is possible +to track time that exists entirely within an exclusion, provided there is a +specific start and stop time. [6.1] Configuration: Storing/accessing settings diff --git a/doc/grammar.txt b/doc/grammar.txt index ed3545e2..a9a1efb6 100644 --- a/doc/grammar.txt +++ b/doc/grammar.txt @@ -123,6 +123,8 @@ supported keywords are: --- Raw Notes --- -- 'timew merge ' for combining data. Or is this the same as - 'timew import '? Probably is. +- 'timew import ' will merge data. + +- A command for a daily and weekly view of exclusions is needed. To verify that + it is correctly defined. A text-based list should accompany it. diff --git a/doc/project.txt b/doc/project.txt index 0abdcc39..3fde73a1 100644 --- a/doc/project.txt +++ b/doc/project.txt @@ -106,6 +106,7 @@ three changes associated with the one command. Extensions ---------- A simple extension mechanism allows custom reports to be written and shared. +Most reports will be external scripts that use the extension API. --- Raw Notes ---