Merge branch 'doc' into date-properties
This commit is contained in:
contrapunctus
commit
b43dea5bc5
|
|
@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
1. Multiple backend support - new custom variable `chronometrist-active-backend` to determine active backend, new command `chronometrist-switch-backend` to temporarily select a backend (with completion).
|
||||
2. New `plist-group` backend, reducing time taken in startup and after changes to the file.
|
||||
3. Unified migration interface with command `chronometrist-migrate`.
|
||||
4. New custom variable `chronometrist-task-list`, to add/hide tasks without modifying the database.
|
||||
4. New custom variable `chronometrist-task-list`, to add/hide tasks without modifying the database. Setting it also disables generation of the task list from the database, speeding up many operations.
|
||||
5. New command `chronometrist-discard-active`, to discard the active interval.
|
||||
6. Debug logging messages - to view them, set `chronometrist-debug-enable`.
|
||||
7. `chronometrist-third`, an extension to add support for the [Third Time](https://www.lesswrong.com/posts/RWu8eZqbwgB9zaerh/third-time-a-better-way-to-work) system.
|
||||
|
|
|
|||
94
TODO.org
94
TODO.org
|
|
@ -737,7 +737,9 @@ for <predicate>)"
|
|||
#+END_SRC
|
||||
|
||||
* STARTED customizable duration output :feature:
|
||||
See branch =format-seconds=.
|
||||
:PROPERTIES:
|
||||
:branch: format-seconds
|
||||
:END:
|
||||
1. [X] define =chronometrist-duration-formats= to hold duration formats for different use cases in Chronometrist.
|
||||
2. [ ] define customization type for =chronometrist-duration-formats= to create user-friendly Custom interface
|
||||
3. [ ] make non-tabular parts of Chronometrist buffers adapt to column widths, to accomodate changes in duration formats
|
||||
|
|
@ -797,12 +799,18 @@ protocol implementation progress
|
|||
20. [ ] [superclass] chronometrist-timer
|
||||
|
||||
* New backends :feature:
|
||||
1. Org time tracking
|
||||
2. timeclock
|
||||
3. [[https://klog.jotaen.net/][klog]]
|
||||
4. SQLite
|
||||
5. https://github.com/projecthamster/hamster
|
||||
+ https://github.com/projecthamster/hamster/wiki/Our-datamodel
|
||||
** Org time tracking
|
||||
** timeclock
|
||||
See docstring of =timeclock-log-data=
|
||||
|
||||
** [[https://klog.jotaen.net/][klog]]
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: new-backends-klog
|
||||
:END:
|
||||
** SQLite
|
||||
** Project Hamster
|
||||
https://github.com/projecthamster/hamster
|
||||
+ https://github.com/projecthamster/hamster/wiki/Our-datamodel
|
||||
|
||||
* Functions doing similar things :code:
|
||||
1. =task-time-one-day=
|
||||
|
|
@ -810,9 +818,10 @@ protocol implementation progress
|
|||
3. =events-to-durations=
|
||||
|
||||
* Use ISO date for functions operating on dates :time:format:
|
||||
* STARTED customizable task list :feature:
|
||||
1. Interactive, buffer-local modification of task list, with completion (=completing-read-multiple=)
|
||||
2. Adding a task? We can modify the task list, but how to persist it?
|
||||
* STARTED customizable task list [33%] :feature:
|
||||
1. [X] Make =chronometrist-task-list= customizable
|
||||
2. [ ] Interactive, buffer-local modification of task list, with completion (=completing-read-multiple=)
|
||||
3. [ ] Adding a task? We can modify the task list, but how to persist it?
|
||||
|
||||
* Extend time range prompt :feature:
|
||||
Support inputs like "today", "yesterday", "5 days ago", etc.
|
||||
|
|
@ -846,6 +855,9 @@ With different checks, for different levels of speed/thoroughness -
|
|||
|
||||
* format changes
|
||||
** multiple intervals per record :feature:
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: multiple-intervals-per-record
|
||||
:END:
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(:name "<name>"
|
||||
[<keyword-value pair>] ...
|
||||
|
|
@ -855,6 +867,10 @@ With different checks, for different levels of speed/thoroughness -
|
|||
#+END_SRC
|
||||
|
||||
It doesn't do anything not already possible in the current formats. At best, it removes some duplication when the same task is "paused" and "resumed".
|
||||
+ Sometimes you pause and resume a task and don't want to split your key-values between >1 intervals (to avoid messing up completion suggestions for the future). An alternative means to the same end could be to add a key like =:deduct "<duration>"= or =:deduct ("<start time>" . "<stop time>")=.
|
||||
- This will also make it easier to support formats like [[#new-backends-klog][klog]], which support this feature.
|
||||
- It will probably complicate all data consuming code, though...think of =chronometrist-details= 🤔
|
||||
- An alternative idea could be to define a custom variable to hold the user's key values. If this variable is defined, it would be used instead of generating suggestions from past key-values. That way, such situations will not affect key-value suggestions.
|
||||
|
||||
** "event records" - records with only a timestamp :feature:
|
||||
:PROPERTIES:
|
||||
|
|
@ -866,7 +882,7 @@ Records not used for time tracking, but to store data associated with a date or
|
|||
[<keyword-value pair>] ...)
|
||||
#+END_SRC
|
||||
|
||||
** STARTED tagging dates with key-values :feature:
|
||||
** STARTED tagging dates with key-values [0%] :feature:
|
||||
:PROPERTIES:
|
||||
:CREATED: 2022-02-10T22:59:45+0530
|
||||
:CUSTOM_ID: date-key-values
|
||||
|
|
@ -891,6 +907,10 @@ Alternatively, this would be easier to work with - easier to select the key-valu
|
|||
|
||||
The plist backend could theoretically be extended to support it, but I'd rather deprecate that format (since it suffers from performance issues) and not deal with it again.
|
||||
|
||||
1. [ ] Update call sites of =chronometrist-latest-date-records= (which may now also contain key-values)
|
||||
2. [ ] Update code accessing the hash table
|
||||
3. [ ] Update =plist-pp= to handle
|
||||
|
||||
* undesired file watcher created after literate-elisp-load :bug:
|
||||
:PROPERTIES:
|
||||
:CREATED: 2021-12-18T15:13:35+0530
|
||||
|
|
@ -906,7 +926,7 @@ The plist backend could theoretically be extended to support it, but I'd rather
|
|||
:CREATED: 2022-01-08T23:32:37+0530
|
||||
:END:
|
||||
1. [ ] default suggested input backend should be the active backend
|
||||
2. [ ] conserve file local variables prop line
|
||||
2. [ ] conserve file local variables prop line for text backends
|
||||
|
||||
* STARTED Support for the Third Time System [57%] :extension:
|
||||
:PROPERTIES:
|
||||
|
|
@ -941,14 +961,54 @@ Additional rules:
|
|||
* [ ] Hook function which prompts for work hours whenever you first clock in on a date. If work hours are defined in the custom variable, ask whether to use them - on negative answer, prompt for today's work hours. If work hours are not defined, prompt for today's work hours.
|
||||
7. [ ] Displaying/recording breaks. Probably done implicitly - when work hours are defined, any time not spent working can be interpreted as break time.
|
||||
|
||||
Extras
|
||||
** Example flow
|
||||
1. work for 30m
|
||||
2. clock out - add 10m to =break-time=
|
||||
3. clock in after a 5m break - subtract 5m from =break-time=
|
||||
|
||||
** Extras
|
||||
1. persist =break-time= between Emacs sessions
|
||||
2. audible alerts
|
||||
3. handle user edits to the database
|
||||
* last record modified - ?
|
||||
* remove last record - ?
|
||||
* example - interval extended
|
||||
1. work 10 minutes and clock out - +3m break time
|
||||
2. edit stop time to add +20 minutes of work (30m total)
|
||||
* compare with old data in hash table - decrement break time added by old plist, increment break time added by new plist
|
||||
|
||||
Example flow
|
||||
1. work for 30m
|
||||
2. clock out - add 10m to =break-time=
|
||||
3. clock in after a 5m break - subtract 5m from =break-time=
|
||||
* STARTED Customizable alerts [50%] :feature:code:
|
||||
:PROPERTIES:
|
||||
:CREATED: 2022-02-14T08:22:36+0530
|
||||
:CUSTOM_ID: customizable-alerts
|
||||
:branch: alert-macro
|
||||
:END:
|
||||
=chronometrist-third= and =chronometrist-goal= have nearly identical alert code; additionally, users cannot customize the alert style per-alert without basically rewriting the alert functions.
|
||||
|
||||
Convert =chronometrist-third-alert-functions= and =chronometrist-goal-alert-functions= to customizable alists[fn:4] whose entries take the form =(SYMBOL FUNCTION ALERT-FN &rest ALERT-ARGS)=, where
|
||||
+ =SYMBOL= uniquely identifies the alert,
|
||||
+ =FUNCTION= is a function calling =chronometrist-*-run-at-time= and =ALERT-FN=, and
|
||||
+ =ALERT-ARGS= are passed to =ALERT-FN=.
|
||||
|
||||
=ALERT-FN= will usually be =alert=, and =ALERT-ARGS= will usually be keyword arguments passed to =alert=.
|
||||
Similar to how they behave now, these packages will start/stop functions for all entries provided in these alists. (So the user can still control which alerts are run.)
|
||||
|
||||
Also define =chronometrist--timer-alist=, which associates =symbol= with a timer object.
|
||||
|
||||
1. [X] write macro
|
||||
2. [ ] use in =chronometrist-goal= and =chronometrist-third=
|
||||
|
||||
[fn:4] Actually, make a macro to define such alists, since the docstrings are likely to be near-identical.
|
||||
|
||||
* Predefined key-values for tasks [100%]
|
||||
:PROPERTIES:
|
||||
:CREATED: 2022-02-17T23:34:17+0530
|
||||
:END:
|
||||
Benefits
|
||||
1. Speeds up key-value completion for very large data sets.
|
||||
2. Prevents key-value suggestions from being affected by [[#multiple-intervals-per-record][splitting of tasks across multiple intervals]].
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
'(("Task" <plist> ...)
|
||||
...)
|
||||
#+END_SRC
|
||||
|
|
|
|||
|
|
@ -741,7 +741,7 @@ Return t, to permit use in `chronometrist-before-out-functions'."
|
|||
;;; chronometrist-key-values.el ends here
|
||||
#+END_SRC
|
||||
|
||||
* Local variables :NOEXPORT:
|
||||
* Local variables :noexport:
|
||||
# Local Variables:
|
||||
# eval: (when (package-installed-p 'literate-elisp) (require 'literate-elisp) (literate-elisp-load (buffer-file-name)))
|
||||
# End:
|
||||
|
|
|
|||
|
|
@ -171,7 +171,7 @@ SCHEMA should be a vector as specified by `tabulated-list-format'."
|
|||
;;; chronometrist-spark.el ends here
|
||||
#+END_SRC
|
||||
|
||||
* Local variables :NOEXPORT:
|
||||
* Local variables :noexport:
|
||||
# Local Variables:
|
||||
# eval: (when (package-installed-p 'literate-elisp) (require 'literate-elisp) (literate-elisp-load (buffer-file-name)))
|
||||
# End:
|
||||
|
|
|
|||
|
|
@ -206,7 +206,7 @@ break time is up."
|
|||
;;; chronometrist-third.el ends here
|
||||
#+END_SRC
|
||||
|
||||
* Local variables :NOEXPORT:
|
||||
* Local variables :noexport:
|
||||
# Local Variables:
|
||||
# my-org-src-default-lang: "emacs-lisp"
|
||||
# eval: (when (package-installed-p 'literate-elisp) (require 'literate-elisp) (literate-elisp-load (buffer-file-name)))
|
||||
|
|
|
|||
|
|
@ -2884,7 +2884,7 @@ Return value is either a list in the form
|
|||
collect plist))
|
||||
#+END_SRC
|
||||
|
||||
***** TODO active-days :reader:method:NOEXPORT:
|
||||
***** TODO active-days :reader:method:noexport:
|
||||
#+BEGIN_SRC emacs-lisp :tangle no
|
||||
(cl-defmethod chronometrist-active-days ((backend chronometrist-plist-group-backend) task &key start end)
|
||||
(cl-check-type task string)
|
||||
|
|
@ -2909,7 +2909,7 @@ We apply the same hack as in the [[hack-note-plist-group-insert][insert]] method
|
|||
t))
|
||||
#+END_SRC
|
||||
|
||||
***** count-records :reader:method:NOEXPORT:
|
||||
***** count-records :reader:method:noexport:
|
||||
#+BEGIN_SRC emacs-lisp :tangle no
|
||||
(cl-defmethod chronometrist-count-records ((backend chronometrist-plist-group-backend)))
|
||||
#+END_SRC
|
||||
|
|
@ -4796,7 +4796,7 @@ Return value is a list as specified by `tabulated-list-entries'."
|
|||
;;; chronometrist.el ends here
|
||||
#+END_SRC
|
||||
|
||||
* Local variables :NOEXPORT:
|
||||
* Local variables :noexport:
|
||||
Evaluate this to be able to insert the package prefix via =nameless-insert-name=, at the cost of having all =nameless-aliases= break (= less readable code).
|
||||
|
||||
#+BEGIN_SRC emacs-lisp :load no :tangle no
|
||||
|
|
|
|||
Reference in New Issue