TODO: Add tasks for tutorial/how-to revamp
This commit is contained in:
parent
ca20b3edda
commit
1bf960b6e0
16
TODO.org
16
TODO.org
|
@ -1207,3 +1207,19 @@ some way to view/edit the database in a different format, e.g. Lisp plists
|
|||
2. Revamp tutorials - https://diataxis.fr/tutorials/#the-language-of-tutorials
|
||||
3. Make how-to guides more general?
|
||||
4. Move some how-to guide code into a contrib directory?
|
||||
|
||||
** tutorial and how-to topic revamp
|
||||
tutorials
|
||||
1. installation (MELPA) -> first run
|
||||
2. adding the first task
|
||||
3. clocking in, clocking out
|
||||
4. customization - open a file when starting a task (move from how-to)
|
||||
5. customization - warn when exiting with an active task
|
||||
6. clocking in/out without running hooks
|
||||
7. restarting or discarding an activity
|
||||
8. key-value extension - installation -> customization -> testing/results
|
||||
9. graph extension - installation -> customization -> testing/results
|
||||
|
||||
how-to guides
|
||||
1. how to install (Git, MELPA, Quelpa, etc)
|
||||
2. how to attach tags and properties to time intervals (cover different commands)
|
||||
|
|
|
@ -251,9 +251,9 @@ Evaluate or add to your init.el the following -
|
|||
1. Add =chronometrist-kv-add= to one or more of these hooks [fn:2] -
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(add-to-list 'chronometrist-after-in-functions 'chronometrist-kv-add)
|
||||
(add-to-list 'chronometrist-before-out-functions 'chronometrist-kv-add)
|
||||
(add-to-list 'chronometrist-after-out-functions 'chronometrist-kv-add)
|
||||
(add-to-list 'chronometrist-after-in-functions 'chronometrist-kv-add)
|
||||
(add-to-list 'chronometrist-before-out-functions 'chronometrist-kv-add)
|
||||
(add-to-list 'chronometrist-after-out-functions 'chronometrist-kv-add)
|
||||
#+END_SRC
|
||||
|
||||
To exit the prompt, press the key it indicates for quitting - you can then edit the resulting key-values by hand if required. Press =C-c C-c= to accept the key-values, or =C-c C-k= to cancel.
|
||||
|
|
Reference in New Issue