Docs: Updated doc drafts

This commit is contained in:
Paul Beckingham 2016-04-04 08:37:50 -04:00
parent 3de3e6c526
commit 4675edbcad
7 changed files with 29 additions and 14 deletions

View file

@ -120,6 +120,7 @@ explicitly not desired. The categories are:
warnings
errors
info
debug
A log entry will have this form:

View file

@ -137,23 +137,34 @@ Will result in an update to the configuration rule:
Using the '.' character allows the rule to reflect hierarchical configuration
data:
$ timew config one two three four
$ timew config one two five six
$ timew config one.two.three four
$ timew config one.two.five six
Will construct the rule like this:
define configuration:
one:
two:
three four
five six
three = four
five = six
The process of converting this rule structure to 'one.two.three four' is called
normalizing.
[6.2] Configuration: Running in debug mode
------------------------------------------
Running in debug mode reveals internal details that aid troubleshooting. To run
in debug mode, add the ':debug' hint to the command line:
$ timew ... :debug
--- Raw Notes ---
- Incorporate the following old notes into the above doc:
By using tags, this becomes:
$ timew start tag1 # Start tracking now

View file

@ -115,9 +115,9 @@ supported hints are:
:interrupt Identify the interval as a temporary interruption
:noreport Prevent the interval being reported
:quiet No feedback
:x User defined
:week Macro that means 'this week'
:debug Turns on debugging mode
:x User defined
--- Raw Notes ---

View file

@ -1,7 +1,8 @@
Introduction
============
Timewarrior is a time tracking application, which allows you to record your
time spent on activities. At its simplest, you tell it to start and stop
time spent on activities. You may be tracking time for pure curiosity, or your
work may require it. At its simplest, you tell it to start and stop
tracking time:
$ timew start

View file

@ -9,7 +9,7 @@ implement a simple stop-watch tracking feature, generate custom reports, and
apply a set of rules to impose constraints and check the data.
Using a hook scripts, Timewarrior can be used as a backend time-tracking
feature for Taskwarrior, any other program, or as a standalone utility.
feature for Taskwarrior, any other program, or simply as a standalone utility.
Timewarrior aims to be the tool of choice if you need to track time and generate
timesheets.
@ -17,8 +17,8 @@ timesheets.
Goals
-----
- Provide a personal tools to easily track time spent and generate reports with
low friction.
- Provide a personal tool to easily track and report time spent, with low
friction.
- Support all workflows.
- Provide an extension-friendly tool.
- Support policies via the rules system.

View file

@ -6,8 +6,8 @@ combination of a filter, sort, columns and labels, a more flexible approach
could encourage shared custom reports, and use a more complete API.
Іf all reports are extension scripts/programs, utilizing an API, then there is
no restriction on the kind of report generated, which would allow for HTML
reports, rather than simply supporting tabular text.
no restriction on the kind of report generated, which would allow, for example,
for PDF or HTML reports, rather than simply supporting tabular text.
Requirements
@ -84,9 +84,6 @@ configuration names flattened, i.e. no hierarchy.
--- Raw Notes ---
- The Taskwarrior hook script should use a set of attributes for time tracking
tags. Those will include: UUID, project, tags, description, and any chosen UDAs.
- Need a JSON --> CSV converter, for spreadsheet folks.
- Use display granularity/resolution to see more or less details. This would

View file

@ -65,6 +65,11 @@ There are rules that define tags and their metadata:
define tag "tag1":
...
There are rules that will serve as hooks:
define rule hook on_stop:
...
Rule Type: Exclusions
---------------------