From 668d722c156afa6b66e5b6f7775cfdc1dd072d32 Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Mon, 29 Feb 2016 11:27:14 -0500 Subject: [PATCH] Docs: Added exclusions use case --- doc/examples.txt | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/doc/examples.txt b/doc/examples.txt index aa405dd5..a6b40101 100644 --- a/doc/examples.txt +++ b/doc/examples.txt @@ -5,6 +5,7 @@ gradually change into a feature spec. The use cases are grouped functionally: [1] Basic Usage [2] Reports + [3] Exclusions [1.1] Basic Usage: clock @@ -54,8 +55,23 @@ preset periods: $ timew report +[3.1] Exclusions: Work Week +-------------------------- -This uses a 'default' tag. By using tags, this becomes: + $ timew define holidays eng-USA + $ timew define holidays work 2015-11-26 + $ timew define workweek mon-fri + $ timew define workday start 8:30am + $ timew define workday end 1730 + $ timew define workday tue end 3pm + + + + + + + +By using tags, this becomes: $ timew start tag1 # Start tracking now $ timew start "Home Improvement Project" # Stop old interval, start new interval now @@ -117,16 +133,6 @@ 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 - $ timew define workweek mon-fri - $ timew define workday start 8:30am - $ timew define workday end 1730 - $ timew define workday tue end 3pm - The above examples simply use ad-hoc tags, which is an undefined tag. They are simply used as tags, and have no metadata. Defining a tag allows it to have associated metadata: