contrapunctus/chronometrist
Archived
1
3
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

README - add timeclock-report, Contact, and License sections

Browse Source
This commit is contained in:
Kashish Sharma 2018-09-04 01:48:05 +05:30
parent 538b2068cd
commit 4040ef396f
2 changed files with 24 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,9 +1,10 @@
# timeclock-ui
A nice user interface for Emacs' timeclock.el
Largely modelled after [A Time Tracker](https://github.com/netmackan/ATimeTracker)
Largely modelled after the Android application, [A Time Tracker](https://github.com/netmackan/ATimeTracker)
## timeclock-list
## Commands
### timeclock-list
Run `M-x timeclock-list` to see your projects, the time you spent on them today, which one is active, and the total time clocked today.
Hit `RET` on a project to clock in for it. If it's already clocked in, it will be clocked out (and you'll be prompted for an optional reason).
@ -16,10 +17,10 @@ Press `l` to view your `timeclock-file` (`~/.emacs.d/timelog` by default). Press
Running `M-x timeclock-list` when the timeclock-list is visible will kill it, so the key you bind it to can function as a toggle.
`timeclock-list` keeps itself updated via an idle timer - no pressing 'g' to update.
`timeclock-list` keeps itself updated via an idle timer - no pressing `g` to update.
## timeclock-report
Run `M-x timeclock-report` (or `timeclock-list` with a prefix argument, or press `r` in `timeclock-list`) to see a weekly report.
### timeclock-report
Run `M-x timeclock-report` (or `timeclock-list` with a prefix argument, or press `r` in the `timeclock-list` buffer) to see a weekly report.
Press `b` to look at past weeks, and `f` for future weeks.
@ -27,13 +28,16 @@ Press `l` to view your `timeclock-file`, `~/.emacs.d/timelog` by default.
Just like `timeclock-list`, `timeclock-report` will also toggle the visibilty of the buffer.
`timeclock-report` keeps itself updated via an idle timer - no pressing 'g' to update.
`timeclock-report` keeps itself updated via an idle timer - no pressing `g` to update.
## Customization
### timeclock-list-hide-cursor
Set this to non-nil if you want to hide the cursor in timeclock-list. The line the cursor is on will be highlighted instead.
## Roadmap
1. More statistics (current/longest streaks for activities, most productive $time_period (day, week, month, year...))
### timeclock-list
1. Add variable to let user control prompting-for-reason behaviour
2. Option to use a specific time to define when a day starts/ends. e.g. 08:00 will mean a day starts and ends at 08:00 instead of the usual 24:00/00:00. Helpful for late sleepers.
3. Shortcuts derived from the first alphabet of each project could be even nicer (but the code to generate them from similarly-named projects would be somewhat complex...)
@ -43,6 +47,17 @@ Set this to non-nil if you want to hide the cursor in timeclock-list. The line t
- Make default blank?
- Possibly make suggestions activity-sensitive e.g. when stopping activity A, don't suggest past reasons used for activity B, C, etc. Add a variable to customize this, because it might not be the behaviour everyone wants.
7. Show shortcuts message by using the keymap rather than a hardcoded string.
8. Move help message to buffer.
9. More statistics (current/longest streaks for activities, most productive $time_period (day, week, month, year...))
10. Refresh when you select the list buffer (impossible? make-thread in v26? Use emacs-async library?)
8. Move help text from `message` to the buffers.
9. Refresh when you select the list buffer (impossible? make-thread in v26? Use emacs-async library?)
### timeclock-report
1. Highlight column of current day
2. Add total time clocked per day
3. Add support for other locale weeks/weekday names
## Contact
Contact the creator and other Emacs users in the Emacs room on the Jabber network - [xmpp:emacs@salas.suchat.org?join](xmpp:emacs@salas.suchat.org?join)
(For help in getting started with Jabber, [click here](https://xmpp.org/getting-started/))
## License
timeclock-ui is released into the public domain under your choice of [CC0](https://creativecommons.org/publicdomain/zero/1.0/), [Unlicense](https://unlicense.org/), and [WTFPL](http://www.wtfpl.net/).

5
timeclock-report.el
View File

@ -1,8 +1,3 @@
;; TODO
;; 1. Highlight column of current day
;; 2. Add total time clocked per day
;; 3. Add support for other locale weeks/weekday names
;; ## VARIABLES ##
(defvar timeclock-report-buffer-name "*Timeclock-Report*")
(defvar --timeclock-report-year-week