manual.org

The Chronometrist Manual

The structure of this manual was inspired by https://documentation.divio.com/

How to…

How to set up Emacs to contribute

All of these are optional, but recommended for the best experience.

1. Use nameless-mode for easier reading of Emacs Lisp code, and
2. Use visual-fill-column-mode to soft-wrap lines in Org/Markdown files. org-indent-mode (for Org files) and adaptive-prefix-mode (for Markdown and other files) will further enhance the experience.
3. Get the sources from https://github.com/contrapunctus-1/chronometrist and read this manual in the Org format (doc/manual.org), so links to identifiers can take you to their location in the source.
4. Install Cask to easily byte-compile and test the project. From the project root, you can now run
   1. cask to install the project dependencies in a sandbox
   2. cask exec buttercup -L . --traceback pretty to run tests.

Reference

chronometrist-common.el

1. Variable - chronometrist-task-list
2. Internal Variable - chronometrist–fs-watch
3. Function - chronometrist-current-task ()
4. Function - chronometrist-format-time (seconds &optional (blank ” “))
   • seconds -> “h:m:s”
5. Function - chronometrist-common-file-empty-p (file)
6. Function - chronometrist-common-clear-buffer (buffer)
7. Function - chronometrist-format-keybinds (command map &optional firstonly)
8. Function - chronometrist-events->ts-pairs (events)
   • (plist …) -> ((ts . ts) …)
9. Function - chronometrist-ts-pairs->durations (ts-pairs)
   • ((ts . ts) …) -> seconds
10. Function - chronometrist-previous-week-start (ts)
    • ts -> ts

chronometrist-custom.el

1. Custom variable - chronometrist-file
2. Custom variable - chronometrist-buffer-name
3. Custom variable - chronometrist-hide-cursor
4. Custom variable - chronometrist-update-interval
5. Custom variable - chronometrist-activity-indicator
6. Custom variable - chronometrist-day-start-time

chronometrist-diary-view.el

1. Variable - chronometrist-diary-buffer-name
2. Internal Variable - chronometrist-diary–current-date
3. Function - chronometrist-intervals-on (date)
4. Function - chronometrist-diary-tasks-reasons-on (date)
5. Function - chronometrist-diary-refresh (&optional ignore-auto noconfirm date)
6. Major Mode - chronometrist-diary-view-mode
7. Command - chronometrist-diary-view (&optional date)

chronometrist.el

1. Internal Variable - chronometrist–point
2. Keymap - chronometrist-mode-map
3. Command - chronometrist-open-log (&optional button)
4. Function - chronometrist-common-create-file ()
5. Function - chronometrist-task-active? (task)
   • String -> Boolean
6. Function - chronometrist-use-goals? ()
7. Function - chronometrist-run-transformers (transformers arg)
8. Function - chronometrist-activity-indicator ()
9. Function - chronometrist-entries ()
10. Function - chronometrist-task-at-point ()
11. Function - chronometrist-goto-last-task ()
12. Function - chronometrist-print-keybind (command &optional description firstonly)
13. Function - chronometrist-print-non-tabular ()
14. Function - chronometrist-goto-nth-task (n)
15. Function - chronometrist-refresh (&optional ignore-auto noconfirm)
16. Internal Variable - chronometrist–file-state
17. Function - chronometrist-file-hash (&optional start end hash)
18. Function - chronometrist-read-from (position)
19. Function - chronometrist-file-change-type (state)
20. Function - chronometrist-task-list ()
    • -> List
21. Function - chronometrist-reset-task-list ()
22. Function - chronometrist-add-to-task-list (task)
23. Function - chronometrist-remove-from-task-list (task)
24. Function - chronometrist-refresh-file (fs-event)
25. Command - chronometrist-query-stop ()
26. Command - chronometrist-in (task &optional _prefix)
27. Command - chronometrist-out (&optional _prefix)
28. Variable - chronometrist-before-in-functions
29. Variable - chronometrist-after-in-functions
30. Variable - chronometrist-before-out-functions
31. Variable - chronometrist-after-out-functions
32. Function - chronometrist-run-functions-and-clock-in (task)
33. Function - chronometrist-run-functions-and-clock-out (task)
34. Keymap - chronometrist-mode-map
35. Major Mode - chronometrist-mode
36. Function - chronometrist-toggle-task-button (button)
37. Function - chronometrist-add-new-task-button (button)
38. Command - chronometrist-toggle-task (&optional prefix inhibit-hooks)
39. Command - chronometrist-toggle-task-no-hooks (&optional prefix)
40. Command - chronometrist-add-new-task ()
41. Command - chronometrist (&optional arg)

chronometrist-events.el

1. Variable - chronometrist-events
   • keys - iso-date
2. Function - chronometrist-day-start (timestamp)
   • iso-timestamp -> encode-time
3. Function - chronometrist-file-clean ()
   • commented out, unused
4. Function - chronometrist-events-maybe-split (event)
5. Function - chronometrist-events-populate ()
6. Function - chronometrist-events-update (plist &optional replace)
7. Function - chronometrist-events-subset (start end)
   • ts ts -> hash-table

chronometrist-migrate.el

1. Variable - chronometrist-migrate-table
2. Function - chronometrist-migrate-populate (in-file)
3. Function - chronometrist-migrate-timelog-file->sexp-file (&optional in-file out-file)
4. Function - chronometrist-migrate-check ()

chronometrist-plist-pp.el

1. Variable - chronometrist-plist-pp-keyword-re
2. Variable - chronometrist-plist-pp-whitespace-re
3. Function - chronometrist-plist-pp-longest-keyword-length ()
4. Function - chronometrist-plist-pp-buffer-keyword-helper ()
5. Function - chronometrist-plist-pp-buffer ()
6. Function - chronometrist-plist-pp-to-string (object)
7. Function - chronometrist-plist-pp (object &optional stream)

chronometrist-queries.el

1. Function - chronometrist-last ()
   • -> plist
2. Function - chronometrist-task-time-one-day (task &optional (ts (ts-now)))
   • String &optional ts -> seconds
3. Function - chronometrist-active-time-one-day (&optional (ts (ts-now)))
   • &optional ts -> seconds
4. Function - chronometrist-statistics-count-active-days (task &optional (table chronometrist-events))
5. Function - chronometrist-task-events-in-day (task &optional (ts (ts-now)))

chronometrist-report-custom.el

1. Custom variable - chronometrist-report-buffer-name
2. Custom variable - chronometrist-report-week-start-day
3. Custom variable - chronometrist-report-weekday-number-alist

chronometrist-report.el

1. Internal Variable - chronometrist-report–ui-date
2. Internal Variable - chronometrist-report–ui-week-dates
3. Internal Variable - chronometrist-report–point
4. Function - chronometrist-report-date ()
5. Function - chronometrist-report-date->dates-in-week (first-date-in-week)
   • ts-1 -> (ts-1 … ts-7)
6. Function - chronometrist-report-date->week-dates ()
7. Function - chronometrist-report-entries ()
8. Function - chronometrist-report-print-keybind (command &optional description firstonly)
9. Function - chronometrist-report-print-non-tabular ()
10. Function - chronometrist-report-refresh (&optional _ignore-auto _noconfirm)
11. Function - chronometrist-report-refresh-file (_fs-event)
12. Keymap - chronometrist-report-mode-map
13. Major Mode - chronometrist-report-mode
14. Function - chronometrist-report (&optional keep-date)
15. Function - chronometrist-report-previous-week (arg)
16. Function - chronometrist-report-next-week (arg)

chronometrist-key-values.el

1. Internal Variable - chronometrist–tag-suggestions
2. Internal Variable - chronometrist–value-suggestions
3. Function - chronometrist-plist-remove (plist &rest keys)
4. Function - chronometrist-maybe-string-to-symbol (list)
5. Function - chronometrist-maybe-symbol-to-string (list)
6. Function - chronometrist-append-to-last (tags plist)
7. Variable - chronometrist-tags-history
8. Function - chronometrist-history-prep (key history-table)
9. Function - chronometrist-tags-history-populate (task history-table file)
10. Function - chronometrist-key-history-populate (task history-table file)
11. Function - chronometrist-value-history-populate (history-table file)
12. Function - chronometrist-tags-history-add (plist)
13. Function - chronometrist-tags-history-combination-strings (task)
14. Function - chronometrist-tags-history-individual-strings (task)
15. Function - chronometrist-tags-prompt (task &optional initial-input)
16. Function - chronometrist-tags-add (&rest args)
17. Custom Variable - chronometrist-kv-buffer-name
18. Variable - chronometrist-key-history
19. Variable - chronometrist-value-history
20. Keymap - chronometrist-kv-read-mode-map
21. Major Mode - chronometrist-kv-read-mode
22. Function - chronometrist-kv-completion-quit-key ()
23. Function - chronometrist-string-has-whitespace-p (string)
24. Function - chronometrist-key-prompt (used-keys)
25. Function - chronometrist-value-prompt (key)
26. Function - chronometrist-value-insert (value)
27. Function - chronometrist-kv-add (&rest args)
28. Command - chronometrist-kv-accept ()
29. Command - chronometrist-kv-reject ()
30. Internal Variable - chronometrist–skip-detail-prompts
31. Function - chronometrist-skip-query-prompt (task)
32. Function - chronometrist-skip-query-reset (_task)

chronometrist-statistics-custom.el

1. Custom variable - chronometrist-statistics-buffer-name

chronometrist-statistics.el

1. Internal Variable - chronometrist-statistics–ui-state
2. Internal Variable - chronometrist-statistics–point
3. Function - chronometrist-statistics-count-average-time-spent (task &optional (table chronometrist-events))
   • string &optional hash-table -> seconds
4. Function - chronometrist-statistics-entries-internal (table)
5. Function - chronometrist-statistics-entries ()
6. Function - chronometrist-statistics-print-keybind (command &optional description firstonly)
7. Function - chronometrist-statistics-print-non-tabular ()
8. Function - chronometrist-statistics-refresh (&optional ignore-auto noconfirm)
9. Keymap - chronometrist-statistics-mode-map
10. Major Mode - chronometrist-statistics-mode
11. Command - chronometrist-statistics (&optional preserve-state)
12. Command - chronometrist-statistics-previous-range (arg)
13. Command - chronometrist-statistics-next-range (arg)

chronometrist-time.el

1. Function - chronometrist-iso-timestamp->ts (timestamp)
   • iso-timestamp -> ts
2. Function - chronometrist-iso-date->ts (date)
   • iso-date -> ts
3. Function - chronometrist-date (&optional (ts (ts-now)))
   • &optional ts -> ts (with time 00:00:00)
4. Function - chronometrist-format-time-iso8601 (&optional unix-time)
5. Function - chronometrist-midnight-spanning-p (start-time stop-time)
6. Function - chronometrist-seconds-to-hms (seconds)
   • seconds -> list-duration
7. Function - chronometrist-interval (event)
   • event -> duration

chronometrist-timer.el

1. Internal Variable - chronometrist–timer-object
2. Function - chronometrist-timer ()
3. Command - chronometrist-stop-timer ()
4. Command - chronometrist-maybe-start-timer (&optional interactive-test)
5. Command - chronometrist-force-restart-timer ()
6. Command - chronometrist-change-update-interval (arg)

chronometrist-goal

1. Internal Variable - chronometrist-goal–timers-list
2. Custom Variable - chronometrist-goal-list nil
3. Function - chronometrist-goal-run-at-time (time repeat function &rest args)
4. Function - chronometrist-goal-seconds->alert-string (seconds)
   • seconds -> string
5. Function - chronometrist-goal-approach-alert (task goal spent)
   • string minutes minutes
6. Function - chronometrist-goal-complete-alert (task goal spent)
   • string minutes minutes
7. Function - chronometrist-goal-exceed-alert (task goal spent)
   • string minutes minutes
8. Function - chronometrist-goal-no-goal-alert (task goal spent)
   • string minutes minutes
9. Custom Variable - chronometrist-goal-alert-functions
   • each function is passed - string minutes minutes
10. Function - chronometrist-goal-get (task &optional (goal-list chronometrist-goal-list))
    • String &optional List -> minutes
11. Function - chronometrist-goal-run-alert-timers (task)
12. Function - chronometrist-goal-stop-alert-timers (&optional _task)
13. Function - chronometrist-goal-on-file-change ()

chronometrist-sexp

1. Custom variable - chronometrist-sexp-pretty-print-function
2. Macro - chronometrist-sexp-in-file (file &rest body)
3. Macro - chronometrist-loop-file (for expr in file &rest loop-clauses)
4. Function - chronometrist-sexp-open-log ()
5. Function - chronometrist-sexp-between (&optional (ts-beg (chronometrist-date)) (ts-end (ts-adjust ‘day +1 (chronometrist-date))))
6. Function - chronometrist-sexp-query-till (&optional (date (chronometrist-date)))
7. Function - chronometrist-sexp-last ()
   • -> plist
8. Function - chronometrist-sexp-current-task ()
9. Function - chronometrist-sexp-events-populate ()
10. Function - chronometrist-sexp-create-file ()
11. Function - chronometrist-sexp-new (plist &optional (buffer (find-file-noselect chronometrist-file)))
12. Function - chronometrist-sexp-delete-list (&optional arg)
13. Function - chronometrist-sexp-replace-last (plist)
14. Command - chronometrist-sexp-reindent-buffer ()