dotfiles

My personal shell configs and stuff
git clone git://git.alex.balgavy.eu/dotfiles.git
Log | Files | Refs | Submodules | README | LICENSE

config.org (142955B)


      1 * macOS installation info
      2 On macOS, I use Homebrew to install Emacs from daviderestivo/emacs-head/emacs-head@28.
      3 I install with ~--HEAD --with-dbus --with-cocoa --with-xwidgets --with-native-comp~.
      4 
      5 * Why I choose use-package
      6 - provides bind-key by default
      7 - is mostly just macros that wrap the needed stuff from package.el. can check that with ~macroexpand~.
      8 - adds a bunch of performance improvements
      9 * Let me know when we're at a certain version
     10 #+begin_src emacs-lisp
     11   (when (version<= "30" emacs-version)
     12     (message "Check out C-x w d to make windows dedicated."))
     13 #+end_src
     14 * Install from source
     15 Emacs 29 ships with a way to install packages from source, here's a small wrapper around it.
     16 
     17 #+begin_src emacs-lisp
     18   (cl-defun za/package-vc-install (&key (fetcher "github") repo name rev backend load)
     19     "Install a package from a remote if it's not already installed.
     20   This is a thin wrapper around `package-vc-install' in order to
     21   make non-interactive usage more ergonomic.  Takes the following
     22   named arguments:
     23 
     24   - FETCHER the remote where to get the package (e.g., \"gitlab\").
     25     If omitted, this defaults to \"github\".
     26 
     27   - REPO should be the name of the repository (e.g.,
     28   \"slotThe/arXiv-citation\".
     29 
     30   - NAME, REV, and BACKEND are as in `package-vc-install' (which
     31     see).
     32 
     33   - LOAD is optionally a subdirectory that should be added to `load-path'."
     34     (let* ((url (cond ((string-match-p (rx bos "http" (? ?s) "://") repo)
     35                        repo)
     36                       (t (format "https://www.%s.com/%s" fetcher repo))))
     37            (iname (when name (intern name)))
     38            (pac-name (or iname (intern (file-name-base repo))))
     39            (to-load (when load
     40                       (format "%s/%s"
     41                               (package-desc-dir (package-get-descriptor pac-name))
     42                               load))))
     43       (unless (package-installed-p pac-name)
     44         (package-vc-install url iname rev backend))
     45       (when load
     46         (unless (file-directory-p to-load)
     47           (user-error "Not a readable dir: %s" to-load))
     48         (add-to-list 'load-path to-load))
     49       (message "%s" pac-name)))
     50 #+end_src
     51 
     52 You can use this in use-package with an ~:init~ clause.
     53 
     54 * exec-path-from-shell (macOS)
     55 In macOS, the path is not set correctly (i.e. as it is in the terminal) in the GUI app. This fixes it.
     56 Not needed when using emacs-plus, because it has a custom patch for it. It also defines a [[https://github.com/d12frosted/homebrew-emacs-plus?tab=readme-ov-file#system-appearance-change][custom variable]] which hopefully should be enough to detect if we're running emacs-plus.
     57 
     58 #+begin_src emacs-lisp
     59   (when (and (string-equal system-type "darwin")
     60              (not (boundp 'ns-system-appearance-change-functions)))
     61     (use-package exec-path-from-shell
     62       :config
     63       (add-to-list 'exec-path-from-shell-variables "NOTMUCH_CONFIG")
     64       (exec-path-from-shell-initialize)))
     65 #+end_src
     66 
     67 * Emacs file locations
     68 ** Auto-Save files
     69 By default, auto-save files ("#file#") are placed in the same directory as the file itself.
     70 I want to put this all in some unified place:
     71 
     72 #+begin_src emacs-lisp
     73   (let ((saves-directory "~/.local/share/emacs/saves/"))
     74     (unless (file-directory-p saves-directory)
     75       (make-directory saves-directory))
     76     (setq auto-save-file-name-transforms
     77           `((".*" ,saves-directory t))))
     78 #+end_src
     79 
     80 ** Backup files
     81 By default, backup files (those with a tilde) are saved in the same directory as the currently edited file.
     82 This setting puts them in ~/.local/share/emacs/backups.
     83 
     84 #+begin_src emacs-lisp
     85   (let ((backups-directory "~/.local/share/emacs/backups"))
     86     (unless (file-directory-p backups-directory)
     87       (make-directory backups-directory))
     88     (setq backup-directory-alist `(("." . ,backups-directory)))
     89     (setq backup-by-copying t))
     90 #+end_src
     91 
     92 ** Custom settings file
     93 Both commands are necessary.
     94 First one tells Emacs where to save customizations.
     95 The second one actually loads them.
     96 
     97 #+begin_src emacs-lisp
     98   (setq custom-file (expand-file-name (concat user-emacs-directory "custom.el")))
     99   (load custom-file)
    100 #+end_src
    101 ** Delete by trash
    102 #+begin_src emacs-lisp
    103   (setq delete-by-moving-to-trash t)
    104   (unless (fboundp 'system-move-file-to-trash)
    105     (setq trash-directory "~/.Trash"))
    106 #+end_src
    107 * Daemon
    108 I want to have a way to kill the Emacs daemon.
    109 So, define a function that kills the frame, and with a prefix kills emacs.
    110 
    111 #+begin_src emacs-lisp
    112   (defun za/emacsclient-c-x-c-c (&optional arg)
    113     "If running in emacsclient, make C-x C-c exit frame, and C-u C-x C-c exit Emacs."
    114     (interactive "P") ; prefix arg in raw form
    115     (if arg
    116         (save-buffers-kill-emacs)
    117       (save-buffers-kill-terminal)))
    118 #+end_src
    119 
    120 Then, if I'm in an emacsclient, I want to bind C-x C-c to that function (if not, I just want the default keybinding):
    121 
    122 #+begin_src emacs-lisp
    123   ;; If not running in emacsclient, use the default bindings
    124   (if (daemonp)
    125       (bind-key "C-x C-c" #'za/emacsclient-c-x-c-c))
    126 #+end_src
    127 
    128 Furthermore, I want to set the theme correctly whenever I connect with 'emacsclient':
    129 
    130 #+begin_src emacs-lisp
    131   (if (daemonp)
    132       (add-hook 'after-make-frame-functions #'za/auto-select-theme))
    133 #+end_src
    134 * Sound support
    135 On macOS, you can use afplay:
    136 
    137 #+begin_src emacs-lisp
    138   (defun za/play-sound-file-macos (file &optional volume device)
    139     "Play sound using `afplay` on macOS"
    140     (unless (file-readable-p file)
    141       (user-error "File %s not readable." file))
    142 
    143     ;; the `apply` is required here because I need to build a list of arguments
    144     (apply 'start-process `("afplay" nil
    145                             "afplay"
    146                             ,@(if volume (list "-v" (int-to-string volume)))
    147                             ,file)))
    148 #+end_src
    149 
    150 Then redefine the play-sound-file function where needed:
    151 
    152 #+begin_src emacs-lisp
    153   (cond ((and (not (fboundp 'play-sound-internal))
    154               (eq system-type 'darwin))
    155          (advice-add 'play-sound-file :override #'za/play-sound-file-macos)))
    156 #+end_src
    157 * DISABLED Fix non-dbus macOS notification
    158 macOS version might not be compiled with dbus support; in that case you can use e.g. terminal-notifier.
    159 If you use the ~sender~ option, notifications don't show
    160 unless the app is in the background. [[https://github.com/julienXX/terminal-notifier/issues/68][See this Github issue.]]
    161 
    162 #+begin_src emacs-lisp :tangle no
    163   ;; on mac without dbus:
    164   (org-show-notification-handler
    165    (lambda (str) (start-process "terminal-notifier" nil (executable-find "terminal-notifier")
    166                                 "-title" "Timer done"
    167                                 "-message" str
    168                                 "-group" "org.gnu.Emacs"
    169                                 "-ignoreDnD"
    170                                 "-activate" "org.gnu.Emacs")))
    171 #+end_src
    172 * Custom notification functions
    173 #+begin_src emacs-lisp
    174   (defun za/notify (title message)
    175     "Show notification with TITLE and MESSAGE."
    176     (ignore-errors (require 'notifications))
    177     (cond ((fboundp 'ns-do-applescript)
    178            (ns-do-applescript
    179             (format "display notification \"%s\" with title \"%s\""
    180                     (replace-regexp-in-string "\"" "#" message)
    181                     (replace-regexp-in-string "\"" "#" title))))
    182           ((string= system-type "gnu/linux")
    183            (require 'notifications)
    184            (notifications-notify :title title :body message))
    185           (t (error "No notification handler defined!"))))
    186 
    187   (defun za/send-notification-interactivity-required (&rest _)
    188     "Notify that a function needs action."
    189     (za/notify "Interactivity required" "A function requires interactivity."))
    190 
    191   (defun za/notify-on-interactivity (func &rest r)
    192     "Send a notification whenever FUNC requires interactivity.
    193   Used as :around advice, calling FUNC with arguments R."
    194     (advice-add #'y-or-n-p :before #'za/send-notification-interactivity-required)
    195     (advice-add #'yes-or-no-p :before #'za/send-notification-interactivity-required)
    196     (advice-add #'user-error :before #'za/send-notification-interactivity-required)
    197     (with-demoted-errors "Error in %s" (apply func r))
    198     (advice-remove #'y-or-n-p #'za/send-notification-interactivity-required)
    199     (advice-remove #'yes-or-no-p #'za/send-notification-interactivity-required)
    200     (advice-remove #'user-error #'za/send-notification-interactivity-required))
    201 #+end_src
    202 
    203 * URLs
    204 #+begin_src emacs-lisp
    205   (defun za/browse-url-quicksilver (url &rest args)
    206     (call-process-shell-command (format "printf '%s' | qs -" url)))
    207   (setopt browse-url-handlers `((,(rx "http" (? ?s) "://") . za/browse-url-quicksilver)))
    208 #+end_src
    209 * Editing
    210 ** Everything is UTF-8
    211 #+begin_src emacs-lisp
    212   (set-language-environment 'utf-8)
    213   (setq locale-coding-system 'utf-8)
    214   (setq buffer-file-coding-system 'utf-8-unix)
    215   (set-terminal-coding-system 'utf-8)
    216   (set-keyboard-coding-system 'utf-8)
    217   (set-selection-coding-system 'utf-8)
    218   (prefer-coding-system 'utf-8)
    219 #+end_src
    220 ** Overwrite selection on typing
    221 Normally, when I select something and start typing, Emacs clears the selection, i.e. it deselects and inserts text after the cursor.
    222 I want to replace the selection.
    223 
    224 #+begin_src emacs-lisp
    225   (delete-selection-mode t)
    226 #+end_src
    227 
    228 ** Strip trailing whitespace
    229 You can show trailing whitespace by setting show-trailing-whitespace to 't'.
    230 But I want to automatically strip trailing whitespace.
    231 Luckily there's already a function for that, I just need to call it in a hook:
    232 
    233 #+begin_src emacs-lisp
    234   (add-hook 'before-save-hook #'delete-trailing-whitespace)
    235 #+end_src
    236 
    237 ** Formatting & indentation
    238 
    239 Show a tab as 8 spaces:
    240 
    241 #+begin_src emacs-lisp
    242   (setq-default tab-width 8)
    243 #+end_src
    244 
    245 Never insert tabs with indentation by default:
    246 
    247 #+begin_src emacs-lisp
    248   (setq-default indent-tabs-mode nil)
    249 #+end_src
    250 
    251 Allow switching between the two easily:
    252 
    253 #+begin_src emacs-lisp
    254   (defun indent-tabs ()
    255     (interactive)
    256     (setq indent-tabs-mode t))
    257   (defun indent-spaces ()
    258     (interactive)
    259     (setq indent-tabs-mode nil))
    260 #+end_src
    261 
    262 Indentation for various modes:
    263 
    264 #+begin_src emacs-lisp
    265   (setq-default sh-basic-offset 2
    266                 c-basic-offset 4)
    267 #+end_src
    268 
    269 ** Wrapping
    270 A function to toggle wrapping:
    271 
    272 #+begin_src emacs-lisp
    273   (defvar-local za/wrapping nil "Wrapping changes per buffer.")
    274 
    275   (defun za/toggle-wrap (&optional enable)
    276     "Toggle line wrapping settings. With ENABLE a positive number, enable wrapping. If ENABLE is negative or zero, disable wrapping."
    277     (interactive "P") ; prefix arg in raw form
    278 
    279     ;; If an argument is provided, prefix or otherwise
    280     (if enable
    281         (let ((enable (cond ((numberp enable)
    282                              enable)
    283                             ((booleanp enable)
    284                              (if enable 1 0))
    285                             ((or (listp enable) (string= "-" enable))
    286                              (prefix-numeric-value enable)))))
    287           ;; If zero or negative, we want to disable wrapping, so pretend it's currently enabled.
    288           ;; And vice versa.
    289           (cond ((<= enable 0) (setq za/wrapping t))
    290                 ((> enable 0) (setq za/wrapping nil)))))
    291 
    292 
    293     (let ((disable-wrapping (lambda ()
    294                               (visual-line-mode -1)
    295                               (toggle-truncate-lines t)))
    296           (enable-wrapping (lambda ()
    297                              (toggle-truncate-lines -1)
    298                              (visual-line-mode))))
    299 
    300       ;; If za/wrapping is not locally set, infer its values from the enabled modes
    301       (unless (boundp 'za/wrapping)
    302         (setq za/wrapping (and visual-line-mode
    303                                (not truncate-lines))))
    304 
    305       ;; Toggle wrapping based on current value
    306       (cond (za/wrapping
    307              (funcall disable-wrapping)
    308              (setq za/wrapping nil)
    309              (message "Wrapping disabled."))
    310             (t
    311              (funcall enable-wrapping)
    312              (setq za/wrapping t)
    313              (message "Wrapping enabled.")))))
    314 #+end_src
    315 
    316 And a keybinding to toggle wrapping:
    317 
    318 #+begin_src emacs-lisp
    319   (bind-key "C-c q w" #'za/toggle-wrap)
    320 #+end_src
    321 
    322 And fringe indicators:
    323 
    324 #+begin_src emacs-lisp
    325   (setopt visual-line-fringe-indicators '(left-curly-arrow right-curly-arrow))
    326 #+end_src
    327 ** Pager toggle
    328 M-x view-mode enables pager behavior.
    329 I want read-only files to automatically use pager mode:
    330 
    331 #+begin_src emacs-lisp
    332   (setq view-read-only t)
    333 #+end_src
    334 ** Prefer newer file loading
    335 #+begin_src emacs-lisp
    336   (setq load-prefer-newer t)
    337 #+end_src
    338 
    339 ** Automatically find tags file
    340 When opening a file in a git repo, try to discover the etags file:
    341 
    342 #+begin_src emacs-lisp
    343   (defun current-tags-file ()
    344     "Get current tags file"
    345     (let* ((tagspath ".git/etags")
    346            (git-root (locate-dominating-file (buffer-file-name) tagspath)))
    347       (if git-root
    348           (expand-file-name tagspath git-root))))
    349 
    350   (setq default-tags-table-function #'current-tags-file)
    351 #+end_src
    352 
    353 There's probably a better way to write this. I need to ask Reddit for feedback at some point.
    354 
    355 ** End sentences with one space
    356 Emacs uses the rather old-fashioned convention of treating a period followed by double spaces as end of sentence. However, it is more common these days to end sentences with a period followed by a single space.
    357 
    358 Let a period followed by a single space be treated as end of sentence:
    359 
    360 #+begin_src emacs-lisp
    361   (setopt sentence-end-double-space nil)
    362 #+end_src
    363 * Keybindings
    364 ** Expansion/completion
    365 Use hippie expand instead of dabbrev-expand:
    366 
    367 #+begin_src emacs-lisp
    368   (bind-key "M-/" #'hippie-expand)
    369 #+end_src
    370 
    371 ** Zap up to char
    372 It's more useful for me to be able to delete up to a character instead of to and including a character:
    373 
    374 #+begin_src emacs-lisp
    375   (defun za/zap-up-to-char-icase ()
    376     "Ignore case for zap-up-to-char"
    377     (interactive)
    378     (let ((case-fold-search nil))
    379       (call-interactively #'zap-up-to-char)))
    380   (bind-key "M-z" #'za/zap-up-to-char-icase)
    381 #+end_src
    382 
    383 ** Forward-word and forward-to-word
    384 Change M-f to stop at the start of the word:
    385 
    386 #+begin_src emacs-lisp
    387   (bind-key "M-f" #'forward-to-word)
    388 #+end_src
    389 
    390 Bind ESC M-f to the old functionality of M-f (stop at end of word)
    391 
    392 #+begin_src emacs-lisp
    393   (bind-key "ESC M-f" #'forward-word)
    394 #+end_src
    395 
    396 ** Rectangle insert string
    397 #+begin_src emacs-lisp
    398   (bind-key "C-x r I" #'string-insert-rectangle)
    399   (bind-key "C-x r R" #'replace-rectangle)
    400 #+end_src
    401 
    402 ** Toggle auto-revert-mode
    403 Sometimes I want to toggle auto reverting (or autoread) of buffer:
    404 
    405 #+begin_src emacs-lisp
    406   (bind-key "C-c q a" #'auto-revert-mode)
    407 #+end_src
    408 ** Fast access to view-mode (pager)
    409 I want to bind view-mode to a key for easy access:
    410 
    411 #+begin_src emacs-lisp
    412   (bind-key "C-c q r" 'view-mode)
    413 #+end_src
    414 
    415 ** Kill this buffer
    416 I like to be able to kill a buffer instantly:
    417 
    418 #+begin_src emacs-lisp
    419   (bind-key "s-<backspace>" 'kill-current-buffer)
    420 #+end_src
    421 
    422 ** Delete this file (and kill the buffer)
    423 #+begin_src emacs-lisp
    424   (defun za/delete-this-file ()
    425     "Kill the current buffer and delete its associated file."
    426     (interactive)
    427     (let ((fname (buffer-file-name))
    428           (buf (current-buffer)))
    429       (unless (and fname (file-exists-p fname))
    430         (user-error "Buffer has no associated file."))
    431 
    432       (unless (yes-or-no-p (format "Really delete %s and its buffer?" fname))
    433         (user-error "User cancelled."))
    434 
    435       (delete-file fname 'trash-if-enabled)
    436       (kill-buffer buf)
    437       (message "Deleted %s and killed its buffer." fname)))
    438 
    439   (bind-key "C-c s-<backspace>" #'za/delete-this-file)
    440 #+end_src
    441 
    442 ** Toggle fullscreen
    443 I'll use the keybinding that's standard on macOS:
    444 
    445 #+begin_src emacs-lisp
    446   (bind-key "C-s-f" #'toggle-frame-fullscreen)
    447 #+end_src
    448 
    449 ** Sexp manipulation
    450 When I write lisp, sometimes I want to switch two sexps (e.g. ~(one) (two)~ → ~(two) (one)~), so a key binding is nice for that:
    451 
    452 #+begin_src emacs-lisp
    453   (bind-key "C-S-t" #'transpose-sexps)
    454 #+end_src
    455 
    456 Also, to raise a sexp (e.g. ~(one (two))~ → ~(two)~):
    457 
    458 #+begin_src emacs-lisp
    459   (bind-key "C-S-u" #'raise-sexp)
    460 #+end_src
    461 
    462 ** Dedicated windows
    463 Sometimes I want to avoid Emacs overriding a window's contents.
    464 So I create a keybinding to toggle dedicated on a window:
    465 
    466 #+begin_src emacs-lisp
    467   (defun za/toggle-window-dedicated-p ()
    468     "Toggle set-window-dedicated-p on current window"
    469     (interactive)
    470     (cond ((window-dedicated-p (selected-window))
    471            (set-window-dedicated-p (selected-window) nil)
    472            (message "Window no longer dedicated"))
    473           (t
    474            (set-window-dedicated-p (selected-window) t)
    475            (message "Window marked as dedicated"))))
    476 
    477   (bind-key "C-x 9" #'za/toggle-window-dedicated-p)
    478 
    479 #+end_src
    480 
    481 ** Rotate windows horizontal ↔ vertical
    482 #+begin_src emacs-lisp
    483   (defun za/rotate-windows ()
    484     (interactive)
    485     (if (= (count-windows) 2)
    486         (let* ((this-win-buffer (window-buffer))
    487                (next-win-buffer (window-buffer (next-window)))
    488                (this-win-edges (window-edges (selected-window)))
    489                (next-win-edges (window-edges (next-window)))
    490                (this-win-2nd (not (and (<= (car this-win-edges)
    491                                            (car next-win-edges))
    492                                        (<= (cadr this-win-edges)
    493                                            (cadr next-win-edges)))))
    494                (splitter
    495                 (if (= (car this-win-edges)
    496                        (car (window-edges (next-window))))
    497                     'split-window-horizontally
    498                   'split-window-vertically)))
    499           (delete-other-windows)
    500           (let ((first-win (selected-window)))
    501             (funcall splitter)
    502             (if this-win-2nd (other-window 1))
    503             (set-window-buffer (selected-window) this-win-buffer)
    504             (set-window-buffer (next-window) next-win-buffer)
    505             (select-window first-win)
    506             (if this-win-2nd (other-window 1))))))
    507 #+end_src
    508 
    509 #+begin_src emacs-lisp
    510   (bind-key "C-x 7" #'za/rotate-windows)
    511 #+end_src
    512 
    513 ** Open line like in Vim
    514 I prefer to open-line the way o/O works in Vim:
    515 
    516 #+begin_src emacs-lisp
    517   ;; Autoindent open-*-lines
    518   (defvar za/open-line-newline-and-indent t
    519     "Modify the behavior of the open-*-line functions to cause them to autoindent.")
    520 
    521   (defun za/open-line (prefix)
    522     "Open line like `o`/`O` in Vim. Negative prefix for line above, positive for below."
    523     (interactive "p")
    524     (cond ((< prefix 0)
    525            (beginning-of-line)
    526            (open-line (abs prefix)))
    527           (t
    528            (end-of-line)
    529            (open-line prefix)
    530            (forward-line 1)))
    531     (when za/open-line-newline-and-indent
    532       (indent-according-to-mode)))
    533 
    534   (defun za/open-line-keep-point (prefix)
    535     "Open line like `o`/`O` in Vim but don't move point. Negative prefix for line above, positive for below."
    536     (interactive "p")
    537     (save-mark-and-excursion (za/open-line prefix)))
    538 #+end_src
    539 
    540 And keybindings:
    541 
    542 #+begin_src emacs-lisp
    543   (bind-key "C-o" #'za/open-line)
    544   (bind-key "C-M-o" #'za/open-line-keep-point)
    545 #+end_src
    546 
    547 ** Unfill region/paragraph
    548 Taken from here: https://www.emacswiki.org/emacs/UnfillParagraph
    549 
    550 #+begin_src emacs-lisp
    551   (defun za/unfill-paragraph (&optional region)
    552     "Takes a multi-line paragraph and makes it into a single line of text."
    553     (interactive (progn (barf-if-buffer-read-only) '(t)))
    554     (let ((fill-column (point-max))
    555           ;; This would override `fill-column' if it's an integer.
    556           (emacs-lisp-docstring-fill-column t))
    557       (fill-paragraph nil region)))
    558 
    559   (bind-key "M-Q" #'za/unfill-paragraph)
    560 #+end_src
    561 ** Easily edit my config
    562 Bind a keyboard shortcut to open my config.
    563 The "(interactive)" means that it can be called from a keybinding or from M-x.
    564 
    565 #+begin_src emacs-lisp
    566   (defun za/edit-config-org ()
    567     "Edit my config.org file"
    568     (interactive)
    569     (find-file (expand-file-name "config.org" user-emacs-directory)))
    570 #+end_src
    571 
    572 #+begin_src emacs-lisp
    573   (bind-key "C-c E" 'za/edit-config-org)
    574 #+end_src
    575 ** Visible mode
    576 #+begin_src emacs-lisp
    577   (bind-key (kbd "C-c q v") #'visible-mode)
    578 #+end_src
    579 ** Clone buffer indirectly by default
    580 #+begin_src emacs-lisp
    581   (bind-key (kbd "C-x x n") #'clone-indirect-buffer)
    582 #+end_src
    583 * Custom functions
    584 ** Make region readonly or writable
    585 #+begin_src emacs-lisp
    586   (defun za/set-region-read-only (begin end)
    587     "Sets the read-only text property on the marked region.
    588   Use `set-region-writeable' to remove this property."
    589     ;; See https://stackoverflow.com/questions/7410125
    590     (interactive "r")
    591     (with-silent-modifications
    592       (put-text-property begin end 'read-only t)))
    593 
    594   (defun za/set-region-writeable (begin end)
    595     "Removes the read-only text property from the marked region.
    596   Use `set-region-read-only' to set this property."
    597     ;; See https://stackoverflow.com/questions/7410125
    598     (interactive "r")
    599     (with-silent-modifications
    600       (remove-text-properties begin end '(read-only t))))
    601 #+end_src
    602 ** Insert macro as Lisp
    603 From here: https://www.masteringemacs.org/article/keyboard-macros-are-misunderstood
    604 
    605 #+begin_src emacs-lisp
    606   (use-package kmacro
    607     :ensure nil ; included with Emacs
    608     :bind (:map kmacro-keymap
    609                 ("I" . kmacro-insert-macro))
    610     :config
    611     (defalias 'kmacro-insert-macro 'insert-kbd-macro)
    612 
    613     ;; Add advice to ignore errors on `kmacro-keyboard-macro-p`, it was
    614     ;; messing up because of some entry in `obarray`
    615     (advice-add #'kmacro-keyboard-macro-p :around (lambda (fun sym) "Ignore errors." (ignore-errors (funcall fun sym)))))
    616 #+end_src
    617 ** Show local help at point when idling
    618 #+begin_src emacs-lisp
    619   (defun za/echo-area-tooltips ()
    620     "Show tooltips in the echo area automatically for current buffer."
    621     (setq-local help-at-pt-display-when-idle t
    622                 help-at-pt-timer-delay 0)
    623     (help-at-pt-cancel-timer)
    624     (help-at-pt-set-timer))
    625 #+end_src
    626 
    627 ** Info manual functions
    628 For some reason, these things don't show up in the index:
    629 
    630 #+begin_src emacs-lisp
    631   (defun elisp-info (&optional node)
    632     "Read documentation for Elisp in the info system.
    633   With optional NODE, go directly to that node."
    634     (interactive)
    635     (info (format "(elisp)%s" (or node ""))))
    636 #+end_src
    637 
    638 Though I can also just use ~info-display-manual~.
    639 
    640 ** Radio
    641 Just a wrapper function to my radio script:
    642 
    643 #+begin_src emacs-lisp
    644   (defun radio ()
    645     "Play an internet radio"
    646     (interactive)
    647     (ansi-term "radio" "*radio*"))
    648 #+end_src
    649 
    650 ** no-op
    651 #+begin_src emacs-lisp
    652   (defun za/no-op (&rest args))
    653 #+end_src
    654 
    655 ** Syncthing
    656 Some functions to start/stop syncthing.
    657 #+begin_src emacs-lisp
    658   (defconst za/st-buffer-name "*syncthing*" "Buffer name for the syncthing process.")
    659   (defun za/st ()
    660     "Start syncthing"
    661     (interactive)
    662     (if (get-buffer-process za/st-buffer-name)
    663         (user-error "Syncthing is already running."))
    664     (async-shell-command "syncthing serve --no-browser" za/st-buffer-name))
    665 
    666   (defun za/st-kill ()
    667     "Stop syncthing"
    668     (interactive)
    669     (unless (get-buffer-process za/st-buffer-name)
    670       (user-error "Syncthing is not running."))
    671     (async-shell-command "syncthing cli operations shutdown"))
    672 #+end_src
    673 ** Replace typographic quotes
    674 #+begin_src emacs-lisp
    675   (defun za/replace-typographic-quotes ()
    676     "Replace typographic quotes with plain quotes"
    677     (interactive)
    678     (save-mark-and-excursion
    679       (goto-char (point-min))
    680       (while (re-search-forward (rx (any ?“ ?”)) nil 'noerror)
    681         (replace-match "\""))
    682       (goto-char (point-min))
    683       (while (re-search-forward (rx (any "‘" "’")) nil 'noerror)
    684         (replace-match "'"))))
    685 #+end_src
    686 ** Distraction-free on current buffer
    687 #+begin_src emacs-lisp
    688   (defun za/buffer-focus-no-distractions ()
    689     "Focus on this buffer"
    690     (interactive)
    691     (cond ((or (not (boundp 'za/no-distractions))
    692                (not za/no-distractions))
    693            (olivetti-mode 1)
    694            (line-number-mode 0)
    695            (display-line-numbers-mode 0)
    696            (window-configuration-to-register ?w)
    697            (delete-other-windows)
    698            (setq-local za/tmp/mode-line-format mode-line-format)
    699            (setq-local mode-line-format nil)
    700            (setq-local za/tmp/internal-border-width (frame-parameter nil 'internal-border-width))
    701            (set-frame-parameter nil 'internal-border-width 20)
    702            (setq-local za/no-distractions t)
    703            (message "Window configuration stored in register W"))
    704           (za/no-distractions
    705            (set-frame-parameter nil 'internal-border-width za/tmp/internal-border-width)
    706            (line-number-mode 0)
    707            (display-line-numbers-mode 1)
    708            (setq-local mode-line-format za/tmp/mode-line-format)
    709            (jump-to-register ?w)
    710            (olivetti-mode 0)
    711            (setq-local za/no-distractions nil))))
    712 #+end_src
    713 * Interface
    714 ** Theme
    715 Icons required for some parts of the doom theme:
    716 
    717 #+begin_src emacs-lisp
    718   (use-package all-the-icons)
    719 #+end_src
    720 
    721 Load Doom Emacs themes:
    722 
    723 #+begin_src emacs-lisp
    724   (use-package doom-themes
    725     :config
    726     ;; Global settings (defaults)
    727     (setq doom-themes-enable-bold t    ; if nil, bold is universally disabled
    728           doom-themes-enable-italic t) ; if nil, italics is universally disabled
    729 
    730     ;; Enable flashing mode-line on errors
    731     (doom-themes-visual-bell-config)
    732 
    733     ;; Corrects (and improves) org-mode's native fontification.
    734     (doom-themes-org-config))
    735 #+end_src
    736 
    737 Define the themes I want:
    738 
    739 #+begin_src emacs-lisp
    740   (defconst za/dark-theme-name 'doom-one "A symbol representing the name of the dark theme I use.")
    741   (defconst za/light-theme-name 'jokull "A symbol representing the name of the light theme I use.")
    742   ;; I used to use doom-acario-light before writing my own theme
    743 
    744   (defun za/dark-theme ()
    745     "Switch to dark theme"
    746     (interactive)
    747     (mapc #'disable-theme custom-enabled-themes)
    748     (load-theme za/dark-theme-name t)
    749     (add-hook 'pdf-view-mode-hook #'pdf-view-midnight-minor-mode))
    750 
    751   (defun za/light-theme ()
    752     "Switch to light theme"
    753     (interactive)
    754     (mapc #'disable-theme custom-enabled-themes)
    755     (load-theme za/light-theme-name t)
    756     (remove-hook 'pdf-view-mode-hook #'pdf-view-midnight-minor-mode))
    757 #+end_src
    758 
    759 Change theme depending on the current system theme.
    760 The way I check for dark mode is defined in 'dark-mode-p'; currently I use the presence of the ~/.config/dark-theme file to indicate when dark theme is set.
    761 I quote the call to ~file-exists-p~ because I want to evaluate it on-demand, not immediately.
    762 A function ending in '-p' is a predicate, i.e. returns true or false.
    763 If calling a function that's in a variable, you have to use 'funcall'.
    764 To evaluate a quoted form, use 'eval'.
    765 
    766 #+begin_src emacs-lisp
    767   (defun za/auto-select-theme (&rest _)
    768     "Automatically select dark/light theme based on presence of ~/.config/dark-theme"
    769     (let ((dark-mode-p '(file-exists-p "~/.config/dark-theme")))
    770       (if (eval dark-mode-p)
    771           (za/dark-theme)
    772         (za/light-theme))))
    773 
    774   (za/auto-select-theme)
    775 #+end_src
    776 
    777 ** Font
    778 I want Menlo, size 12:
    779 
    780 #+begin_src emacs-lisp
    781   (add-to-list 'default-frame-alist '(font . "Menlo-13"))
    782   (custom-set-faces
    783    ; height = pt * 10
    784    '(fixed-pitch ((t (:family "Menlo" :height 130))))
    785    '(variable-pitch ((t (:family "ETBembo" :height 140))))
    786    '(org-block ((t (:inherit fixed-pitch))))
    787    '(org-table ((t (:foreground "#0087af" :inherit fixed-pitch))))
    788    '(org-indent ((t (:inherit (org-hide fixed-pitch))))))
    789 
    790   (set-face-font 'fixed-pitch "Menlo-13")
    791   (set-face-font 'variable-pitch "ETBembo-14")
    792 #+end_src
    793 
    794 I like nicer list bullets:
    795 
    796 #+begin_src emacs-lisp
    797   (font-lock-add-keywords
    798    'org-mode
    799    `((,(rx bol (* blank) (group ?-) " ")  ; list regexp
    800       1                                   ; first match
    801       '(face nil display "•"))))          ; replace with bullet point, keep same face
    802 #+end_src
    803 ** Cursor
    804 The default box cursor isn't really accurate, because the cursor is actually between letters, not on a letter.
    805 So, I want a bar instead of a box:
    806 
    807 #+begin_src emacs-lisp
    808   (setq-default cursor-type '(bar . 4)
    809                 cursor-in-non-selected-windows 'hollow)
    810 #+end_src
    811 
    812 (I use ~setq-default~ here because cursor-type is automatically buffer-local when it's set)
    813 
    814 And enable cursorline:
    815 
    816 #+begin_src emacs-lisp
    817   (global-hl-line-mode)
    818 #+end_src
    819 
    820 And visualize tab characters by stretching the cursor:
    821 
    822 #+begin_src emacs-lisp
    823   (setq-default x-stretch-cursor t)
    824 #+end_src
    825 ** Matching parentheses
    826 Don't add a delay to show matching parenthesis.
    827 Must come before show-paren-mode enable.
    828 
    829 #+begin_src emacs-lisp
    830   (setq show-paren-delay 0)
    831 #+end_src
    832 
    833 Show matching parentheses:
    834 
    835 #+begin_src emacs-lisp
    836   (show-paren-mode t)
    837 #+end_src
    838 ** Line numbers
    839 Relative line numbers:
    840 
    841 #+begin_src emacs-lisp
    842   (setq display-line-numbers-type 'relative)
    843   (global-display-line-numbers-mode)
    844 #+end_src
    845 
    846 Function to hide them:
    847 
    848 #+begin_src emacs-lisp
    849   (defun za/hide-line-numbers ()
    850     "Hide line numbers"
    851     (display-line-numbers-mode 0))
    852 #+end_src
    853 Don't display them in specific modes.  For each of the modes in
    854 'mode-hooks', add a function to hide line numbers when the mode
    855 activates (which triggers the 'mode'-hook).
    856 
    857 #+begin_src emacs-lisp
    858   (let ((mode-hooks '(doc-view-mode-hook vterm-mode-hook mpc-status-mode-hook mpc-tagbrowser-mode-hook)))
    859     (mapc
    860      (lambda (mode-name)
    861        (add-hook mode-name #'za/hide-line-numbers))
    862      mode-hooks))
    863 #+end_src
    864 ** Modeline
    865 I want to show the time and date in the modeline:
    866 
    867 #+begin_src emacs-lisp
    868   (setq display-time-day-and-date t           ; also the date
    869         display-time-default-load-average nil ; don't show load average
    870         display-time-format "%I:%M%p %e %b (%a)")   ; "HR:MIN(AM/PM) day-of-month Month (Day)"
    871   (display-time-mode 1)                  ; enable time mode
    872 #+end_src
    873 
    874 And to set the modeline format:
    875 
    876 #+begin_src emacs-lisp
    877   (setq-default mode-line-format '("%e" mode-line-front-space mode-line-mule-info mode-line-client mode-line-modified mode-line-remote mode-line-frame-identification mode-line-buffer-identification "   " mode-line-position
    878                                    (vc-mode vc-mode)
    879                                    "  " mode-line-modes mode-line-misc-info mode-line-end-spaces))
    880 #+end_src
    881 
    882 I want to hide certain modes from the modeline.
    883 For that, ~delight~ is a useful package; unlike ~diminish~, it can also change the display of /major/ modes (~diminish~ only does minor modes).
    884 
    885 #+begin_src emacs-lisp
    886     (use-package delight
    887       :config
    888       (delight 'visual-line-mode " ↩" 'simple)
    889       (delight 'auto-revert-mode " AR" 'autorevert)
    890       (delight 'abbrev-mode " Abv" 'abbrev))
    891 #+end_src
    892 ** Transparent title bar
    893 #+begin_src emacs-lisp
    894   (add-to-list 'default-frame-alist '(ns-transparent-titlebar . t))
    895 #+end_src
    896 ** Frame title
    897 #+begin_src emacs-lisp
    898   (setopt frame-title-format "%F--%b-[%f]--%Z")
    899 #+end_src
    900 
    901 ** Tab bar
    902 Only show tab bar if there's more than 1 tab:
    903 
    904 #+begin_src emacs-lisp
    905   (setq tab-bar-show 1)
    906 #+end_src
    907 ** Buffer displaying
    908 
    909 So, this is a bit hard to grok. But basically the alist contains a
    910 regular expression to match a buffer name, then a list of functions to
    911 use in order for displaying the list, and then options for those functions (each of which is an alist).
    912 
    913 #+begin_src emacs-lisp
    914   (setq
    915    ;; Maximum number of side-windows to create on (left top right bottom)
    916    window-sides-slots '(0   ;; left
    917                         1   ;; top
    918                         3   ;; right
    919                         1 ) ;; bottom
    920 
    921    display-buffer-alist `(
    922                           ;; Right side
    923                           (,(rx (or "*Help*" (seq "*helpful " (* anything) "*")))
    924                            (display-buffer-reuse-window display-buffer-in-side-window)
    925                            (side . right)
    926                            (slot . -1)
    927                            (inhibit-same-window . t))
    928                           (,(rx "*Async Shell " (* anything) "*")
    929                            (display-buffer-reuse-window display-buffer-in-side-window)
    930                            (side . right)
    931                            (slot . 0)
    932                            (inhibit-same-window . t))
    933                           (,(rx "magit-process: " (* anything))
    934                            (display-buffer-reuse-window display-buffer-in-side-window)
    935                            (side . right)
    936                            (slot . 0)
    937                            (inhibit-same-window . t))
    938 
    939                           ;; Top side
    940                           (,(rx "*Info*")
    941                            (display-buffer-reuse-window display-buffer-in-side-window)
    942                            (side . top)
    943                            (slot . 0))
    944                           (,(rx "*Man " (* anything) "*")
    945                            (display-buffer-reuse-window display-buffer-in-side-window)
    946                            (side . top)
    947                            (slot . 0))
    948 
    949                           ;; Bottom
    950                           (,(rx "*Flycheck errors*")
    951                            (display-buffer-reuse-window display-buffer-in-side-window)
    952                            (side . bottom)
    953                            (slot . 0))))
    954 #+end_src
    955 
    956 And a way to toggle those side windows:
    957 
    958 #+begin_src emacs-lisp
    959   (bind-key "C-c W" #'window-toggle-side-windows)
    960 #+end_src
    961 
    962 ** Eldoc
    963 When editing Elisp and other supported major-modes, Eldoc will display useful information about the construct at point in the echo area.
    964 
    965 #+begin_src emacs-lisp
    966   (use-package eldoc
    967     :ensure nil ; installed with Emacs
    968     :delight
    969     :config
    970     (global-eldoc-mode 1))
    971 #+end_src
    972 
    973 ** Pulse line
    974 When you switch windows, Emacs can flash the cursor briefly to guide your eyes; I like that.
    975 Set some options for pulsing:
    976 
    977 #+begin_src emacs-lisp
    978   (setq pulse-iterations 10)
    979   (setq pulse-delay 0.05)
    980 #+end_src
    981 
    982 Define the pulse function:
    983 
    984 #+begin_src emacs-lisp
    985   (defun pulse-line (&rest _)
    986     "Pulse the current line."
    987     (pulse-momentary-highlight-one-line (point)))
    988 #+end_src
    989 
    990 Run it in certain cases: scrolling up/down, recentering, switching windows.
    991 'dolist' binds 'command' to each value in the list in turn, and runs the body.
    992 'advice-add' makes the pulse-line function run after 'command'.
    993 
    994 #+begin_src emacs-lisp
    995   (dolist (command '(scroll-up-command scroll-down-command recenter-top-bottom other-window))
    996     (advice-add command :after #'pulse-line))
    997 #+end_src
    998 
    999 And set the pulse color:
   1000 
   1001 #+begin_src emacs-lisp
   1002   (custom-set-faces '(pulse-highlight-start-face ((t (:background "CadetBlue2")))))
   1003 #+end_src
   1004 
   1005 ** Enable all commands
   1006 By default, Emacs disables some commands.
   1007 I want to have these enabled so I don't get a prompt whenever I try to use a disabled command.
   1008 
   1009 #+begin_src emacs-lisp
   1010   (setq disabled-command-function nil)
   1011 #+end_src
   1012 ** More extensive apropos
   1013 #+begin_src emacs-lisp
   1014   (setq apropos-do-all t)
   1015 #+end_src
   1016 ** Enable recursive minibuffers
   1017 #+begin_src emacs-lisp
   1018   (setq enable-recursive-minibuffers t
   1019         minibuffer-depth-indicate-mode t)
   1020 #+end_src
   1021 ** View webp and other formats
   1022 Emacs handles common image formats internally, but for stuff like webp, you need an external converter:
   1023 
   1024 #+begin_src emacs-lisp
   1025   (setq image-use-external-converter t)
   1026 #+end_src
   1027 
   1028 You also need imagemagick installed.
   1029 
   1030 ** Repeat mode: easy repeating of commands
   1031 #+begin_src emacs-lisp
   1032   (repeat-mode 1)
   1033 #+end_src
   1034 
   1035 ** Messages
   1036 Hide some messages I don't need.
   1037 
   1038 #+begin_src emacs-lisp
   1039   (recentf-mode)
   1040   (setq inhibit-startup-message t)
   1041 #+end_src
   1042 
   1043 ** Start buffer (dashboard)
   1044 #+begin_src emacs-lisp
   1045   (use-package dashboard
   1046     :custom
   1047     (dashboard-startup-banner 'logo)
   1048     (dashboard-items '((gtd-inbox-counts . 3)
   1049                        (syncthing-status . 3)
   1050                        (recents . 5)
   1051                        (bookmarks . 5)))
   1052 
   1053 
   1054     :bind (:map dashboard-mode-map
   1055                 ("ss" . za/st)
   1056                 ("sk" . za/st-kill)
   1057                 ("J" . org-clock-goto))
   1058     :config
   1059     (add-to-list 'dashboard-item-generators '(gtd-inbox-counts . dashboard-insert-gtd-inbox-counts))
   1060     (add-to-list 'dashboard-item-generators '(syncthing-status . dashboard-insert-syncthing-status))
   1061 
   1062     (defun za/quotes-from-my-site ()
   1063       (let* ((quotes-file (concat za/my-website-dir "content/quotes.md"))
   1064              ;; Reformat quotes for display in dashboard
   1065              (file-contents (with-temp-buffer
   1066                               (insert-file-contents quotes-file)
   1067                               (re-search-forward (rx bol "> "))
   1068                               (delete-region (point-min) (pos-bol))
   1069                               (goto-char (point-min))
   1070                               (save-excursion (replace-regexp (rx bol ">" (* " ") (? "\n")) ""))
   1071                               (save-excursion (replace-regexp (rx eol "\n") "  "))
   1072                               (buffer-substring-no-properties (point-min) (point-max)))))
   1073         ;; Split file into individual quotes
   1074         (split-string file-contents "  ---  ")))
   1075 
   1076     (defun za/quotes-manual ()
   1077       '("The Universe is under no obligation to make sense to you."
   1078         "I would like to die on Mars. Just not on impact."
   1079         "That's one small step for a man, one giant leap for mankind."
   1080         "We choose to go to the moon in this decade and do the other things, not because they are easy, but because they are hard, because that goal will serve to organize and measure the best of our energies and skills, because that challenge is one that we are willing to accept, one we are unwilling to postpone, and one which we intend to win."
   1081         "Space is for everybody. It’s not just for a few people in science or math, or for a select group of astronauts. That’s our new frontier out there, and it’s everybody’s business to know about space."
   1082         "On one side are those who believe space travel is difficult work, but who go for it anyway. On the other are those who believe caring for a goldfish is, and who don’t go after much of anything. Where we choose to seed ourselves on the spectrum of what’s possible is what will ultimately define the size of our lives."))
   1083 
   1084     ;; Have to redefine this, original one has wrong type
   1085     (defcustom dashboard-footer-messages
   1086     '("The one true editor, Emacs!"
   1087       "Who the hell uses VIM anyway? Go Evil!"
   1088       "Free as free speech, free as free Beer"
   1089       "Happy coding!"
   1090       "Vi Vi Vi, the editor of the beast"
   1091       "Welcome to the church of Emacs"
   1092       "While any text editor can save your files, only Emacs can save your soul"
   1093       "I showed you my source code, pls respond")
   1094     "A list of messages, one of which dashboard chooses to display."
   1095     :type '(repeat string)
   1096     :group 'dashboard)
   1097 
   1098     ;; Use my saved quotes in the dashboard (https://alex.balgavy.eu/quotes/)
   1099     (setopt dashboard-footer-messages
   1100           (let* ((quotes (if (boundp 'za/my-website-dir) (za/quotes-from-my-site) (za/quotes-manual))))
   1101             ;; Run each quote through fill-region for better display
   1102             (require 's)
   1103             (mapcar (lambda (quote-line)
   1104                       (with-temp-buffer
   1105                         (insert (s-trim quote-line))
   1106                         (fill-region (point-min) (point-max))
   1107                         (buffer-substring-no-properties (point-min) (point-max))))
   1108                     quotes))))
   1109 
   1110   (defun dashboard-insert-gtd-inbox-counts (list-size)
   1111     (require 'org-roam)
   1112     (let* ((lines-inbox (za/org-count-headlines-in-file 1 za/org-life-inbox))
   1113            (lines-mobile (if (boundp 'za/org-life-inbox-mobile) (za/org-count-headlines-in-file 1 za/org-life-inbox-mobile) 0))
   1114            (count-docs (length (directory-files za/org-life-doc-inbox nil (rx bos (not ?.)))))
   1115            (item-list))
   1116 
   1117       (when (> lines-inbox 0)
   1118         (push (list :name "Inbox" :count lines-inbox :file za/org-life-inbox) item-list))
   1119       (when (> lines-mobile 0)
   1120         (push (list :name "Mobile" :count lines-mobile :file za/org-life-inbox-mobile) item-list))
   1121       (when (> count-docs 0)
   1122         (push (list :name "Docs" :count count-docs :file za/org-life-doc-inbox) item-list))
   1123 
   1124       (dashboard-insert-section
   1125        ;; Widget title
   1126        "GTD:"
   1127        ;; list generated for dashboard
   1128        item-list
   1129        list-size
   1130        'gtd
   1131        "t"
   1132        ;; decide what to do when clicked ("el" is automatically assigned)
   1133        `(lambda (&rest _)
   1134           (message "%s" (find-file (plist-get ',el :file))))
   1135        ;; show how list is shown in dashboard ("el" is automatically assigned)
   1136        (format "%s: %s" (plist-get el :name) (plist-get el :count)))))
   1137 
   1138   (defun dashboard-insert-syncthing-status (list-size)
   1139     (when (and (get-buffer-process za/st-buffer-name)
   1140                (boundp 'za/syncthing-api-key))
   1141       (let* ((syncstatus (json-parse-string
   1142                           (shell-command-to-string
   1143                            (format "curl -sH 'Authorization: Bearer %s' 'http://localhost:8384/rest/db/completion'" za/syncthing-api-key))))
   1144              (completion (gethash "completion" syncstatus))
   1145              (folders (json-parse-string
   1146                        (shell-command-to-string
   1147                         (format "curl -sH 'Authorization: Bearer %s' 'http://localhost:8384/rest/stats/folder'" za/syncthing-api-key))
   1148                        :false-object nil
   1149                        :null-object nil))
   1150              (org-lastsync (format-time-string "%H:%M:%S (%F)" (date-to-time (gethash "lastScan" (gethash "lifeorg" folders)))))
   1151              (devices (json-parse-string
   1152                        (shell-command-to-string
   1153                         (format "curl -sH 'Authorization: Bearer %s' 'http://localhost:8384/rest/system/connections'" za/syncthing-api-key))
   1154                        :object-type 'alist
   1155                        :false-object nil
   1156                        :null-object nil))
   1157              (connected-devices (length (seq-filter
   1158                                          (lambda (a)
   1159                                            (alist-get 'connected (cdr a))) (alist-get 'connections devices))))
   1160              (item-list `(,(format "Completion: %s%%" completion)
   1161                           ,(format "Connected devices: %s" connected-devices)
   1162                           ,(format "Org last sync: %s" org-lastsync))))
   1163 
   1164         (dashboard-insert-section
   1165          ;; Widget title
   1166          "Syncthing:"
   1167          ;; list generated for dashboard
   1168          item-list
   1169          list-size
   1170          'syncthing-status
   1171          ;; shortcut key for section
   1172          nil
   1173          ;; when clicked
   1174          (lambda (&rest _) ())
   1175          ;; show how list is shown in dashboard ("el" is automatically assigned)
   1176          (format "%s" el)))))
   1177 
   1178   (dashboard-setup-startup-hook)
   1179   (setq initial-buffer-choice (lambda () (get-buffer-create "*dashboard*")))
   1180 #+end_src
   1181 
   1182 ** Scrolling
   1183 #+begin_src emacs-lisp
   1184   (setopt scroll-step 1)
   1185   ;; Marker distance from center
   1186   (setopt scroll-conservatively 100000)
   1187   ;; Keep screen position on scroll
   1188   (setopt scroll-preserve-screen-position 1)
   1189   ;; Start scrolling when marker at top/bottom
   1190   (setopt scroll-margin 0)
   1191 
   1192   ;; Mouse scrolls 1 line at a time
   1193   (setopt mouse-wheel-scroll-amount '(1))
   1194 
   1195   ;; On a long mouse scroll keep scrolling by 1 line
   1196   (setq mouse-wheel-progressive-speed nil)
   1197 
   1198   ;; Enable pixel scroll precision mode
   1199   (unless (version< emacs-version "29")
   1200     (pixel-scroll-precision-mode))
   1201 
   1202   ;; Speed up cursor movement.
   1203   ;; https://emacs.stackexchange.com/questions/28736/emacs-pointcursor-movement-lag/28746
   1204   (setopt auto-window-vscroll nil)
   1205 #+end_src
   1206 * General packages
   1207 
   1208 ** which-key
   1209 Minor mode for Emacs that displays the key bindings following your currently entered incomplete command (a prefix) in a popup.
   1210 
   1211 #+BEGIN_SRC emacs-lisp
   1212   (use-package which-key
   1213     :delight
   1214     :config
   1215     (which-key-mode))
   1216 #+end_src
   1217 
   1218 ** counsel + ivy + swiper + prescient
   1219 Better incremental completion and selection narrowing.
   1220 And a bunch more.
   1221 Generally makes for nicer interactivity, like ido mode on steroids.
   1222 Switched to this from Helm, it's more lightweight.
   1223 
   1224 *** ivy: generic completion mechanism
   1225 #+begin_src emacs-lisp
   1226   (use-package ivy
   1227     :delight
   1228     :custom
   1229     (ivy-use-virtual-buffers t "extend searching to bookmarks")
   1230     (ivy-height 20 "set height of the ivy window")
   1231     (ivy-count-format "(%d/%d) " "count format, from the ivy help page")
   1232     (ivy-display-style 'fancy)
   1233     (ivy-format-function 'ivy-format-function-line)
   1234     (ivy-use-selectable-prompt t "to let me select exactly what I'm typing as a candidate")
   1235 
   1236     :bind (("C-x b" . ivy-switch-buffer)
   1237            ("C-c v" . ivy-push-view)
   1238            ("C-c V" . ivy-pop-view)
   1239 
   1240            ;; accidentally pressing shift-space deletes input, because
   1241            ;; by default, shift-space is bound to
   1242            ;; ~ivy-restrict-to-matches~ in the ivy minibuffer.
   1243            :map ivy-minibuffer-map
   1244            ("S-SPC" . (lambda () (interactive) (insert ?\s)))
   1245            ("<backtab>" . ivy-restrict-to-matches))
   1246     :config
   1247     (ivy-add-actions
   1248      'counsel-dired
   1249      '(("f" (lambda (dir) (counsel-fzf nil dir)) "Fzf in directory")
   1250        ("g" (lambda (dir) (counsel-ag nil dir)) "Ag in directory")))
   1251     (ivy-add-actions
   1252      'dired
   1253      '(("f" (lambda (dir) (ivy-exit-with-action (counsel-fzf nil dir))) "Fzf in directory")
   1254        ("g" (lambda (dir) (ivy-exit-with-action (counsel-ag nil dir))) "Ag in directory")))
   1255     (ivy-add-actions
   1256      'counsel-describe-function
   1257      '(("d" (lambda (fun) (ivy-exit-with-action (edebug-instrument-function (intern fun)))) "Edebug instrument function")))
   1258     (ivy-mode)
   1259 
   1260     (defun edit-script ()
   1261       "Edit a file in ~/.scripts/"
   1262       (interactive)
   1263       (let ((input (ivy--input)))
   1264         (ivy-quit-and-run (counsel-file-jump nil "~/.scripts/"))))
   1265 
   1266     (defun edit-config ()
   1267       "Edit a file in ~/.dotfiles/"
   1268       (interactive)
   1269       (let ((input (ivy--input)))
   1270         (ivy-quit-and-run (counsel-file-jump nil "~/.dotfiles/")))))
   1271 #+end_src
   1272 
   1273 *** counsel: collection of common Emacs commands enhanced using ivy
   1274 #+begin_src emacs-lisp
   1275   (use-package counsel
   1276     :demand
   1277     :delight
   1278     :config
   1279     (counsel-mode)
   1280     :bind (("M-x" . counsel-M-x)
   1281            ("C-x C-f" . counsel-find-file)
   1282            ("M-y" . counsel-yank-pop)
   1283            ("C-c c" . counsel-compile)
   1284            ("M-s g" . counsel-rg)
   1285            ("M-s f" . counsel-fzf)
   1286            ("C-c b" . counsel-bookmark)
   1287            ("C-c p" . counsel-recentf)
   1288            ("C-c o" . counsel-outline)
   1289            ("C-h f" . counsel-describe-function)
   1290            ("C-h v" . counsel-describe-variable)
   1291            ("C-h o" . counsel-describe-symbol)
   1292            ("C-c g j" . counsel-org-agenda-headlines)))
   1293 #+end_src
   1294 *** swiper: search enhanced using ivy
   1295 #+begin_src emacs-lisp
   1296   (use-package swiper
   1297     :bind (("C-s" . swiper-isearch)
   1298            ("C-r" . swiper-isearch-backward)))
   1299 #+end_src
   1300 *** prescient: scoring system for M-x
   1301 #+begin_src emacs-lisp
   1302   (use-package prescient
   1303     :config (prescient-persist-mode))
   1304 
   1305   (use-package ivy-prescient
   1306     :after counsel
   1307     :custom (ivy-prescient-retain-classic-highlighting t)
   1308     :config (ivy-prescient-mode))
   1309 #+end_src
   1310 
   1311 *** ivy-posframe: ivy in a popup
   1312 I like having ivy in a popup.
   1313 Problem: posframe does not work if emacs is too old and on macos.
   1314 See here: https://github.com/tumashu/posframe/issues/30
   1315 On Mac, ~brew install --HEAD emacs~ doesn't work either.
   1316 Solution: ~brew tap daviderestivo/emacs-head && brew install emacs-head@28 --with-cocoa~
   1317 
   1318 #+begin_src emacs-lisp
   1319   (if (and (version< emacs-version "28") (equal system-type 'darwin))
   1320       (message "ivy-posframe won't work properly, run `brew install daviderestivo/emacs-head/emacs-head@28 --with-cocoa`")
   1321     (use-package ivy-posframe
   1322       :delight
   1323       :custom
   1324       (ivy-posframe-display-functions-alist '((t . ivy-posframe-display-at-frame-center)))
   1325       (ivy-posframe-parameters
   1326        '((left-fringe . 8)
   1327          (right-fringe . 8)))
   1328       (ivy-posframe-border-width 3)
   1329       (ivy-truncate-lines nil) ;; otherwise the cursor gets hidden by long lines in posframe
   1330       :custom-face
   1331       (ivy-posframe-border ((t (:inherit mode-line-inactive))))
   1332       :config
   1333       (ivy-posframe-mode 1)))
   1334 #+end_src
   1335 
   1336 [[https://github.com/tumashu/ivy-posframe/issues/123][See here]] for cursor going offscreen in the posframe. Currently 'solved' with ~ivy-truncate-lines~ nil.
   1337 
   1338 ** DISABLED vertico + consult + marginalia + embark + posframe + prescient
   1339 Alternative to counsel/ivy/swiper, will probably switch to this at some point.
   1340 [[https://old.reddit.com/r/emacs/comments/qfrxgb/using_emacs_episode_80_vertico_marginalia_consult/hi6mfh7/][Here]] is a good comparison.
   1341 
   1342 A [[https://old.reddit.com/r/emacs/comments/11lqkbo/weekly_tips_tricks_c_thread/jbe06qv/][comment here to follow]] when I switch to vertico.
   1343 #+begin_src emacs-lisp :tangle no
   1344   (dolist (pack '(vertico consult marginalia embark vertico-posframe vertico-prescient))
   1345     (unless (package-installed-p pack)
   1346       (package-install pack))
   1347     (require pack))
   1348 
   1349   (vertico-mode 1)
   1350   (vertico-posframe-mode 1)
   1351   (marginalia-mode 1)
   1352   (vertico-prescient-mode 1)
   1353   (setq completion-styles '(basic substring partial-completion flex))
   1354 
   1355   (global-set-key (kbd "M-o") #'embark-act)
   1356   (global-set-key (kbd "C-s") #'consult-line)
   1357 
   1358 #+end_src
   1359 ** company: completion mechanism
   1360 #+begin_src emacs-lisp
   1361   (use-package company)
   1362 #+end_src
   1363 
   1364 ** wgrep: writable grep
   1365 #+begin_src emacs-lisp
   1366   (use-package wgrep)
   1367 #+end_src
   1368 ** avy: jump to any position
   1369 This lets me jump to any position in Emacs rather quickly, sometimes it's useful.
   1370 ~avy-goto-char-timer~ lets me type a part of the text before avy kicks in.
   1371 
   1372 #+begin_src emacs-lisp
   1373   (use-package avy
   1374     :custom
   1375     (avy-single-candidate-jump nil "Often I want to perform an action, never jump automatically")
   1376     :bind
   1377     (("C-:" . avy-goto-char-timer)))
   1378 #+end_src
   1379 
   1380 ** calendar
   1381 #+begin_src emacs-lisp
   1382   (use-package calendar
   1383     :ensure nil ; comes with Emacs
   1384     :custom
   1385     (calendar-week-start-day 1))
   1386 #+end_src
   1387 ** calfw: graphical calendar
   1388 Basically provides a way to show the org agenda as a standard GUI calendar app would.
   1389 
   1390 #+begin_src emacs-lisp
   1391   (use-package calfw
   1392     :config
   1393     (use-package calfw-org)
   1394     :custom
   1395     (cfw:org-overwrite-default-keybinding t))
   1396 #+end_src
   1397 
   1398 ** vanish: hide parts of the file
   1399 #+begin_src emacs-lisp
   1400   (use-package vanish
   1401     :init
   1402     (za/package-vc-install :repo "thezeroalpha/vanish.el" :rev "develop")
   1403     (require 'vanish)
   1404     :ensure nil
   1405     :bind (:map vanish-mode-map
   1406                 ("C-c q h h" . vanish-hide-dwim)
   1407                 ("C-c q h u r" . vanish-show-all-regions)
   1408                 ("C-c q h u e" . vanish-elt-unhide)
   1409                 ("C-c q h u u" . vanish-show-all)))
   1410 #+end_src
   1411 ** magit
   1412 #+begin_src emacs-lisp
   1413   (use-package magit)
   1414 #+end_src
   1415 ** vterm
   1416 Emacs has a bunch of built-in terminal emulators.
   1417 And they all suck.
   1418 (OK not really, eshell is alright, but not for interactive terminal programs like newsboat/neomutt)
   1419 
   1420 Also use emacsclient inside vterm as an editor, because that'll open documents in the existing Emacs session.
   1421 And I'm not gonna be a heretic and open Vim inside of Emacs.
   1422 
   1423 #+begin_src emacs-lisp
   1424   (use-package vterm
   1425     :hook
   1426     (vterm-mode . (lambda () (unless server-process (server-start))))
   1427     :bind (("C-c t" . switch-to-vterm))
   1428     :config
   1429     (defun switch-to-vterm ()
   1430       "Switch to a running vterm, or start one and switch to it."
   1431       (interactive)
   1432       (if (get-buffer vterm-buffer-name)
   1433           (switch-to-buffer vterm-buffer-name)
   1434         (vterm))))
   1435 #+end_src
   1436 ** sr-speedbar
   1437 Make speed bar show in the current frame.
   1438 
   1439 #+begin_src emacs-lisp
   1440   (use-package sr-speedbar
   1441     :bind (("C-c F" . za/jump-to-speedbar-or-open)
   1442            :map speedbar-mode-map
   1443            ("q" . sr-speedbar-close))
   1444     :custom
   1445     (sr-speedbar-right-side nil)
   1446 
   1447     :config
   1448     (defun za/jump-to-speedbar-or-open ()
   1449       "Open a speedbar or jump to it if already open."
   1450       (interactive)
   1451       (if (or (not (boundp 'sr-speedbar-exist-p))
   1452               (not (sr-speedbar-exist-p)))
   1453           (sr-speedbar-open))
   1454       (sr-speedbar-select-window)))
   1455 #+end_src
   1456 ** expand-region
   1457 Expand the selected region semantically.
   1458 
   1459 #+begin_src emacs-lisp
   1460   (use-package expand-region
   1461     :bind ("C-=" . er/expand-region))
   1462 #+end_src
   1463 ** flycheck
   1464 Install flycheck:
   1465 
   1466 #+begin_src emacs-lisp
   1467   (use-package flycheck)
   1468 #+end_src
   1469 ** rainbow-mode: visualise hex colors
   1470 'rainbow-mode' lets you visualise hex colors:
   1471 
   1472 #+begin_src emacs-lisp
   1473   (use-package rainbow-mode)
   1474 #+end_src
   1475 ** hl-todo: highlight TODO keywords
   1476 I want to highlight TODO keywords in comments:
   1477 
   1478 #+begin_src emacs-lisp
   1479   (use-package hl-todo
   1480     :custom-face
   1481     (hl-todo ((t (:inherit hl-todo :underline t))))
   1482     :custom
   1483     (hl-todo-keyword-faces '(("TODO"   . "#ff7060")
   1484                              ("FIXME"  . "#caa000")))
   1485     :config
   1486     (global-hl-todo-mode t))
   1487 #+end_src
   1488 ** undo-tree
   1489 Sometimes it's better to look at undo history as a tree:
   1490 
   1491 #+begin_src emacs-lisp
   1492   (use-package undo-tree
   1493     :delight
   1494     :custom
   1495     (undo-tree-history-directory-alist
   1496      (progn (let ((undo-tree-dir (concat user-emacs-directory "undo-tree/")))
   1497               (unless (file-directory-p undo-tree-dir) (make-directory undo-tree-dir))
   1498               `(("." . ,undo-tree-dir)))))
   1499 
   1500     :config
   1501     (global-undo-tree-mode))
   1502 #+end_src
   1503 
   1504 *** TODO undo tree dir should be configurable
   1505 ** eglot
   1506 A good LSP plugin.
   1507 
   1508 #+begin_src emacs-lisp
   1509   (use-package eglot)
   1510 #+end_src
   1511 ** crdt
   1512 Collaborative editing in Emacs:
   1513 
   1514 #+begin_src emacs-lisp
   1515   (use-package crdt)
   1516 #+end_src
   1517 ** git gutter
   1518 General git gutter:
   1519 
   1520 #+begin_src emacs-lisp
   1521   (use-package git-gutter
   1522     :bind (("C-c d n" . git-gutter:next-hunk)
   1523            ("C-c d p" . git-gutter:previous-hunk))
   1524     :config
   1525     (global-git-gutter-mode 1))
   1526 #+end_src
   1527 ** keycast
   1528 In case I want to show what keys I'm pressing.
   1529 
   1530 #+begin_src emacs-lisp
   1531   (use-package keycast)
   1532 #+end_src
   1533 ** ace-window: better window switching
   1534 Window switching with ~other-window~ sucks when I have more than 2 windows open. Too much cognitive load.
   1535 This lets me select a window to jump to using a single key, sort of like ~avy~.
   1536 
   1537 #+begin_src emacs-lisp
   1538   (use-package ace-window
   1539     :custom
   1540     (aw-keys '(?a ?s ?d ?f ?g ?h ?j ?k ?l) "I prefer using home-row keys instead of numbers")
   1541 
   1542     :custom-face
   1543     ;; I want something a little more contrasty
   1544     (aw-leading-char-face ((t (:inherit font-lock-keyword-face :height 2.0))))
   1545 
   1546     :bind ("M-o" . ace-window))
   1547 #+end_src
   1548 ** decide-mode for dice rolling
   1549 #+begin_src emacs-lisp
   1550   (use-package decide
   1551     :init (za/package-vc-install :repo "lifelike/decide-mode" :name "decide")
   1552     :ensure nil
   1553     :bind ("C-c q ?" . decide-mode))
   1554 #+end_src
   1555 
   1556 ** try: try out different packages
   1557 #+begin_src emacs-lisp
   1558   (use-package try)
   1559 #+end_src
   1560 ** dumb-jump
   1561 "jump to definition" package, minimal configuration with no stored indexes.
   1562 Uses The Silver Searcher ag, ripgrep rg, or grep to find potential definitions of a function or variable under point.
   1563 
   1564 #+begin_src emacs-lisp
   1565   (use-package dumb-jump)
   1566 #+end_src
   1567 
   1568 Enable xref backend:
   1569 
   1570 #+begin_src emacs-lisp
   1571   (add-hook 'xref-backend-functions #'dumb-jump-xref-activate)
   1572   (setq xref-show-definitions-function #'xref-show-definitions-completing-read)
   1573 #+end_src
   1574 ** DISABLED command-log-mode
   1575 Simple real-time logger of commands.
   1576 
   1577 #+begin_src emacs-lisp :tangle no
   1578   (use-package command-log-mode)
   1579 #+end_src
   1580 ** package-lint
   1581 Linter for the metadata in Emacs Lisp files which are intended to be packages.
   1582 
   1583 #+begin_src emacs-lisp
   1584   (use-package package-lint)
   1585   (use-package flycheck-package)
   1586   (eval-after-load 'flycheck
   1587     '(flycheck-package-setup))
   1588 #+end_src
   1589 ** prism: change color of text depending on depth
   1590 Prism changes the color of text depending on their depth. Makes it easier to see where something is at a glance.
   1591 
   1592 #+begin_src emacs-lisp
   1593   (use-package prism)
   1594 #+end_src
   1595 ** olivetti: distraction-free writing
   1596 #+begin_src emacs-lisp
   1597   (use-package olivetti
   1598     :diminish)
   1599 #+end_src
   1600 ** nov.el: EPUB support
   1601 #+begin_src emacs-lisp
   1602   (use-package nov)
   1603   (add-to-list 'auto-mode-alist '("\\.epub\\'" . nov-mode))
   1604 #+end_src
   1605 ** god-mode: reduce the need to hold down modifier keys
   1606 - All commands are assumed to use the control modifier (C-) unless otherwise indicated.
   1607 - g is used to indicate the meta modifier
   1608 - G is used to indicate both the control and meta modifiers
   1609 #+begin_src emacs-lisp
   1610   (use-package god-mode
   1611     :bind
   1612     (("s-<escape>" . god-mode-all)
   1613      :map god-local-mode-map
   1614      ("z" . repeat)
   1615      ("i" . god-local-mode))
   1616     :hook    (post-command . za/god-mode-update-mode-line)
   1617     :config
   1618     (defun za/god-mode-update-mode-line ()
   1619       "Update the color of the modeline depending on god-mode."
   1620       (cond (god-local-mode
   1621              (set-face-attribute 'mode-line nil :background "#770085"))
   1622             (t
   1623              (let* ((current-theme (car custom-enabled-themes))
   1624                      (theme-settings (get current-theme 'theme-settings)))
   1625                 (dolist (theme-setting theme-settings)
   1626                   (if (and (eq (car theme-setting) 'theme-face)
   1627                            (eq (cadr theme-setting) 'mode-line))
   1628                       (let* ((face-def (caar (last theme-setting)))
   1629                              (properties (car (last face-def)))
   1630                              (bg (plist-get properties :background)))
   1631                         (set-face-attribute 'mode-line nil :background bg)))))))))
   1632 #+end_src
   1633 ** devil: alternative to god-mode that uses a comma
   1634 #+begin_src emacs-lisp
   1635   (use-package devil
   1636     :init
   1637     (za/package-vc-install :repo "susam/devil")
   1638     (require 'devil)
   1639     :custom
   1640     (devil-lighter " \u272A")
   1641     (devil-prompt "\u272A %t")
   1642     :config (global-devil-mode)
   1643     :bind ("C-," . global-devil-mode))
   1644 #+end_src
   1645 ** academic-phrases
   1646 Gives ideas for phrases to use in academic writing.
   1647 #+begin_src emacs-lisp
   1648   (use-package academic-phrases)
   1649 #+end_src
   1650 ** ediff
   1651 #+begin_src emacs-lisp
   1652   (use-package ediff
   1653     :custom
   1654     ((ediff-keep-variants nil "Prompt to remove unmodifid buffers after session")
   1655      (ediff-make-buffers-readonly-at-startup nil "Don't make all buffers read-only at startup")
   1656      (ediff-show-clashes-only t "Only show diff regions where both buffers disagree with ancestor")
   1657      (ediff-split-window-function 'split-window-horizontally "I want long vertical side-by-side windows")
   1658      (ediff-window-setup-function 'ediff-setup-windows-plain "Everything in one frame please")))
   1659 #+end_src
   1660 ** highlight-indent-guides
   1661 #+begin_src emacs-lisp
   1662   (use-package highlight-indent-guides
   1663     :hook (yaml-mode . highlight-indent-guides-mode)
   1664     :custom
   1665     ((highlight-indent-guides-method 'character))
   1666     :custom-face
   1667     (highlight-indent-guides-character-face ((t (:foreground "#adadad")))))
   1668 #+end_src
   1669 ** cc-avy
   1670 #+begin_src emacs-lisp
   1671   (use-package cc-avy
   1672     :ensure nil ; local
   1673     :bind ("C-M-:" . cc/avy-menu))
   1674 #+end_src
   1675 ** annotate
   1676 #+begin_src emacs-lisp
   1677   (use-package annotate
   1678     :custom (annotate-annotation-position-policy :margin)
   1679     :config
   1680     (defun za/annotate-initialize-extra-hooks ()
   1681       (add-hook 'after-save-hook #'annotate-save-annotations t t))
   1682     (defun za/annotate-shutdown-extra-hooks ()
   1683       (remove-hook 'after-save-hook #'annotate-save-annotations t))
   1684     (advice-add 'annotate-initialize :after #'za/annotate-initialize-extra-hooks)
   1685     (advice-add 'annotate-shutdown :after #'za/annotate-shutdown-extra-hooks))
   1686 
   1687 #+end_src
   1688 ** org-remark
   1689 #+begin_src emacs-lisp
   1690   (use-package org-remark
   1691     :bind (;; :bind keyword also implicitly defers org-remark itself.
   1692            ;; Keybindings before :map is set for global-map. Adjust the keybinds
   1693            ;; as you see fit.
   1694            :map org-mode-map
   1695            ("C-c C-/ m" . org-remark-mark-strong-yellow)
   1696            ("C-c C-/ l" . org-remark-mark-line)
   1697            :map org-remark-mode-map
   1698            ("C-c C-/ o" . org-remark-open)
   1699            ("C-c C-/ ]" . org-remark-view-next)
   1700            ("C-c C-/ [" . org-remark-view-prev)
   1701            ("C-c C-/ r" . org-remark-remove)
   1702            ("C-c C-/ d" . org-remark-delete)))
   1703 
   1704   (use-package org-remark-global-tracking
   1705     ;; It is recommended that `org-remark-global-tracking-mode' be
   1706     ;; enabled when Emacs initializes. You can set it in
   1707     ;; `after-init-hook'.
   1708     :hook after-init
   1709     :after org-remark
   1710     :ensure nil  ;; already installed in org-remark
   1711     :config
   1712     ;; Selectively keep or comment out the following if you want to use
   1713     ;; extensions for Info-mode, EWW, and NOV.el (EPUB) respectively.
   1714     ;; (use-package org-remark-info :after info :config (org-remark-info-mode +1))
   1715     ;; (use-package org-remark-eww  :after eww  :config (org-remark-eww-mode +1))
   1716     ;; (use-package org-remark-nov  :after nov  :config (org-remark-nov-mode +1))
   1717 
   1718     ;; Custom pens
   1719     (org-remark-create "strong-yellow"
   1720                      '(:background "yellow")
   1721                      '(CATEGORY "important")))
   1722 #+end_src
   1723 ** yasnippet
   1724 #+begin_src emacs-lisp
   1725   (use-package yasnippet
   1726     :config (yas-global-mode)
   1727     :delight)
   1728 #+end_src
   1729 * Mode/language specific packages
   1730 ** Org
   1731 *** Custom functions
   1732 **** Get number of headlines in a file
   1733 #+begin_src emacs-lisp
   1734   (defun za/org-count-headlines-in-file (level filename)
   1735     "Count number of level LEVEL headlines in FILENAME. If LEVEL is 0, count all."
   1736     (let ((headline-str (cond ((zerop level) "^\*+")
   1737                               (t (format "^%s " (apply 'concat (make-list level "\\*")))))))
   1738       (save-mark-and-excursion
   1739         (with-temp-buffer
   1740           (insert-file-contents filename)
   1741           (count-matches headline-str (point-min) (point-max))))))
   1742 #+end_src
   1743 
   1744 **** Yank URL
   1745 #+begin_src emacs-lisp
   1746   (defun org-yank-link-url ()
   1747     (interactive)
   1748     (kill-new (org-element-property :raw-link (org-element-context)))
   1749     (message "Link copied to clipboard"))
   1750 #+end_src
   1751 *** Installation
   1752 Install Org and require additional components that I use.
   1753 
   1754 #+begin_src emacs-lisp
   1755   (use-package org
   1756     :custom
   1757     (org-outline-path-complete-in-steps nil "Complete path all at once (needed for completion frameworks")
   1758     (org-format-latex-options (plist-put org-format-latex-options :scale 2.0) "Larger latex previews")
   1759     (org-goto-interface 'outline-path-completion "Use outline path completion for org-goto, instead of its weird interface")
   1760     (org-insert-heading-respect-content t "Insert headings after current subtree")
   1761     (org-clock-report-include-clocking-task t "Include currently active task in clocktable")
   1762     (org-id-link-to-org-use-id 'create-if-interactive "If org-store-link is called directly, create an ID.")
   1763     (org-clock-mode-line-total 'today)
   1764     (org-return-follows-link t "Easier link following. Actual enter is still possible with ~C-q C-j~.")
   1765     (org-hide-emphasis-markers t "Don't show italics/bold markers")
   1766     (org-babel-python-command "python3")
   1767     (org-confirm-babel-evaluate nil)
   1768     (org-file-apps '((auto-mode . emacs)
   1769                      (directory . emacs)
   1770                      ("\\.mm\\'" . default)
   1771                      ("\\.x?html?\\'" . default)
   1772                      ("\\.pdf\\'" . emacs)))
   1773     (org-link-elisp-confirm-function #'y-or-n-p)
   1774     (org-link-elisp-skip-confirm-regexp "^org-noter$")
   1775     (org-clock-sound (concat user-emacs-directory "notification.wav"))
   1776     (org-export-backends '(ascii html icalendar latex md odt org pandoc jira))
   1777     (org-catch-invisible-edits 'show-and-error
   1778                                "Sometimes when text is folded away, I might accidentally edit text inside of it. This option prevents that. I wanted to do 'smart', but that has a 'fixme' so it might change in the future...Instead, show what's being edited, but don't perform the edit.")
   1779     (org-src-tab-acts-natively t "a tab in a code block indents the code as it should")
   1780     (org-attach-store-link-p 'attached)
   1781     (org-attach-archive-delete 'query)
   1782     (org-archive-subtree-add-inherited-tags t)
   1783     (org-stuck-projects '("/PROJ"
   1784                           ("NEXT" "STARTED")
   1785                           nil nil)
   1786                         "List projects that are stuck (don't have a next action)")
   1787     (org-tag-alist (let ((za/org-tag-energy-levels
   1788                           '((:startgroup)
   1789                             ("sport" . ?h) ; Sport (deep focus, long tasks, no interruptions, at least an hour)
   1790                             ("cruise" . ?l) ; Cruise (shallow focus, can be interrupted, can batch lots of quick tasks together)
   1791                             ("parked" . ?e) ; Parked (take a break, look into the distance, walk the dog, stretch, etc.)
   1792                             ("errand" . ?o) ; Errand (anything that involves me being out of the house)
   1793                             (:endgroup)))
   1794                          (za/org-tag-1-3-5
   1795                           '(; 1-3-5 tagging
   1796                             (:startgroup)
   1797                             ("_1" . ?1) ; 1 big task, 3-4 hrs
   1798                             ("_3" . ?3) ; 3 medium tasks, 1-2 hrs
   1799                             ("_5" . ?5) ; 5 small tasks, 30min-1hr
   1800                             (:endgroup))))
   1801                      `(,@za/org-tag-contexts ,@za/org-tag-energy-levels ,@za/org-tag-1-3-5)))
   1802 
   1803     :bind (("C-c a" . org-agenda)
   1804            ("C-c n" . org-capture)
   1805            ("C-c l" . org-store-link)
   1806            :map org-mode-map
   1807            ("C-M-<return>" . org-insert-todo-heading)
   1808            ("C-c M-y" . org-yank-link-url)
   1809            ("C-c N" . org-noter)
   1810            ("C-M-i" . completion-at-point)
   1811            ("C-c SPC" . org-table-blank-field)
   1812            ("C-c C-w" . za/org-refile-wrapper))
   1813     :hook ((org-mode . abbrev-mode)
   1814            (org-mode . za/echo-area-tooltips)
   1815            (org-mode . org-superstar-mode)
   1816            (org-mode . org-indent-mode)
   1817            (org-mode . za/settings-on-org-mode)
   1818            (org-mode . org-pretty-table-mode)
   1819            (org-mode . variable-pitch-mode)
   1820            (ediff-prepare-buffer . org-show-all))
   1821     :config
   1822     (za/package-vc-install :repo "Fuco1/org-pretty-table")
   1823     (require 'org-pretty-table)
   1824     (delight 'org-pretty-table nil)
   1825 
   1826 
   1827     (za/package-vc-install :repo "https://git.sr.ht/~bzg/org-contrib" :load "lisp/")
   1828     (require 'org-contrib)
   1829     (require 'org-checklist)
   1830     (delight 'org-indent-mode nil 'org-indent)
   1831     (defun za/settings-on-org-mode ()
   1832       "Settings on enabling org mode"
   1833       (za/toggle-wrap t))
   1834 
   1835     (defcustom za/org-inline-images-desired-screen-proportion (/ (float 3) 4)
   1836       "Percentage of the window (as a float) that Org inline images should take up."
   1837       :type 'float)
   1838 
   1839     (defun za/org-display-inline-images-set-width (&rest _)
   1840       "Set `org-image-actual-width` dynamically before displaying images."
   1841       (if (window-system)
   1842           (let* ((total-width (window-pixel-width))
   1843                  (image-width (round (* total-width za/org-inline-images-desired-screen-proportion))))
   1844             (setq-local org-image-actual-width image-width))))
   1845 
   1846     (advice-add 'org-display-inline-images :before #'za/org-display-inline-images-set-width)
   1847 
   1848     (defun za/org-attach-tag (old/org-attach-tag &rest args)
   1849       "Wraps :around org-attach-tag (as OLD/ORG-ATTACH-TAG) with ARGS.
   1850   When inside capture for org-roam, attaching fails at
   1851   org-attach-tag. This function prevents that error interrupting
   1852   org-attach."
   1853       (if ; there's no heading
   1854           (not (org-element-lineage (org-element-at-point)
   1855                                     '(headline inlinetask)
   1856                                     'include-self))
   1857           nil ; there's no point attaching a tag
   1858                                           ; otherwise, normal attach
   1859         (apply old/org-attach-tag args)))
   1860 
   1861     (advice-add #'org-attach-tag :around #'za/org-attach-tag)
   1862     (defun za/org-clear-1-3-5 ()
   1863       "Clears the _1/_3/_5 daily tags from all antries."
   1864       (interactive)
   1865       (let ((number-of-entries
   1866              (length (org-map-entries
   1867                       (lambda ()
   1868                         (let* ((tags-1-3-5 '("_1" "_3" "_5"))
   1869                                (tags-without-1-3-5 (seq-remove (lambda (e) (member e tags-1-3-5))
   1870                                                                org-scanner-tags)))
   1871                           (org-set-tags tags-without-1-3-5)))
   1872                       "_1|_3|_5"
   1873                       'agenda-with-archives))))
   1874         (message "Modified %d entries." number-of-entries)))
   1875     (defun za/archive-finished-tickler ()
   1876       (interactive)
   1877       (progn
   1878         (find-file-other-window za/org-life-tickler)
   1879         (length (org-map-entries
   1880                  (lambda ()
   1881                    (org-fold-show-subtree)
   1882                    (when (y-or-n-p "Archive? ")
   1883                      (org-archive-subtree-default)
   1884                      (save-buffer)))
   1885                  "TIMESTAMP<*\"<today>\""
   1886                  'file))))
   1887 
   1888     (require 'org-tempo)
   1889     (require 'org-habit)
   1890     (require 'org-id)
   1891     (use-package ob-async)
   1892     (use-package ob-rust)
   1893     (org-babel-do-load-languages
   1894      'org-babel-load-languages
   1895      '((emacs-lisp . t)
   1896        (R . t)
   1897        (python . t)
   1898        (ruby . t)
   1899        (shell . t)
   1900        (sqlite . t)
   1901        (rust . t)))
   1902     (use-package inf-ruby)
   1903     (use-package org-superstar
   1904       :custom
   1905       (org-superstar-leading-bullet ?\s))
   1906 
   1907     ;; Linking to emails via notmuch
   1908     (use-package ol-notmuch)
   1909 
   1910     ;; Improved search
   1911     (use-package org-ql)
   1912 
   1913     ;; My override for org clock resolve
   1914     (require 'org-clock-override)
   1915 
   1916     ;; Tempo expansions
   1917     (add-to-list 'org-structure-template-alist '("se" . "src emacs-lisp"))
   1918     (add-to-list 'org-structure-template-alist '("sb" . "src bibtex"))
   1919     (add-to-list 'org-structure-template-alist '("ss" . "src sh"))
   1920     (add-to-list 'org-structure-template-alist '("sy" . "src yaml")))
   1921 #+end_src
   1922 *** Agenda & GTD
   1923 **** Agenda mode settings
   1924 #+begin_src emacs-lisp
   1925   (use-package org-agenda
   1926     :ensure org
   1927     :bind (:map org-agenda-mode-map
   1928                 ("C-c TAB" . za/org-agenda-goto-narrowed-subtree)
   1929                 ("@" . za/org-agenda-show-context-tags))
   1930     :custom
   1931     (org-agenda-files (list za/org-life-main
   1932                             za/org-life-inbox
   1933                             za/org-life-tickler))
   1934     (org-agenda-text-search-extra-files
   1935      (directory-files za/org-life-dir t (rx bol (not ?.) (* anything) ".org"))
   1936      "I want to search all Org files in the life directory")
   1937 
   1938     :config
   1939     (defun za/org-agenda-show-context-tags ()
   1940       "Show the context tags (e.g. @computer) applicable to the current item."
   1941       (interactive)
   1942       (let* ((tags (org-get-at-bol 'tags))
   1943              (context-tag-p (lambda (tag) (string-prefix-p "@" tag)))
   1944              (context-tags (seq-filter context-tag-p tags)))
   1945         (if context-tags
   1946             (message "Contexts are :%s:"
   1947                      (org-no-properties (mapconcat #'identity context-tags ":")))
   1948           (message "No contexts associated with this line"))))
   1949     (defun za/org-agenda-goto-narrowed-subtree ()
   1950       "Jump to current agenda item and narrow to its subtree."
   1951       (interactive)
   1952       (delete-other-windows)
   1953       (org-agenda-goto)
   1954       (org-narrow-to-subtree)
   1955       (outline-hide-subtree)
   1956       (org-show-children 1)
   1957       (other-window 1)))
   1958 #+end_src
   1959 
   1960 Fix tag display by dynamically calculating the column.
   1961 
   1962 #+begin_src emacs-lisp
   1963   (defun za/settings-org-agenda-mode ()
   1964     "My settings for org agenda mode"
   1965     )
   1966   (add-hook 'org-agenda-mode-hook #'za/settings-org-agenda-mode)
   1967 #+end_src
   1968 
   1969 **** Opening files
   1970 Convenience functions to make opening the main file faster:
   1971 
   1972 #+begin_src emacs-lisp
   1973   (defun gtd () "GTD: main file" (interactive) (find-file za/org-life-main))
   1974   (defun gtd-inbox ()
   1975     "GTD: inbox"
   1976     (interactive)
   1977     (let ((count-docs (length (directory-files za/org-life-doc-inbox nil (rx bos (not ?.))))))
   1978       (find-file za/org-life-inbox)
   1979       (when (> count-docs 0)
   1980         (dired-other-window za/org-life-doc-inbox)
   1981         (dired-revert)
   1982         (other-window 1))))
   1983   (defun gtd-inbox-mobile () "GTD: mobile inbox" (interactive) (find-file za/org-life-inbox-mobile))
   1984   (defun gtd-archive () "GTD: archive" (interactive) (find-file za/org-life-archive))
   1985   (defun gtd-someday () "GTD: someday" (interactive) (find-file za/org-life-someday))
   1986   (defun gtd-tickler () "GTD: tickler" (interactive) (find-file za/org-life-tickler))
   1987 #+end_src
   1988 
   1989 Bind keys to those functions:
   1990 
   1991 #+begin_src emacs-lisp
   1992   (bind-keys :prefix "M-g t"
   1993              :prefix-map za/gtd-files-map
   1994              :prefix-docstring "Visit GTD file"
   1995              ("i" . gtd-inbox)
   1996              ("l" . gtd)
   1997              ("a" . gtd-archive)
   1998              ("s" . gtd-someday)
   1999              ("t" . gtd-tickler))
   2000 #+end_src
   2001 
   2002 To improve jumping to any headline via counsel, filter returned candidates to include source file.
   2003 
   2004 #+begin_src emacs-lisp
   2005   (defun za/counsel-org-agenda-headlines--candidates-with-filename (candidates)
   2006     "Convert CANDIDATES to include source filename for each candidate."
   2007     (mapcar (lambda (candidate)
   2008               (let ((name (nth 0 candidate))
   2009                     (path (nth 1 candidate))
   2010                     (pos (nth 2 candidate)))
   2011                 (list (format "%s/%s" (file-name-nondirectory path) name)
   2012                       path
   2013                       pos)))
   2014             candidates))
   2015 
   2016   (advice-add #'counsel-org-agenda-headlines--candidates :filter-return #'za/counsel-org-agenda-headlines--candidates-with-filename)
   2017 #+end_src
   2018 
   2019 *** Processing inbox
   2020 I made a function for processing the inbox, focusing on one item at a time:
   2021 
   2022 #+begin_src emacs-lisp
   2023   (defun za/gtd-inbox-next-item ()
   2024     (interactive)
   2025     (unless (string= (buffer-file-name) (file-truename za/org-life-inbox))
   2026       (user-error "You're not in your GTD inbox file."))
   2027     (widen)
   2028     (org-first-headline-recenter)
   2029     (org-narrow-to-subtree))
   2030 #+end_src
   2031 
   2032 And a conditional binding:
   2033 
   2034 #+begin_src emacs-lisp
   2035   (bind-key "C-c g n" #'za/gtd-inbox-next-item 'org-mode-map (string= (buffer-file-name) (file-truename za/org-life-inbox)))
   2036 #+end_src
   2037 
   2038 And a function for importing other inboxes:
   2039 
   2040 #+begin_src emacs-lisp
   2041   (defun za/gtd-inbox-import ()
   2042     (interactive)
   2043     (unless (string= (buffer-file-name) (file-truename za/org-life-inbox))
   2044       (user-error "You're not in your GTD inbox file"))
   2045     (when (directory-files za/org-life-dir nil "\\.sync-conflict-")
   2046         (user-error "Sync conflicts found, please fix them"))
   2047     (let ((mobile (if (boundp 'za/org-life-inbox-mobile) (file-truename za/org-life-inbox-mobile) nil))
   2048           (calendar (if (boundp 'za/org-life-calendar-inbox) (file-truename za/org-life-calendar-inbox) nil)))
   2049       (save-mark-and-excursion
   2050         (goto-char (point-max))
   2051         (when mobile
   2052           (insert-file mobile)
   2053           (goto-char (point-max))
   2054           (write-region "" nil mobile))
   2055         (when calendar
   2056           (insert-file calendar)
   2057           (write-region "" nil calendar)
   2058           (goto-char (point-max)))
   2059         (message "Imported other inboxes."))))
   2060 #+end_src
   2061 
   2062 Also with a conditional binding:
   2063 
   2064 #+begin_src emacs-lisp
   2065   (bind-key "C-c g i" #'za/gtd-inbox-import 'org-mode-map (string= (buffer-file-name) (file-truename za/org-life-inbox)))
   2066 #+end_src
   2067 *** Refiling & archiving
   2068 #+begin_src emacs-lisp
   2069   (use-package org-refile
   2070     :ensure org
   2071     :custom
   2072     (org-refile-targets `((,za/org-life-main :maxlevel . 3)
   2073                           (,za/org-life-someday :level . 1)
   2074                           (,za/org-life-tickler :maxlevel . 3))
   2075                         "Where I want to be able to move subtrees (doesn't include inbox because I never refile to that, and the archive has its own keybining)")
   2076     (org-archive-location (concat za/org-life-archive "::datetree/")
   2077                           "I want to archive to a specific file, in a date tree")
   2078     (org-refile-use-outline-path 'file
   2079                                  "Include the destination file as an element in the path to a heading, and to use the full paths as completion targets rather than just the heading text itself")
   2080     (org-outline-path-complete-in-steps nil
   2081                                         "Tell Org that I don’t want to complete in steps; I want Org to generate all of the possible completions and present them at once (necessary for Helm/Ivy)")
   2082     (org-refile-allow-creating-parent-nodes 'confirm
   2083                                             "Allow me to tack new heading names onto the end of my outline path, and if I am asking to create new ones, make me confirm it"))
   2084 #+end_src
   2085 
   2086 *** Quick capture
   2087 Quick capture lets me send something to my inbox very quickly, without thinking about where it should go.
   2088 The inbox is processed later.
   2089 
   2090 Templates for quick capture:
   2091 
   2092 #+begin_src emacs-lisp
   2093   (use-package org-capture
   2094     :ensure org
   2095     :custom
   2096     (org-capture-templates `(("t" "Todo [inbox]" entry
   2097                               (file ,za/org-life-inbox)
   2098                               "* TODO %i%?")
   2099 
   2100                              ("s" "Save for read/watch/listen" entry
   2101                               (file+headline ,za/org-life-someday "Read/watch/listen")
   2102                               "* %?[[%^{link}][%^{description}]] %^g"))))
   2103 #+end_src
   2104 
   2105 *** Todo & custom agenda views
   2106 Todo keywords based on the GTD system (pipe separates incomplete from complete).
   2107 Apart from the logging-on-done configured [[*Logging][below]], I also want to log a note & timestamp when I start waiting on something.
   2108 In ~org-todo-keywords~, ~@~ means note+timestamp, ~!~ means timestamp, ~@/!~ means note+timestamp on state entry and timestamp on leave.
   2109 
   2110 #+begin_src emacs-lisp
   2111   (custom-set-variables '(org-todo-keywords '((sequence "TODO(t)" "NEXT(n)" "STARTED(s)" "WAITING(w@)" "PROJ(p)" "|" "DONE(d)" "CANCELLED(c)")))
   2112                         '(org-todo-keyword-faces '(("TODO" . org-todo)
   2113                                                    ("NEXT" . org-todo)
   2114                                                    ("WAITING" . org-todo)
   2115                                                    ("STARTED" . org-todo)
   2116                                                    ("PROJ" . org-todo)
   2117                                                    ("DONE" . org-done)
   2118                                                    ("CANCELLED" . org-done))))
   2119 #+end_src
   2120 
   2121 
   2122 Something is a habit if: it has a HABIT tag, STYLE is habit, LOGGING is logrepeat, it has a scheduled repeater from today.
   2123 
   2124 #+begin_src emacs-lisp
   2125   (defun za/mark-as-habit ()
   2126     "This function makes sure that the current heading has:
   2127   (1) a HABIT tag
   2128   (2) todo set to TODO
   2129   (3) LOGGING property set to logrepeat
   2130   (4) a scheduled repeater from today"
   2131     (interactive)
   2132     (org-back-to-heading t)
   2133     (org-set-property "TODO" "TODO")
   2134     (org-set-property "LOGGING" "logrepeat")
   2135     (org-set-property "STYLE" "habit")
   2136     (org-toggle-tag "HABIT" 'on)
   2137     (org-schedule nil))
   2138 #+end_src
   2139 
   2140 +I decided that projects will not be TODO items, but their progress will be tracked with a progress cookie ([x/y]). This function converts an item to a project: it adds a PROJECT tag, sets the progress indicator to count all checkboxes in sub-items (only TODO items), and removes any existing TODO keywords. Finally, PROJECT tags shouldn't be inherited (i.e. subtasks shouldn't be marked as projects).+
   2141 In the end, I want NEXT items that are part of a project to be shown as such (so inherit that PROJECT tag), but projects themselves will have a PROJ todo keyword.
   2142 This function converts an item to a project.
   2143 
   2144 #+begin_src emacs-lisp
   2145   (defun za/mark-as-project ()
   2146     "This function makes sure that the current heading has
   2147       (1) the tag PROJECT
   2148       (2) the todo keyword PROJ
   2149       (3) the property COOKIE_DATA set to \"todo recursive\"
   2150       (4) a progress indicator"
   2151     (interactive)
   2152     (org-back-to-heading t)
   2153     ;; Step 1: clear out everything
   2154     (org-set-property "TODO" "")
   2155 
   2156     ;; org-set-property errors via org-priority if you try to clear
   2157     ;; priority of an item that doesn't have priority. Stupid design,
   2158     ;; but I can't change that so we gotta jump through hoops:
   2159     (let ((have-priority (org-element-property :priority (org-element-at-point))))
   2160       (when have-priority
   2161         (org-set-property "PRIORITY" "")))
   2162 
   2163     ;; Step 2: set info (stats cookie, todo, tag, properties drawer)
   2164     (forward-whitespace 1)
   2165     (insert "[/] ")
   2166     (org-set-property "TODO" "PROJ")
   2167     (org-toggle-tag "PROJECT" 'on)
   2168     (org-set-property "COOKIE_DATA" "todo recursive")
   2169     (org-update-statistics-cookies nil))
   2170 #+end_src
   2171 
   2172 And a keybinding for it:
   2173 
   2174 #+begin_src emacs-lisp
   2175   (bind-key "C-c g p" #'za/mark-as-project 'org-mode-map)
   2176 #+end_src
   2177 
   2178 Want all tags to be inherited:
   2179 
   2180 #+begin_src emacs-lisp
   2181   (custom-set-variables '(org-tags-exclude-from-inheritance nil))
   2182 #+end_src
   2183 
   2184 Define a function to skip items if they're part of a project (i.e. one of their parents has a "PROJECT" tag).
   2185 +The problem is, the "PROJECT" tag isn't inherited. So, we temporarily disable excluding from inheritance, just for the ~org-get-tags~ call. Then check if "PROJECT" is one of the tags.+ That tag is now inherited.
   2186 
   2187 #+begin_src emacs-lisp
   2188   (defun za/skip-if-in-project ()
   2189     "Skip items that are part of a project but not a project themselves."
   2190     (let ((skip (save-excursion (org-end-of-subtree t)))
   2191           (keep nil)
   2192           (item-tags (let ((org-use-tag-inheritance t)) (org-get-tags)))
   2193           (item-tags-without-inherited (let ((org-use-tag-inheritance nil)) (org-get-tags))))
   2194       (if (and (member "PROJECT" item-tags)
   2195                (not (member "PROJECT" item-tags-without-inherited)))
   2196           skip
   2197         keep)))
   2198 #+end_src
   2199 
   2200 Also, define a function to skip tasks (trees) that are not habits (i.e. don't have the STYLE property ~habit~):
   2201 
   2202 #+begin_src emacs-lisp
   2203   (defun za/skip-unless-habit ()
   2204     "Skip trees that are not habits"
   2205     (let ((skip (save-excursion (org-end-of-subtree t)))
   2206           (keep nil))
   2207       (if (string= (org-entry-get nil "STYLE") "habit")
   2208           keep
   2209         skip)))
   2210 #+end_src
   2211 
   2212 And one to skip tasks that /are/ habits:
   2213 
   2214 #+begin_src emacs-lisp
   2215   (defun za/skip-if-habit ()
   2216     "Skip trees that are not habits"
   2217     (let ((skip (save-excursion (org-end-of-subtree t)))
   2218           (keep nil))
   2219       (if (string= (org-entry-get nil "STYLE") "habit")
   2220           skip
   2221         keep)))
   2222 #+end_src
   2223 
   2224 Skip ones with a habit tag:
   2225 
   2226 #+begin_src emacs-lisp
   2227   (defun za/skip-if-has-habit-tag ()
   2228     (let ((skip (save-excursion (org-end-of-subtree t)))
   2229           (keep nil)
   2230           (item-tags-without-inherited (let ((org-use-tag-inheritance nil)) (org-get-tags))))
   2231       (if (or (member "HABIT" item-tags-without-inherited)
   2232               (member "flatastic" item-tags-without-inherited))
   2233           skip
   2234         keep)))
   2235 #+end_src
   2236 
   2237 And another function, to skip tasks that are blocked:
   2238 
   2239 #+begin_src emacs-lisp
   2240   (defun za/skip-if-blocked ()
   2241     "Skip trees that are blocked by previous tasks"
   2242     (let ((skip (save-excursion (org-end-of-subtree t)))
   2243           (keep nil))
   2244       (if (org-entry-blocked-p)
   2245           skip
   2246         keep)))
   2247 #+end_src
   2248 
   2249 For listing tasks without a context - skip if it has a context tag:
   2250 
   2251 #+begin_src emacs-lisp
   2252   (defun za/skip-if-has-context ()
   2253     (let ((skip (save-excursion (org-end-of-subtree t)))
   2254           (keep nil)
   2255           (item-tags-without-inherited (let ((org-use-tag-inheritance nil)) (org-get-tags)))
   2256           (context-tag-p (lambda (s) (eq (aref s 0) ?@))))
   2257       (if (cl-some context-tag-p item-tags-without-inherited)
   2258           skip
   2259         keep)))
   2260 #+end_src
   2261 
   2262 For listing tasks without an energy level - skip if it has an energy level:
   2263 
   2264 #+begin_src emacs-lisp
   2265   (defun za/skip-if-has-energy-level ()
   2266     (let ((skip (save-excursion (org-end-of-subtree t)))
   2267           (keep nil)
   2268           (item-tags-without-inherited (let ((org-use-tag-inheritance nil)) (org-get-tags)))
   2269           (energy-tag-p (lambda (s) (member s '("sport" "cruise" "parked" "errand")))))
   2270       (if (cl-some energy-tag-p item-tags-without-inherited)
   2271           skip
   2272         keep)))
   2273 #+end_src
   2274 
   2275 #+begin_src emacs-lisp
   2276   (defun za/skip-if-scheduled-in-future ()
   2277     (let* ((skip (save-excursion (org-end-of-subtree t)))
   2278            (keep nil)
   2279            (scheduled-time (org-get-scheduled-time (point))))
   2280       (if (and scheduled-time (time-less-p (current-time) scheduled-time))
   2281           skip
   2282         keep)))
   2283 #+end_src
   2284 
   2285 #+begin_src emacs-lisp
   2286   (defun za/skip-if-scheduled ()
   2287     (let* ((skip (save-excursion (org-end-of-subtree t)))
   2288            (keep nil)
   2289            (scheduled-time (org-get-scheduled-time (point))))
   2290       (if scheduled-time
   2291           skip
   2292         keep)))
   2293 #+end_src
   2294 
   2295 Create custom agenda view based on those keywords.
   2296 Agenda views are made up of blocks, appearing in the order that you declare them.
   2297 The first two strings are what shows up in the agenda dispatcher (the key to press and the description).
   2298 
   2299 #+begin_src emacs-lisp
   2300   (setq org-agenda-custom-commands
   2301         '(("n" "Next actions"
   2302            todo "NEXT" ((org-agenda-overriding-header "Next actions:")
   2303                         (org-agenda-sorting-strategy '(priority-down alpha-up))
   2304                         (org-agenda-skip-function #'za/skip-if-scheduled)))
   2305           ("q" "Query" (lambda (&rest _) (call-interactively #'org-ql-search)))
   2306 
   2307           ("W" "Waiting"
   2308            ((todo "WAITING" ((org-agenda-overriding-header "Waiting:")))))
   2309           ("S" . "Saved for later...")
   2310           ("Sw" "Saved to watch"
   2311            ((tags-todo "WATCH" ((org-agenda-overriding-header "To watch:")
   2312                                 (org-agenda-files `(,za/org-life-someday ,@org-agenda-files))))))
   2313 
   2314           ("Sr" "Saved to read"
   2315            ((tags-todo "READ" ((org-agenda-overriding-header "To read:")
   2316                                (org-agenda-files `(,za/org-life-someday ,@org-agenda-files))))))
   2317           ("Sl" "Saved to listen"
   2318            ((tags-todo "LISTEN" ((org-agenda-overriding-header "To listen:")
   2319                                  (org-agenda-files `(,za/org-life-someday ,@org-agenda-files))))))
   2320 
   2321           ("a" . "Agenda with schedule only...")
   2322           ("aw" "This week"
   2323            ((agenda "" ((org-agenda-span 'week)))))
   2324           ("aD" "Today"
   2325            ((agenda "" ((org-agenda-span 'day)))))
   2326           ("ad" "Today (no habits)"
   2327            ((agenda "" ((org-agenda-span 'day)
   2328                         (org-agenda-skip-function 'za/skip-if-has-habit-tag)))))
   2329           ("at" "Tomorrow (no habits)"
   2330            ((agenda "" ((org-agenda-span 'day)
   2331                         (org-agenda-start-day "+1d")
   2332                         (org-agenda-skip-function 'za/skip-if-has-habit-tag)))))
   2333           ("aT" "Tomorrow"
   2334            ((agenda "" ((org-agenda-span 'day)
   2335                         (org-agenda-start-day "+1d")))))
   2336 
   2337           ("w" "Week Agenda + Next Actions"
   2338            ((agenda "" ((org-agenda-overriding-header "Week agenda:")))
   2339             (todo "NEXT" ((org-agenda-overriding-header "Next actions:")))))
   2340 
   2341           ("o" "Month agenda"
   2342            ((agenda "" ((org-agenda-overriding-header "Month agenda:")
   2343                         (org-agenda-span 'month)))))
   2344 
   2345           ("d" "Day Agenda with habit tags + Habits + Waiting"
   2346            ((agenda "" ((org-agenda-overriding-header "Day:")
   2347                         (org-agenda-span 'day)
   2348                         (org-habit-show-habits nil)))
   2349             (todo "STARTED" ((org-agenda-overriding-header "In progress:")))
   2350             (todo "WAITING" ((org-agenda-overriding-header "Waiting:")))
   2351             (agenda "" ((org-agenda-overriding-header "Habits:")
   2352                         (org-agenda-span 'day)
   2353                         (org-agenda-use-time-grid nil)
   2354                         (org-agenda-skip-function 'za/skip-unless-habit)
   2355                         (org-habit-show-habits t) (org-habit-show-habits-only-for-today nil)
   2356                         (org-habit-show-all-today t)))))
   2357 
   2358 
   2359           ("k" "Kanban view"
   2360            ((todo "DONE" ((org-agenda-overriding-header "Done:") (org-agenda-sorting-strategy '(deadline-up priority-down alpha-up))))
   2361             (todo "STARTED" ((org-agenda-overriding-header "In progress:") (org-agenda-sorting-strategy '(deadline-up priority-down alpha-up))))
   2362             (todo "NEXT" ((org-agenda-overriding-header "To do:") (org-agenda-sorting-strategy '(deadline-up priority-down alpha-up))))
   2363             (todo "WAITING" ((org-agenda-overriding-header "In progress:") (org-agenda-sorting-strategy '(deadline-up priority-down alpha-up))))))
   2364 
   2365           ("p" "Projects"
   2366            ((todo "PROJ" ((org-agenda-overriding-header "Projects:")
   2367                           (org-agenda-prefix-format '((todo . " %i %-22(let ((deadline (org-entry-get nil \"DEADLINE\"))) (if deadline deadline \"\"))")))
   2368                           (org-agenda-dim-blocked-tasks nil)
   2369                           (org-agenda-sorting-strategy '((todo deadline-up alpha-down)))))))
   2370           ("1" "1-3-5"
   2371            ((tags "_1" ((org-agenda-overriding-header "Big tasks:")
   2372                         (org-agenda-skip-function 'za/skip-if-scheduled-in-future)
   2373                         (org-agenda-sorting-strategy '(todo-state-down deadline-up priority-down alpha-up))))
   2374             (tags "_3" ((org-agenda-overriding-header "Medium tasks:")
   2375                         (org-agenda-skip-function 'za/skip-if-scheduled-in-future)
   2376                         (org-agenda-sorting-strategy '(todo-state-down deadline-up priority-down alpha-up))))
   2377             (tags "_5" ((org-agenda-overriding-header "Small tasks:")
   2378                         (org-agenda-skip-function 'za/skip-if-scheduled-in-future)
   2379                         (org-agenda-sorting-strategy '(todo-state-down deadline-up priority-down alpha-up))))))
   2380 
   2381           ;; Useful thread for opening calfw: https://github.com/kiwanami/emacs-calfw/issues/18
   2382           ("c" "Calendar view" (lambda (&rest _)
   2383                                  (interactive)
   2384                                  (let ((org-agenda-skip-function 'za/skip-if-habit))
   2385                                    (cfw:open-org-calendar))))
   2386           ("f" . "Find & fix...")
   2387           ("f@" "Next actions missing context"
   2388            todo "NEXT" ((org-agenda-overriding-header "Missing context:")
   2389                         (org-agenda-sorting-strategy '(priority-down alpha-up))
   2390                         (org-agenda-skip-function 'za/skip-if-has-context)))
   2391           ("fe" "Next actions missing energy"
   2392            todo "NEXT" ((org-agenda-overriding-header "Missing energy level:")
   2393                         (org-agenda-sorting-strategy '(priority-down alpha-up))
   2394                         (org-agenda-skip-function 'za/skip-if-has-energy-level)))
   2395           ("ff" "Finished tasks that aren't in a project"
   2396            ((tags "TODO=\"DONE\"|TODO=\"CANCELLED\"" ((org-agenda-overriding-header "Finished tasks:")
   2397                                                       (org-agenda-skip-function 'za/skip-if-in-project)))))
   2398           ("ft" "Tasks without a scheduled time"
   2399            alltodo "" ((org-agenda-overriding-header "Missing scheduled time:")
   2400                        (org-agenda-skip-function '(org-agenda-skip-entry-if 'scheduled 'deadline 'timestamp))))))
   2401 #+end_src
   2402 
   2403 In calfw, I don't want to show habits:
   2404 
   2405 #+begin_src emacs-lisp
   2406   (add-hook 'cfw:calendar-mode-hook (setq-local org-agenda-skip-function 'za/skip-if-habit))
   2407 #+end_src
   2408 
   2409 *** Automatically mark next project item as NEXT
   2410 Unless the current item is a project, when a project item is done, the next item in the project should be marked "NEXT".
   2411 I tried org-edna but I couldn't get it working after an hour of effort. So a bit of lisp is the easier solution.
   2412 
   2413 #+begin_src emacs-lisp
   2414   (defun za/gtd-auto-next ()
   2415     "Automatically mark project item as next."
   2416     (save-excursion
   2417       (org-back-to-heading)
   2418       (when (buffer-narrowed-p)
   2419         (widen))
   2420       ;; org-state is set automatically in the hook
   2421       (when (and (member org-state org-done-keywords)
   2422                  (not (member "PROJECT" (org-get-tags nil 'local)))
   2423                  (member "PROJECT" (let ((org-use-tag-inheritance t))
   2424                                      (org-get-tags nil))))
   2425         (when (org-goto-sibling)
   2426           ;; if TODO and scheduled => no change
   2427           ;; if not TODO => no change
   2428           ;; else => change
   2429           (let* ((is-todo-state (string= "TODO" (org-get-todo-state)))
   2430                  (is-scheduled (or (org-get-scheduled-time nil)
   2431                                    (org-get-deadline-time nil)))
   2432                  (should-change-state (cond ((and is-todo-state is-scheduled) nil)
   2433                                             ((not is-todo-state) nil)
   2434                                             (t t))))
   2435             (when should-change-state
   2436               (org-entry-put (point) "TODO" "NEXT")))))))
   2437 #+end_src
   2438 
   2439 *** Logging for tasks
   2440 I want to log into the LOGBOOK drawer (useful when I want to take quick notes):
   2441 
   2442 #+begin_src emacs-lisp
   2443   (setq org-log-into-drawer "LOGBOOK")
   2444 #+end_src
   2445 
   2446 I also want to log when I finish a task (useful for archiving).
   2447 Furthermore, when I'm done, I want to add a note (any important
   2448 workarounds/tips). And when I reschedule, I want to know the reason.
   2449 I can disable logging on state change for a specific task by adding ~:LOGGING: nil~ to the ~:PROPERTIES:~ drawer.
   2450 
   2451 #+begin_src emacs-lisp
   2452   (setq org-log-done 'time
   2453         org-log-reschedule 'note)
   2454 #+end_src
   2455 
   2456 I want to hide drawers on startup. This variable has options:
   2457 - 'overview': Top-level headlines only.
   2458 - 'content': All headlines.
   2459 - 'showall': No folding on any entry.
   2460 - 'show2levels: Headline levels 1-2.
   2461 - 'show3levels: Headline levels 1-3.
   2462 - 'show4levels: Headline levels 1-4.
   2463 - 'show5levels: Headline levels 1-5.
   2464 - 'showeverything: Show even drawer contents.
   2465 
   2466 #+begin_src emacs-lisp
   2467   (setq org-startup-folded 'content)
   2468 #+end_src
   2469 
   2470 *** Task ordering
   2471 Some tasks should be ordered, i.e. they should be done in steps.
   2472 Those have the ~:ORDERED: t~ setting in ~:PROPERTIES:~, and it should be enforced:
   2473 
   2474 #+begin_src emacs-lisp
   2475   (setq org-enforce-todo-dependencies t)
   2476 #+end_src
   2477 
   2478 Furthermore, tasks that are ordered and can't be done yet because of previous steps should be dimmed in the agenda:
   2479 
   2480 #+begin_src emacs-lisp
   2481   (setq org-agenda-dim-blocked-tasks t)
   2482 #+end_src
   2483 
   2484 I might also want to set ~org-enforce-todo-checkbox-dependencies~, but not convinced on that one yet.
   2485 
   2486 *** Time tracking & effort
   2487 Time tracking should be done in its own drawer:
   2488 
   2489 #+begin_src emacs-lisp
   2490   (setq org-clock-into-drawer "CLOCK")
   2491 #+end_src
   2492 
   2493 And to customize how clock tables work:
   2494 
   2495 #+begin_src emacs-lisp
   2496   (setq org-clocktable-defaults '(:lang "en" :scope agenda-with-archives  :wstart 1 :mstart 1 :compact t :maxlevel nil))
   2497   (setq org-agenda-clockreport-parameter-plist '(:link t :maxlevel nil))
   2498 #+end_src
   2499 
   2500 I want to set effort in hours:minutes:
   2501 
   2502 #+begin_src emacs-lisp
   2503   (add-to-list 'org-global-properties '("Effort_ALL" . "0:05 0:10 0:15 0:20 0:30 0:45 1:00 1:30 2:00 4:00 6:00 8:00"))
   2504 #+end_src
   2505 
   2506 I want column view to look like this:
   2507 
   2508 | To do        | Task      | Tags | Sum of time elapsed | Sum of time estimated (effort) |
   2509 |--------------+-----------+------+---------------------+--------------------------------|
   2510 | todo keyword | task name | tags | sum of clock        | sum of estimated time          |
   2511 | ...          | ...       | ...  | ...                 | ...                            |
   2512 
   2513 #+begin_src emacs-lisp
   2514   (setq org-columns-default-format "%7TODO (To Do) %32ITEM(Task) %TAGS(Tags) %11CLOCKSUM_T(Clock) %10Difficulty(Difficulty) %8Effort(Effort){:}")
   2515 #+end_src
   2516 
   2517 Fix column alignment in agenda.
   2518 
   2519 #+begin_src emacs-lisp
   2520   (set-face-attribute 'org-column nil
   2521                       :height (face-attribute 'default :height)
   2522                       :family (face-attribute 'default :family))
   2523   (set-face-attribute 'org-agenda-date-today nil
   2524                       :height (face-attribute 'default :height))
   2525 #+end_src
   2526 
   2527 *** Calculate time since timestamp
   2528 #+begin_src emacs-lisp
   2529   (defun za/org-time-since ()
   2530     "Print the amount of time between the timestamp at point and the current date and time."
   2531     (interactive)
   2532     (unless (org-at-timestamp-p 'lax)
   2533       (user-error "Not at timestamp"))
   2534 
   2535     (when (org-at-timestamp-p 'lax)
   2536       (let ((timestamp (match-string 0)))
   2537         (with-temp-buffer
   2538           (insert timestamp
   2539                   "--"
   2540                   (org-time-stamp '(16)))
   2541           (org-evaluate-time-range)))))
   2542 #+end_src
   2543 
   2544 Also a method to add overlays with that timestamp:
   2545 
   2546 #+begin_src emacs-lisp
   2547   (defvar-local za/org-timestamp-overlays--list nil "Buffer-local list of overlays with timestamps")
   2548   (defvar-local za/org-timestamp-overlays--show nil "Buffer-local boolean to show overlays.")
   2549   (defun za/org-timestamp-overlays-clear ()
   2550     "Clear all overlays with timestamps in current buffer."
   2551     (dolist (ov za/org-timestamp-overlays--list)
   2552       (delete-overlay ov))
   2553     (setq-local za/org-timestamp-overlays--list nil))
   2554 
   2555   (defun za/org-timestamp-overlays-add ()
   2556     "Add overlays for active timestamps in current buffer."
   2557     (let ((markup-string (lambda (s) (propertize (format "{%s}" s)
   2558                                                  'face 'org-habit-ready-future-face))))
   2559       (save-excursion
   2560         (let* ((beg (point-min))
   2561                (end (point-max)))
   2562           (goto-char beg)
   2563           (while (re-search-forward (org-re-timestamp 'active) end t)
   2564             (let ((ov (make-overlay (point) (point))))
   2565               (overlay-put ov 'before-string (funcall markup-string (za/org-time-since)))
   2566               (add-to-list 'za/org-timestamp-overlays--list ov)))))))
   2567 
   2568   (defun za/org-timestamp-overlays-redraw ()
   2569     "Redraw all overlays for active timestamps."
   2570     (za/org-timestamp-overlays-clear)
   2571     (za/org-timestamp-overlays-add))
   2572 
   2573   (defun za/org-timestamp-hook-fn (&rest _)
   2574     (za/org-timestamp-overlays-redraw))
   2575 
   2576   (bind-key "C-c q p" #'tmp/p)
   2577   (defun za/org-timestamp-overlays-toggle (&optional prefix)
   2578     "With no prefix, toggle showing timestamp overlay.
   2579   With PREFIX = 0, redraw overlays.
   2580   With PREFIX > 0, show overlays.
   2581   With PREFIX < 0, hide overlays."
   2582     (interactive "P")
   2583     (let ((overlays-hide (lambda ()
   2584                            (za/org-timestamp-overlays-clear)
   2585                            (remove-hook 'org-cycle-hook #'za/org-timestamp-hook-fn)
   2586                            (setq za/org-timestamp-overlays--show nil)
   2587                            (message "Overlays hidden.")))
   2588           (overlays-show (lambda ()
   2589                            (za/org-timestamp-overlays-redraw)
   2590                            (add-hook 'org-cycle-hook #'za/org-timestamp-hook-fn)
   2591                            (setq za/org-timestamp-overlays--show t)
   2592                            (message "Overlays showing.")))
   2593           (overlays-redraw-maybe (lambda ()
   2594                                    (when za/org-timestamp-overlays--show
   2595                                      (za/org-timestamp-overlays-redraw)
   2596                                      (message "Redrawing overlays."))))
   2597           (prefix-num (prefix-numeric-value prefix)))
   2598       (cond ((not prefix)
   2599              (cond (za/org-timestamp-overlays--show
   2600                     (funcall overlays-hide))
   2601                    (t
   2602                     (funcall overlays-show))))
   2603             ((zerop prefix-num)
   2604              )
   2605             ((> prefix-num 0)
   2606              (funcall overlays-show))
   2607             ((< prefix-num 0)
   2608              (funcall overlays-hide)))))
   2609 
   2610 #+end_src
   2611 
   2612 Bind a key:
   2613 
   2614 #+begin_src emacs-lisp
   2615   (bind-key "C-c q d" #'za/org-timestamp-overlays-toggle 'org-mode-map)
   2616   (bind-key "C-c q d" #'za/org-timestamp-overlays-toggle 'org-agenda-mode-map)
   2617 #+end_src
   2618 *** Priorities: how important something is
   2619 I usually have a lot of 'next' actions, so I prefer 4 priority levels instead of the default 3: A (urgent, ASAP), B (important),  C (if you have nothing else, do this), D (do in free time):
   2620 
   2621 #+begin_src emacs-lisp
   2622   (setq org-priority-highest ?A
   2623         org-priority-lowest ?D
   2624         org-priority-default ?C)
   2625 #+end_src
   2626 
   2627 Faces for priorities in agenda:
   2628 
   2629 #+begin_src emacs-lisp
   2630   (setq org-priority-faces `((?A . (:foreground ,(face-foreground 'error)))
   2631                              (?B . (:foreground ,(face-foreground 'org-todo)))
   2632                              (?C . (:foreground ,(face-foreground 'font-lock-constant-face) :weight semi-light))
   2633                              (?D . (:foreground ,(face-foreground 'font-lock-string-face) :slant italic :weight light))))
   2634 #+end_src
   2635 
   2636 And to be able to bulk-set priorities in agenda:
   2637 
   2638 #+begin_src emacs-lisp
   2639   (setq org-agenda-bulk-custom-functions '((?P (lambda nil (org-agenda-priority 'set)))))
   2640 #+end_src
   2641 *** Energy requirement: how difficult something is
   2642 #+begin_src emacs-lisp
   2643   (add-to-list 'org-global-properties '("Difficulty_ALL" . "low medium high"))
   2644 #+end_src
   2645 *** Org export backends
   2646 #+begin_src emacs-lisp
   2647   (use-package ox-pandoc)
   2648 #+end_src
   2649 
   2650 *** org publishing
   2651 I decided, after trying many different things, to settle on org-publish.
   2652 
   2653 #+begin_src emacs-lisp
   2654   (defconst za/org-roam-top-name "Top" "The name of the top-level Org-roam node.")
   2655   (defun za/org-roam-sitemap-function (title list)
   2656     "Customized function to generate sitemap for org-roam, almost the same as `org-publish-sitemap-default`."
   2657     (concat "#+TITLE: " title "\n\n"
   2658             (format "[[file:%s][%s]]\n\n"
   2659                     (file-name-nondirectory (org-roam-node-file
   2660                                              (org-roam-node-from-title-or-alias za/org-roam-top-name)))
   2661                     "Click here for entrypoint.")))
   2662   ;; (org-list-to-org list)))  <-- this is taken care of by Zola
   2663 
   2664 #+end_src
   2665 
   2666 To make this work with Zola, I need to export Github-flavored markdown (fenced code blocks with language):
   2667 
   2668 #+begin_src emacs-lisp
   2669   (require 'ox-publish)
   2670   (require 'ox-md)
   2671 
   2672   (use-package ox-gfm
   2673     :init
   2674     (with-eval-after-load 'org (require 'ox-gfm)))
   2675 #+end_src
   2676 
   2677 First difficulty: Zola needs front matter with ~+++...+++~.
   2678 The default Markdown backend doesn't provide that, so need to customize it by advising the default ~org-md-template~.
   2679 
   2680 #+begin_src emacs-lisp
   2681   (defun za/org-md-template-zola (contents info)
   2682     "Markdown template compatible with Zola (generates the necessary front matter from CONTENTS and INFO)."
   2683     (let ((title (org-md-plain-text (org-element-interpret-data (plist-get info :title)) info)))
   2684       (concat "+++\n"
   2685               (format "title = \"%s\"\n" (string-replace "\"" "'" title))
   2686 
   2687               ;; If the note contains a math org-roam tag
   2688               (when (member "math" (plist-get info :filetags))
   2689                 "template = \"page-math.html\"\n")
   2690 
   2691               "+++\n"
   2692               (format "# %s\n" title)
   2693               contents)))
   2694 #+end_src
   2695 
   2696 Second difficulty: links need to be reformatted and changed for static data (like images).
   2697 This function filters the return value of ~org-md-link~.
   2698 
   2699 #+begin_src emacs-lisp
   2700   (defun za/org-md-link-zola (linkstr)
   2701     "A filter function for the return value of
   2702           `org-md-link` (LINKSTR) to generate a link compatible with Zola."
   2703     (cond ((string-match-p (rx ".md") linkstr)
   2704            (string-replace "](" "](@/org-roam/" linkstr))
   2705           ((string-match-p (rx "](" (? (* alnum) "://") "/") linkstr)
   2706            (replace-regexp-in-string (rx "](" (? (* alnum) "://") "/" (* any) "/org-roam/data") "](/org-roam-data" linkstr))
   2707           (t linkstr)))
   2708 #+end_src
   2709 
   2710 A wrapper to set the right image link:
   2711 
   2712 #+begin_src emacs-lisp
   2713   (defun za/org-html--format-image (args)
   2714     "Modify source image link to work with my Org roam setup"
   2715     (let ((source (nth 0 args))
   2716           (_attributes (nth 1 args))
   2717           (_info (nth 2 args)))
   2718       (list (replace-regexp-in-string (rx bos "data/") "/org-roam-data/" source)
   2719             _attributes
   2720             _info)))
   2721 #+end_src
   2722 
   2723 And here's the custom publish function that adds/removes the necessary advice:
   2724 
   2725 #+begin_src emacs-lisp
   2726   (defun za/org-gfm-publish-to-gfm-zola (plist filename pub-dir)
   2727     "Run `org-gfm-publish-to-gfm`, advising the necessary
   2728   functions to generate Zola-compatible markdown."
   2729     (let* ((org-export-output-file-name-locked (lambda (extension &rest _)
   2730                                                  (concat (plist-get plist :publishing-directory)
   2731                                                          "locked-"
   2732                                                          (file-name-base filename)
   2733                                                          extension)))
   2734            (node (car (seq-filter
   2735                        (lambda (node) (file-equal-p (org-roam-node-file node) filename))
   2736                        (org-roam-node-list))))
   2737            (locked-p (cond ((file-equal-p filename
   2738                                           (file-name-concat (plist-get plist :base-directory) (plist-get plist :sitemap-filename)))
   2739                             nil)
   2740                            (t
   2741                             (member "locked" (org-roam-node-tags node)))))
   2742            (advice '((org-gfm-inner-template :override za/org-md-template-zola)
   2743                      (org-md-link :filter-return za/org-md-link-zola)
   2744                      (org-html--format-image :filter-args za/org-html--format-image)
   2745                      (org-gfm-table :override org-md--convert-to-html)))) ; Zola uses CommonMark, so doesn't support Markdown tables
   2746 
   2747       (dolist (orig-type-new advice) (apply #'advice-add orig-type-new))
   2748       (unwind-protect
   2749           (cond (locked-p
   2750                  (advice-add #'org-export-output-file-name :override org-export-output-file-name-locked)
   2751                  (unwind-protect
   2752                      (org-gfm-publish-to-gfm plist filename pub-dir)
   2753                    (advice-remove #'org-export-output-file-name org-export-output-file-name-locked)))
   2754                 (t
   2755                  (org-gfm-publish-to-gfm plist filename pub-dir)))
   2756         (dolist (orig-type-new advice)
   2757           (advice-remove (nth 0 orig-type-new)
   2758                          (nth 2 orig-type-new))))))
   2759 #+end_src
   2760 
   2761 Finally, the list of things we can publish with their respective publishin functions:
   2762 
   2763 #+begin_src emacs-lisp
   2764   (if (boundp 'za/my-website-dir)
   2765       (setq org-publish-project-alist
   2766             `(
   2767               ("org-notes"
   2768                :base-directory ,za/org-roam-dir
   2769                :base-extension "org"
   2770                :publishing-directory ,(concat za/my-website-dir "content/org-roam/")
   2771                :publishing-function za/org-gfm-publish-to-gfm-zola
   2772                :recursive t
   2773                :sitemap-filename "_index.md"
   2774                :sitemap-title "Org Roam"
   2775                :sitemap-function za/org-roam-sitemap-function
   2776                :auto-sitemap t)
   2777 
   2778               ("org-notes-data"
   2779                :base-directory ,(concat za/org-roam-dir "/data")
   2780                :base-extension any
   2781                :publishing-directory ,(concat za/my-website-dir "static/org-roam-data/")
   2782                :recursive t
   2783                :publishing-function org-publish-attachment)
   2784 
   2785               ("org-roam" :components ("org-notes" "org-notes-data"))))
   2786     (warn "za/my-website-dir not bound, not setting org publishing targets."))
   2787 #+end_src
   2788 
   2789 And a function to rsync to my VPS:
   2790 
   2791 #+begin_src emacs-lisp
   2792   (defun za/publish-upload-to-website ()
   2793     "Upload my website to my VPS"
   2794     (interactive)
   2795     (async-shell-command (format "cd %s && zola build && yes|publish" za/my-website-dir) "*Async Shell publish*"))
   2796 #+end_src
   2797 *** Rebuild org cache
   2798 
   2799 #+begin_src emacs-lisp
   2800   (defun za/force-org-rebuild-cache ()
   2801     "Rebuild the `org-mode' and `org-roam' cache."
   2802     (interactive)
   2803     (org-id-update-id-locations)
   2804     ;; Note: you may need `org-roam-db-clear-all'
   2805     ;; followed by `org-roam-db-sync'
   2806     (org-roam-db-sync)
   2807     (org-roam-update-org-id-locations))
   2808 #+end_src
   2809 *** Sync with Flatastic
   2810 API work is handled via an external ruby script.
   2811 
   2812 #+begin_src emacs-lisp
   2813   (defun za/org-flatastic-sync-tasks ()
   2814     "Add tasks from flatastic to inbox"
   2815     (interactive)
   2816     (unless (json-available-p)
   2817       (user-error "JSON not available"))
   2818     (unless (boundp 'za/org-life-inbox)
   2819       (user-error "Please set za/org-life-inbox"))
   2820     (let* ((api-data (json-parse-string
   2821                       (progn
   2822                         (require 'exec-path-from-shell)
   2823                         (exec-path-from-shell-copy-envs
   2824                          '("FLATASTIC_API_KEY" "FLATASTIC_USER_ID"))
   2825                         (shell-command-to-string "~/.local/share/rbenv/shims/ruby ~/.scripts/flatastic.rb"))
   2826                       :object-type 'alist))
   2827            (format-data-as-org (lambda (l)
   2828                                  (format "* TODO %s :flatastic:\n  SCHEDULED: <%s>\n  Points: %d\n"
   2829                                          (alist-get 'description l)
   2830                                          (alist-get 'scheduled_due_date l)
   2831                                          (alist-get 'point_value l))))
   2832            (org-flatastic-items (mapcar format-data-as-org api-data)))
   2833       (with-current-buffer (find-file-noselect za/org-life-inbox)
   2834         (goto-char (point-max))
   2835         (insert "\n" (string-join org-flatastic-items "\n")))
   2836       (message "Synced %d Flatastic tasks to inbox" (length api-data))))
   2837 #+end_src
   2838 *** Link to Thunderbird messages
   2839 Create a custom link to open thunderbird emails by ID:
   2840 
   2841 #+begin_src emacs-lisp
   2842   (org-link-set-parameters
   2843    "thunderbird"
   2844    :follow #'za/org-link-thunderbird-follow)
   2845 
   2846   (defun za/org-link-thunderbird-follow (messageid)
   2847     "Open the message with id `messageid` in Thunderbird"
   2848     (shell-command (format "thunderbird mid:%s" (shell-quote-argument messageid))))
   2849 #+end_src
   2850 *** Inverse refile
   2851 #+begin_src emacs-lisp
   2852   (defun za/org-refile-to-point (refloc)
   2853     "Prompt for a heading and refile it to point."
   2854     (interactive (list (org-refile-get-location "Heading: ")))
   2855     (let* ((file (nth 1 refloc))
   2856            (pos (nth 3 refloc)))
   2857       (save-excursion
   2858         (with-current-buffer (find-file-noselect file 'noward)
   2859           (save-excursion
   2860             (save-restriction
   2861               (widen)
   2862               (goto-char pos)
   2863               (org-copy-subtree 1 t))))
   2864         (org-paste-subtree nil nil nil t))))
   2865 
   2866 
   2867   (defun za/org-refile-wrapper (arg)
   2868     "Wrap org-refile so that it does the inverse with a negative argument"
   2869     (interactive "P")
   2870     (if (minusp (prefix-numeric-value arg))
   2871         (call-interactively #'za/org-refile-to-point)
   2872       (org-refile arg)))
   2873 
   2874 #+end_src
   2875 
   2876 *** org-caldav
   2877 This lets me sync my Org agenda to my CalDAV server.
   2878 The main reason is because Orgzly doesn't have a calendar view and can't (yet) search for events on a specific day, so if someone asks "are you free on that day", it's a bit hard for me to answer if I don't have my computer with me.
   2879 This way, I can just check my calendar.
   2880 
   2881 #+begin_src emacs-lisp
   2882   (if (and (boundp 'za/caldav-url)
   2883            (boundp 'za/caldav-org-calendar-id)
   2884            (boundp 'za/org-life-calendar-inbox))
   2885       (use-package org-caldav
   2886         :init
   2887         (defconst za/org-life-calendar-inbox (concat za/org-life-dir "calendar-inbox.org"))
   2888         :custom
   2889         (org-caldav-url za/caldav-url)
   2890         (org-caldav-calendar-id za/caldav-org-calendar-id)
   2891         (org-caldav-inbox za/org-life-calendar-inbox)
   2892         (org-caldav-files (cons (car (split-string org-archive-location "::")) org-agenda-files))
   2893         (org-caldav-sync-todo nil)
   2894         (org-icalendar-include-todo nil)
   2895         (org-icalendar-use-deadline '(event-if-todo-not-done))
   2896         (org-icalendar-use-scheduled '(event-if-todo-not-done))
   2897         (org-caldav-exclude-tags '("HABIT")
   2898                                  "I don't want to export habits, because those will just clutter up my calendar. The calendar is supposed to be for one-off stuff, or rarely repeating stuff. Yes, I have to manually add the HABIT tag to every habit. Perhaps nicer would be to exclude based on the property ~:STYLE: habit~, but I haven't figured that one out yet.")
   2899         (org-caldav-todo-percent-states '((0 "TODO")
   2900                                           (0 "WAITING")
   2901                                           (1 "NEXT")
   2902                                           (2 "STARTED")
   2903                                           (0 "PROJ")
   2904                                           (100 "DONE")
   2905                                           (100 "CANCELLED")))
   2906         :config
   2907         (defun za/caldav-after-sync-notify () (za/notify "org-caldav sync complete" "Finished syncing"))
   2908         (advice-add #'org-caldav-sync :after #'za/caldav-after-sync-notify)
   2909         (advice-add #'org-caldav-sync :around #'za/notify-on-interactivity))
   2910     (warn "za/caldav-url, za/caldav-org-calendar-id, za/org-life-calendar-inbox not bound, not using org-caldav."))
   2911 #+end_src
   2912 
   2913 Maybe check [[https://old.reddit.com/r/orgmode/comments/8rl8ep/making_orgcaldav_useable/e0sb5j0/][this]] for a way to sync on save.
   2914 
   2915 *** org-ref
   2916 #+begin_src emacs-lisp
   2917   (use-package org-ref)
   2918 #+end_src
   2919 *** org-roam
   2920 #+begin_src emacs-lisp
   2921   (use-package org-roam
   2922     :custom
   2923     (org-roam-directory za/org-roam-dir)
   2924     (org-roam-completion-everywhere t)
   2925     (org-roam-dailies-capture-templates
   2926      '(("d" "default" entry
   2927         "* %U\n%?"
   2928         :target (file+head "%<%Y-%m-%d>.org"
   2929                            "#+title: %<%Y-%m-%d>\n"))))
   2930     :config
   2931                                           ; can't use nil because org-roam-ui checks for boundp on this and
   2932                                           ; errors if bound but nil.
   2933     (with-eval-after-load 'org-roam-dailies
   2934       (makunbound 'org-roam-dailies-directory))
   2935     (defun za/org-roam-dailies-goto-latest-note ()
   2936       (interactive)
   2937       (unless (boundp 'org-roam-dailies-directory)
   2938         (za/org-roam-dailies-select-dir))
   2939       (let* ((dailies (org-roam-dailies--list-files))
   2940              (latest-note (car (last dailies))))
   2941         (unless latest-note
   2942           (user-error "Can't find latest note"))
   2943         (find-file latest-note)
   2944         (run-hooks 'org-roam-dailies-find-file-hook)))
   2945     (org-roam-setup)
   2946     (bind-keys :prefix "C-c w"
   2947                :prefix-map za/org-roam-map
   2948                :prefix-docstring "Org roam"
   2949                ("n" . org-roam-capture)
   2950                ("f" . org-roam-node-find)
   2951                ("w" . org-roam-buffer-toggle)
   2952                ("i" . org-roam-node-insert))
   2953     (bind-keys :prefix "C-c j"
   2954                :prefix-map za/org-roam-dailies-map
   2955                :prefix-docstring "Org roam dailies"
   2956                ("s" . za/org-roam-dailies-select-dir)
   2957                ("n" . org-roam-dailies-capture-today)
   2958                ("j" . org-roam-dailies-goto-today)
   2959                ("+" . org-roam-dailies-goto-tomorrow)
   2960                (">" . org-roam-dailies-goto-next-note)
   2961                ("-" . org-roam-dailies-goto-yesterday)
   2962                ("<" . org-roam-dailies-goto-previous-note)
   2963                ("g" . org-roam-dailies-goto-date)
   2964                ("l" . za/org-roam-dailies-goto-latest-note)
   2965                ("." . org-roam-dailies-find-directory))
   2966 
   2967     (defun za/org-roam-dailies--daily-note-p (&optional file)
   2968       "Replacement of default function. Return t if FILE is an Org-roam daily-note, nil otherwise.
   2969   If FILE is not specified, use the current buffer's file-path."
   2970       (when-let ((path (expand-file-name
   2971                         (or file
   2972                             (buffer-file-name (buffer-base-buffer)))))
   2973                  (directory (expand-file-name org-roam-dailies-directory org-roam-directory)))
   2974         (setq path (expand-file-name path))
   2975         (save-match-data
   2976           (and
   2977            ;; (org-roam-file-p path) ; don't want this, dailies might not be in org-roam path
   2978            (org-roam-descendant-of-p path directory)))))
   2979     (advice-add #'org-roam-dailies--daily-note-p :override #'za/org-roam-dailies--daily-note-p)
   2980 
   2981     (defun za/org-roam-dailies-select-dir ()
   2982       "Select an org-roam-dailies folder."
   2983       (interactive)
   2984       (let* ((choices (cons '(?0 nil) za/org-roam-dailies-dirs))
   2985              (choice (nth 1 (read-multiple-choice "org-roam-dailies dir" choices))))
   2986         (if choice
   2987             (progn (setq org-roam-dailies-directory choice)
   2988                    (message "Selected org-roam-dailies directory: %s" org-roam-dailies-directory))
   2989           (makunbound 'org-roam-dailies-directory))))
   2990 
   2991     (defun za/org-roam-dailies-calendar-mark-entries-p ()
   2992       "Only mark dailies entries in calendar if a dailies directory is set."
   2993       (boundp 'org-roam-dailies-directory))
   2994     (advice-add #'org-roam-dailies-calendar-mark-entries :before-while #'za/org-roam-dailies-calendar-mark-entries-p)
   2995 
   2996     ;; Before doing anything journal-related, check that a journal is
   2997     ;; selected, or prompt for one.
   2998     (defun za/org-roam-dailies--capture-check-non-nil-dailies-dir (&rest _)
   2999       (unless (boundp 'org-roam-dailies-directory)
   3000         (za/org-roam-dailies-select-dir))
   3001       (unless (boundp 'org-roam-dailies-directory)
   3002         (user-error "No org-roam-dailies-directory selected!")))
   3003 
   3004     (advice-add #'org-roam-dailies--capture :before #'za/org-roam-dailies--capture-check-non-nil-dailies-dir)
   3005     (advice-add #'org-roam-dailies-goto-date :before #'za/org-roam-dailies--capture-check-non-nil-dailies-dir)
   3006     (require 'org-roam-export))
   3007 #+end_src
   3008 
   3009 *** org-roam-ui
   3010 #+begin_src emacs-lisp
   3011   (use-package org-roam-ui)
   3012 #+end_src
   3013 *** org-download
   3014 Drag-and-drop images to Emacs Org mode.
   3015 
   3016 #+begin_src emacs-lisp
   3017   (use-package org-download
   3018     :custom
   3019     (org-download-method 'attach)
   3020     (org-download-backend t))
   3021 #+end_src
   3022 
   3023 *** org-sticky-header
   3024 Displays in the header-line the Org heading for the node that’s at the top of the window.
   3025 
   3026 #+begin_src emacs-lisp
   3027   (use-package org-sticky-header)
   3028 #+end_src
   3029 *** org-timestone
   3030 #+begin_src emacs-lisp
   3031   (use-package org-timestone
   3032     :init (za/package-vc-install :repo "thezeroalpha/org-timestone.el")
   3033     :ensure nil
   3034     :after org
   3035     :bind (:map org-mode-map
   3036                 ("C-c C-t" . org-timestone-org-todo-wrapper)))
   3037 #+end_src
   3038 *** org-noter
   3039 #+begin_src emacs-lisp
   3040   (use-package org-noter
   3041     :config
   3042     ;; Fix disabling of line wrap by no-opping set-notes-scroll
   3043     (advice-add 'org-noter--set-notes-scroll :override 'za/no-op))
   3044 #+end_src
   3045 *** el-easydraw
   3046 Lets you draw stuff in org mode documents.
   3047 
   3048 #+begin_src emacs-lisp :tangle no
   3049   (za/package-vc-install :repo "misohena/el-easydraw" :name "edraw")
   3050   (with-eval-after-load 'org
   3051     (require 'edraw-org)
   3052     (edraw-org-setup-default)
   3053     (bind-key "C-c q c" #'edraw-color-picker-insert-color))
   3054 #+end_src
   3055 *** ox-jira
   3056 #+begin_src emacs-lisp
   3057   (use-package ox-jira)
   3058 #+end_src
   3059 *** org-confluence
   3060 ox-confluence with some custom code to remove the theme & create expandable drawers.
   3061 Add to confluence by pressing ~ctrl + shift + d~ when editing a page and inserting confluence wiki text.
   3062 
   3063 #+begin_src emacs-lisp
   3064   (require 'ox-confluence)
   3065   (org-export-define-derived-backend 'confluence-ext 'confluence
   3066     :translate-alist '((drawer . za/org-confluence-drawer))
   3067     :filters-alist '((:filter-src-block . za/org-confluence--code-block-remove-theme))
   3068     :menu-entry
   3069     '(?F "Export to Confluence (ext)"
   3070          ((?F "As Confluence buffer (ext)" za/org-confluence-export-as-confluence))))
   3071 
   3072   (defun za/org-confluence-export-as-confluence
   3073       (&optional async subtreep visible-only body-only ext-plist)
   3074     (interactive)
   3075     (org-export-to-buffer 'confluence-ext "*org CONFLUENCE Export*"
   3076       async subtreep visible-only body-only ext-plist (lambda () (text-mode))))
   3077 
   3078   (defun za/org-confluence--code-block-remove-theme (block _backend _info)
   3079     "Remove the theme from the block"
   3080     (replace-regexp-in-string (rx "\{code:theme=Emacs" (? "|")) "\{code:" block))
   3081 
   3082 
   3083   (defun za/org-confluence-drawer (drawer contents info)
   3084     "Handle custom drawers"
   3085     (let* ((name (org-element-property :drawer-name drawer)))
   3086       (concat
   3087        (format "\{expand:%s\}\n" name)
   3088        contents
   3089        "\{expand\}")))
   3090 #+end_src
   3091 *** TODO the path for org-roam export and data export should be configurable, not hard-coded
   3092 ** Mail mode for neomutt
   3093 When editing a message from neomutt, I want to use mail mode.
   3094 Even though I won't be sending the email from there, I like the syntax highlighting :)
   3095 
   3096 #+begin_src emacs-lisp
   3097   (add-to-list 'auto-mode-alist '("/neomutt-" . mail-mode))
   3098 #+end_src
   3099 ** DISABLED Semantic mode
   3100 Disabled for now, don't use it much.
   3101 SemanticDB is written into ~/.emacs.d/semanticdb/.
   3102 
   3103 #+begin_src emacs-lisp :tangle no
   3104   (use-package semantic
   3105     :bind (:map semantic-mode-map
   3106                 ("C-c , ." . semantic-ia-show-summary))
   3107     :custom
   3108     (semantic-default-submodes '(global-semantic-idle-scheduler-mode ; reparse buffer when idle
   3109                                  global-semanticdb-minor-mode ; maintain database
   3110                                  global-semantic-idle-summary-mode  ; show information (e.g. types) about tag at point
   3111                                  global-semantic-stickyfunc-mode))) ; show current func in header line
   3112 
   3113 
   3114 #+end_src
   3115 
   3116 ** Bib(la)tex
   3117 #+begin_src emacs-lisp
   3118   (use-package bibtex
   3119     :config
   3120     (bibtex-set-dialect "biblatex"))
   3121 #+end_src
   3122 
   3123 ** Python
   3124 In Python, I want to enable flycheck and semantic mode:
   3125 
   3126 #+begin_src emacs-lisp
   3127   (add-hook 'python-mode-hook #'flycheck-mode)
   3128   ;;(add-hook 'python-mode-hook #'semantic-mode)
   3129 #+end_src
   3130 
   3131 ** Elisp
   3132 #+begin_src emacs-lisp
   3133   (use-package emacs-lisp
   3134     :ensure nil ; preinstalled
   3135     :hook ((emacs-lisp-mode . flycheck-mode)
   3136            (emacs-lisp-mode . rainbow-mode)
   3137            (emacs-lisp-mode . outline-minor-mode)
   3138            (emacs-lisp-mode . company-mode)))
   3139 #+end_src
   3140 ** lean-mode
   3141 Specifically for the Lean prover.
   3142 I also install company-lean and helm-lean, which are suggested on the [[https://github.com/leanprover/lean-mode][Github page]].
   3143 Then I map company-complete only for lean-mode.
   3144 
   3145 #+begin_src emacs-lisp
   3146   (use-package lean-mode
   3147     :config
   3148     (use-package company-lean)
   3149     :bind (:map lean-mode-map
   3150                 ("S-SPC" . company-complete)))
   3151 #+end_src
   3152 
   3153 ** sh-mode
   3154 #+begin_src emacs-lisp :results value
   3155   (use-package sh-script
   3156     :hook (sh-mode . flycheck-mode))
   3157 #+end_src
   3158 
   3159 ** anki-editor
   3160 Some extra keybindings that are not set up by default.
   3161 anki-editor doesn't provide a keymap so I have to set one up here:
   3162 
   3163 #+begin_src emacs-lisp
   3164   (use-package anki-editor
   3165     :init
   3166     (defvar anki-editor-mode-map (make-sparse-keymap))
   3167     (add-to-list 'minor-mode-map-alist (cons 'anki-editor-mode
   3168                                              anki-editor-mode-map))
   3169     :custom
   3170     (anki-editor-use-math-jax t)
   3171 
   3172     :bind (:map anki-editor-mode-map
   3173                 ("C-c t" . org-property-next-allowed-value)
   3174                 ("C-c i" . anki-editor-insert-note)
   3175                 ("C-c p" . anki-editor-push-notes)
   3176                 ("C-c c" . anki-editor-cloze-dwim)))
   3177 #+end_src
   3178 ** pdf-tools
   3179 A better replacement for DocView:
   3180 
   3181 #+begin_src emacs-lisp
   3182   (use-package pdf-tools
   3183     :init
   3184     (pdf-tools-install)
   3185 
   3186     :custom
   3187     (pdf-annot-default-annotation-properties '((t
   3188                                                 (label . "Alex Balgavy"))
   3189                                                (text
   3190                                                 (icon . "Note")
   3191                                                 (color . "#0088ff"))
   3192                                                (highlight
   3193                                                 (color . "yellow"))
   3194                                                (squiggly
   3195                                                 (color . "orange"))
   3196                                                (strike-out
   3197                                                 (color . "red"))
   3198                                                (underline
   3199                                                 (color . "blue"))))
   3200     :bind (:map pdf-isearch-minor-mode-map
   3201                 ("C-s" . isearch-forward)
   3202                 :map pdf-view-mode-map
   3203                 ;; Save position & jump back
   3204                 ("C-SPC" . (lambda () (interactive) (message "Position saved") (pdf-view-position-to-register ?x)))
   3205                 ("C-u C-SPC" . (lambda () (interactive) (pdf-view-jump-to-register ?x))))
   3206     :hook
   3207     (pdf-annot-list-mode . pdf-annot-list-follow-minor-mode)
   3208     (pdf-annot-edit-contents-minor-mode . org-mode)
   3209     (pdf-view-mode . (lambda () (display-line-numbers-mode 0)))
   3210 
   3211     :config
   3212     ;; The arrow tooltip does not show properly when jumping to a
   3213     ;; location. Maybe this is a Mac-only thing. See here:
   3214     ;; https://github.com/politza/pdf-tools/issues/145
   3215     ;; This ~:override~ advice fixes it, color is customized via ~tooltip~ face
   3216     (advice-add #'pdf-util-tooltip-arrow :override #'za/pdf-util-tooltip-arrow)
   3217     (defun za/pdf-util-tooltip-arrow (image-top &optional timeout)
   3218       "Fix up `pdf-util-tooltip-arrow`, the original doesn't show the arrow."
   3219       (pdf-util-assert-pdf-window)
   3220       (when (floatp image-top)
   3221         (setq image-top
   3222               (round (* image-top (cdr (pdf-view-image-size))))))
   3223       (let* (x-gtk-use-system-tooltips ;allow for display property in tooltip
   3224              (dx (+ (or (car (window-margins)) 0)
   3225                     (car (window-fringes))))
   3226              (dy image-top)
   3227              (pos (list dx dy dx (+ dy (* 2 (frame-char-height)))))
   3228              (vscroll
   3229               (pdf-util-required-vscroll pos))
   3230              (tooltip-frame-parameters
   3231               `((border-width . 0)
   3232                 (internal-border-width . 0)
   3233                 ,@tooltip-frame-parameters))
   3234              (tooltip-hide-delay (or timeout 3)))
   3235         (when vscroll
   3236           (image-set-window-vscroll vscroll))
   3237         (setq dy (max 0 (- dy
   3238                            (cdr (pdf-view-image-offset))
   3239                            (window-vscroll nil t)
   3240                            (frame-char-height))))
   3241         (when (overlay-get (pdf-view-current-overlay) 'before-string)
   3242           (let* ((e (window-inside-pixel-edges))
   3243                  (xw (pdf-util-with-edges (e) e-width)))
   3244             (cl-incf dx (/ (- xw (car (pdf-view-image-size t))) 2))))
   3245         (pdf-util-tooltip-in-window "\u2192" dx dy))))
   3246 #+end_src
   3247 
   3248 *** TODO this clobbers register x. Find a way to not clobber a register
   3249 ** virtualenvwrapper
   3250 Like virtualenvwrapper.sh, but for Emacs.
   3251 
   3252 #+begin_src emacs-lisp
   3253   (use-package virtualenvwrapper
   3254     :custom
   3255     (venv-location "~/.config/virtualenvs")
   3256 
   3257     :config
   3258     (venv-initialize-interactive-shells)
   3259     (venv-initialize-eshell))
   3260 #+end_src
   3261 
   3262 ** ledger
   3263 #+begin_src emacs-lisp
   3264   (use-package ledger-mode
   3265     :mode ("\\.ledger\\'")
   3266     :hook (ledger-mode . company-mode)
   3267     :custom
   3268     (ledger-clear-whole-transactions t)
   3269     (ledger-reconcile-default-commodity "eur")
   3270     (ledger-reports
   3271      '(("unreconciled" "%(binary) [[ledger-mode-flags]] -f %(ledger-file) --start-of-week=1 reg --uncleared")
   3272        ("net-worth-changes" "%(binary) [[ledger-mode-flags]] -f %(ledger-file) reg ^Assets ^Liabilities -R -M -X eur --effective -n")
   3273        ("budget-last-month" "%(binary) -f %(ledger-file) --start-of-week=1 --effective -X eur --period \"last month\" budget ^expenses:budgeted")
   3274        ("budget-this-month" "%(binary) -f %(ledger-file) --start-of-week=1 --effective -X eur --period \"this month\" budget ^expenses:budgeted")
   3275        ("expenses-this-month-vs-budget" "%(binary) -f %(ledger-file) --start-of-week=1 --effective --period \"this month\" --period-sort \"(amount)\" bal ^expenses:budgeted --budget -R")
   3276        ("expenses-last-month-vs-budget" "%(binary) -f %(ledger-file) --start-of-week=1 --effective --period \"last month\" --period-sort \"(amount)\" bal ^expenses:budgeted --budget -R")
   3277        ("expenses-last-month" "%(binary) -f %(ledger-file) --start-of-week=1 --effective --period \"last month\" --period-sort \"(amount)\" bal ^expenses -X eur -R")
   3278        ("expenses-this-month" "%(binary) -f %(ledger-file) --start-of-week=1 --effective --period \"this month\" --period-sort \"(amount)\" bal ^expenses -X eur -R")
   3279        ("expenses-vs-income-this-month" "%(binary) -f %(ledger-file) --start-of-week=1 --effective --period \"this month\" --period-sort \"(amount)\" bal ^income ^expenses -X eur -R")
   3280        ("expenses-vs-income-last-month" "%(binary) -f %(ledger-file) --start-of-week=1 --effective --period \"last month\" --period-sort \"(amount)\" bal ^expenses ^income -X eur -R")
   3281        ("bal-assets-czk" "%(binary) -f %(ledger-file) --start-of-week=1 bal Assets Liabilities -X czk -R")
   3282        ("bal-assets" "%(binary) -f %(ledger-file) --start-of-week=1 bal Assets Liabilities -R")
   3283        ("bal" "%(binary) -f %(ledger-file) --start-of-week=1 bal -B -R")
   3284        ("bal-assets-eur" "%(binary) -f %(ledger-file) --start-of-week=1 bal Assets Liabilities -X eur -R")
   3285        ("monthly-balance-abn-checking" "%(binary) -f %(ledger-file) --start-of-week=1 --effective reg --monthly 'Assets:ABN Checking' -R")
   3286        ("monthly-expenses" "%(binary) -f %(ledger-file) --monthly register ^expenses --effective --collapse -X eur -R")
   3287        ("reg" "%(binary) -f %(ledger-file) --start-of-week=1 reg -R")
   3288        ("payee" "%(binary) -f %(ledger-file) --start-of-week=1 reg @%(payee) -R")
   3289        ("account" "%(binary) -f %(ledger-file) --start-of-week=1 reg %(account) -R")
   3290        ("reg-org-table" "%(binary) -f %(ledger-file) csv --csv-format '|%(scrub(date))|%(scrub(display_account))|%(scrub(payee))|%(scrub(display_amount))|%(scrub(display_total))|
   3291   ' %(account) -R")))
   3292     :config
   3293     (with-eval-after-load 'ledger-mode
   3294       (setq ledger-amount-regex
   3295             (rx
   3296              (group (or (= 2 " ") ?\t (seq " " ?\t)))
   3297              (zero-or-more (any " " ?\t))
   3298              (opt "=")
   3299              (zero-or-more space)
   3300              (opt "-")
   3301              (opt "(")
   3302              (one-or-more (opt (group
   3303                                 (one-or-more (any "A-Z" "$(_£€₹"))
   3304                                 (zero-or-more blank)))
   3305                           (group (opt "-")
   3306                                  (or (one-or-more (any "0-9"))
   3307                                      (+\? (any "0-9" ",."))))
   3308                           (opt (group (any ",.")
   3309                                       (one-or-more (any "0-9" ")"))))
   3310                           (opt (group (zero-or-more blank)
   3311                                       (one-or-more (any "\"_£€₹" word))))
   3312                           (opt (zero-or-more (any blank))
   3313                                (any "*+/-")
   3314                                (zero-or-more (any blank))))
   3315              (opt ")")
   3316              (opt (group (zero-or-more (any blank))
   3317                          (any "=@{")
   3318                          (opt "@")
   3319                          (+? (not (any ?\xA ";")))))
   3320              (opt (group (or (seq (one-or-more (any blank)) ";" (+\? nonl))
   3321                              (zero-or-more (any blank)))))
   3322              eol))))
   3323 #+end_src
   3324 
   3325 org-capture lets me add transactions from anywhere in Emacs:
   3326 
   3327 Budget throws an error when there's multiple commodities involved.
   3328 See discussion here: https://github.com/ledger/ledger/issues/1450#issuecomment-390067165
   3329 
   3330 #+begin_src emacs-lisp
   3331   (defconst za/ledger-budget-fix-string
   3332     "-X eur -F '%(justify(scrub(get_at(display_total, 0)), 20, -1, true, false)) %(justify(get_at(display_total, 1) ? -scrub(get_at(display_total, 1)) : 0.0, 20,            20 + 1 + 20, true, false)) %(justify(get_at(display_total, 1) ? (get_at(display_total, 0) ?           -(scrub(get_at(display_total, 1) + get_at(display_total, 0))) :           -(scrub(get_at(display_total, 1)))) : -(scrub(get_at(display_total, 0))), 20,            20 + 1 + 20 + 1 + 20, true, false))%(get_at(display_total, 1) and (abs(quantity(scrub(get_at(display_total, 0))) /           quantity(scrub(get_at(display_total, 1)))) >= 1) ?  \" \" : \" \")%(justify((get_at(display_total, 1) ?           (100% * (get_at(display_total, 0) ? scrub(get_at(display_total, 0)) : 0.0)) /              -scrub(get_at(display_total, 1)) : \"na\"),            5, -1, true, false))  %(!options.flat ? depth_spacer : \"\")%-(partial_account(options.flat))\n%/%$2 %$3 %$4 %$6\n%/%(prepend_width ? \" \" * int(prepend_width) : \"\")    ----------------     ----------------     ---------------- -----\n'"
   3333     "Append this to a ledger budget to fix errors with multiple commodities.")
   3334 #+end_src
   3335 
   3336 ** Notmuch
   3337 #+begin_src emacs-lisp
   3338   (use-package notmuch
   3339     :custom
   3340     (notmuch-saved-searches
   3341      `((:name "inbox: personal" :query ,(format "folder:/%s/ tag:inbox" za/email-personal) :key ,(kbd "ip") :search-type 'tree)
   3342        (:name "inbox: school" :query ,(format "folder:/%s/ tag:inbox" za/email-vu) :key ,(kbd "is") :search-type 'tree)
   3343        (:name "archive: personal" :query ,(format "folder:/%s/ tag:archive" za/email-personal) :key ,(kbd "ap") :search-type 'tree)
   3344        (:name "archive: school" :query ,(format "folder:/%s/ tag:archive" za/email-vu) :key ,(kbd "as") :search-type 'tree))
   3345      "Define some saved searches (i.e. mailboxes)")
   3346     (notmuch-hello-sections
   3347      '(notmuch-hello-insert-header
   3348        notmuch-hello-insert-saved-searches
   3349        notmuch-hello-insert-search
   3350        notmuch-hello-insert-alltags
   3351        notmuch-hello-insert-footer)
   3352      "Define the main screen sections")
   3353     (notmuch-search-oldest-first nil "Show newest mail first")
   3354     (notmuch-archive-tags '("-inbox" "+archive"))
   3355     (notmuch-tagging-keys '(("a" notmuch-archive-tags "Archive")
   3356                             ("r" notmuch-show-mark-read-tags "Mark read")
   3357                             ("u" notmuch-show-mark-unread-tags "Mark unread")
   3358                             ("d" notmuch-delete-tags "Delete")))
   3359 
   3360     :bind (("C-c m" . notmuch)
   3361            :map notmuch-show-mode-map
   3362            ("C-c M-y" . shr-copy-url))
   3363     ;; Run notmuch-hook script on hello refresh, to move messages to
   3364     ;; folders according to their tags:
   3365     :hook (notmuch-hello-refresh . za/notmuch-hook-tags2folders)
   3366     :init (setenv "NOTMUCH_CONFIG" "/Users/alex/.config/notmuch/config")
   3367     :config
   3368     (setq notmuch-show-mark-unread-tags '("+unread"))
   3369     (setq notmuch-delete-tags '("-inbox" "+trash"))
   3370     (defun za/notmuch-hook-tags2folders ()
   3371       "Run notmuch-hook to organise email in folders based on tags."
   3372       (start-process "notmuch-hook" nil "notmuch-hook" "--tags2folders")))
   3373 #+end_src
   3374 
   3375 ** MPC
   3376 #+begin_src emacs-lisp
   3377   (use-package mpc
   3378     :custom
   3379     (mpc-browser-tags '(AlbumArtist Album Genre Playlist)
   3380                       "Set the windows I want to show")
   3381 
   3382     :bind (:map mpc-mode-map
   3383                 ("a" . mpc-playlist-add)
   3384                 ("P" . mpc-playlist)
   3385                 ("x" . mpc-playlist-delete)
   3386                 ("p" . mpc-toggle-play)
   3387                 ("t" . mpc-select-toggle)
   3388                 ("f" . za/mpc-seek-forward-20-seconds)
   3389                 ("b" . za/mpc-seek-backward-20-seconds))
   3390     :config
   3391     (defun za/mpc-seek-forward-20-seconds ()
   3392       "Seek forward 20 seconds"
   3393       (interactive)
   3394       (mpc-seek-current "+20"))
   3395 
   3396     (defun za/mpc-seek-backward-20-seconds ()
   3397       "Seek backward 20 seconds"
   3398       (interactive)
   3399       (mpc-seek-current "-20")))
   3400 #+end_src
   3401 ** Dired
   3402 #+begin_src emacs-lisp
   3403   (use-package dired
   3404     :ensure nil ; installed with Emacs
   3405     :bind (:map dired-mode-map
   3406                 ;; 'i' expands subdirs, so I want to be able to close them too.
   3407                 ("M-k" . dired-kill-subdir))
   3408     :custom
   3409     (dired-listing-switches "-alhv")
   3410     (dired-dwim-target t "If I have another dired window open, use that as target")
   3411     ;; By default, hide details (show again by pressing oparen):
   3412     :hook (dired-mode . dired-hide-details-mode))
   3413 #+end_src
   3414 
   3415 ** ess: statistics (R, SAS...)
   3416 #+begin_src emacs-lisp
   3417   (use-package ess)
   3418 #+end_src
   3419 
   3420 ** help mode
   3421 #+begin_src emacs-lisp
   3422   (use-package help-mode
   3423     :ensure nil ; included with Emacs
   3424     :hook (help-mode . za/settings-on-help-mode)
   3425     :config
   3426     (defun za/settings-on-help-mode ()
   3427       "Settings on enabling help mode"
   3428       (za/toggle-wrap t)))
   3429 #+end_src
   3430 ** helpful
   3431 An alternative to the built-in Emacs help that provides much more contextual information.
   3432 I use counsel, so I use the keybindings in [[*counsel + ivy + swiper]].
   3433 I just augment the functions counsel uses.
   3434 Also, counsel doesn't provide some keybindings that I can get from helpful.
   3435 
   3436 #+begin_src emacs-lisp
   3437   (use-package helpful
   3438     :custom
   3439     (counsel-describe-symbol-function #'helpful-symbol)
   3440     (counsel-describe-function-function #'helpful-callable)
   3441     (counsel-describe-variable-function #'helpful-variable)
   3442 
   3443     :bind (("C-h k" . helpful-key)
   3444            ("C-h C" . helpful-command)
   3445            :map helpful-mode-map
   3446            ("l" . za/helpful-previous)
   3447            ("r" . za/helpful-next))
   3448 
   3449     :hook (helpful-mode . za/settings-on-helpful-mode)
   3450     :config
   3451 
   3452     (defun za/settings-on-helpful-mode ()
   3453       "Settings on enabling helpful mode"
   3454       (za/toggle-wrap t))
   3455 
   3456     ;; Then, a way to jump forward and backward in the window:
   3457     (defvar za/helpful-buffer-ring-size 20
   3458       "How many buffers are stored for use with `helpful-next'.")
   3459 
   3460     (defvar za/helpful--buffer-ring (make-ring za/helpful-buffer-ring-size)
   3461       "Ring that stores the current Helpful buffer history.")
   3462 
   3463     (defun za/helpful--buffer-index (&optional buffer)
   3464       "If BUFFER is a Helpful buffer, return it’s index in the buffer ring."
   3465       (let ((buf (or buffer (current-buffer))))
   3466         (and (eq (buffer-local-value 'major-mode buf) 'helpful-mode)
   3467              (seq-position (ring-elements za/helpful--buffer-ring) buf #'eq))))
   3468 
   3469     (defun za/helpful--new-buffer-a (help-buf)
   3470       "Update the buffer ring according to the current buffer and HELP-BUF."
   3471       :filter-return #'helpful--buffer
   3472       (let ((buf-ring za/helpful--buffer-ring))
   3473         (let ((newer-buffers (or (za/helpful--buffer-index) 0)))
   3474           (dotimes (_ newer-buffers) (ring-remove buf-ring 0)))
   3475         (when (/= (ring-size buf-ring) za/helpful-buffer-ring-size)
   3476           (ring-resize buf-ring za/helpful-buffer-ring-size))
   3477         (ring-insert buf-ring help-buf)))
   3478 
   3479     (advice-add #'helpful--buffer :filter-return #'za/helpful--new-buffer-a)
   3480 
   3481     (defun za/helpful--next (&optional buffer)
   3482       "Return the next live Helpful buffer relative to BUFFER."
   3483       (let ((buf-ring za/helpful--buffer-ring)
   3484             (index (or (za/helpful--buffer-index buffer) -1)))
   3485         (cl-block nil
   3486           (while (> index 0)
   3487             (cl-decf index)
   3488             (let ((buf (ring-ref buf-ring index)))
   3489               (if (buffer-live-p buf) (cl-return buf)))
   3490             (ring-remove buf-ring index)))))
   3491 
   3492 
   3493     (defun za/helpful--previous (&optional buffer)
   3494       "Return the previous live Helpful buffer relative to BUFFER."
   3495       (let ((buf-ring za/helpful--buffer-ring)
   3496             (index (1+ (or (za/helpful--buffer-index buffer) -1))))
   3497         (cl-block nil
   3498           (while (< index (ring-length buf-ring))
   3499             (let ((buf (ring-ref buf-ring index)))
   3500               (if (buffer-live-p buf) (cl-return buf)))
   3501             (ring-remove buf-ring index)))))
   3502 
   3503     (defun za/helpful-next ()
   3504       "Go to the next Helpful buffer."
   3505       (interactive)
   3506       (when-let (buf (za/helpful--next))
   3507         (funcall helpful-switch-buffer-function buf)))
   3508 
   3509     (defun za/helpful-previous ()
   3510       "Go to the previous Helpful buffer."
   3511       (interactive)
   3512       (when-let (buf (za/helpful--previous))
   3513         (funcall helpful-switch-buffer-function buf))))
   3514 #+end_src
   3515 ** Tex-mode
   3516 #+begin_src emacs-lisp
   3517   (use-package tex-mode
   3518     :ensure nil ; installed with Emacs
   3519     :hook (tex-mode . za/settings-on-tex-mode)
   3520     :config
   3521     (defun za/settings-on-tex-mode ()
   3522       "Settings on enabling helpful mode"
   3523       (setq comment-add 0)))
   3524 #+end_src
   3525 ** Quail
   3526 #+begin_src emacs-lisp
   3527   (use-package quail
   3528     :ensure nil) ; provided by Emacs
   3529 #+end_src
   3530 ** Markdown
   3531 #+begin_src emacs-lisp
   3532   (use-package markdown-mode)
   3533 #+end_src
   3534 ** vdirel (contacts)
   3535 #+begin_src emacs-lisp
   3536   (use-package vdirel
   3537     :config
   3538     (vdirel-switch-repository "~/.local/share/contacts/default"))
   3539 #+end_src
   3540 ** Yaml
   3541 #+begin_src emacs-lisp
   3542   (use-package yaml-mode
   3543     :commands yaml-mode
   3544     :init
   3545     (add-hook 'yaml-mode-hook
   3546               (lambda ()
   3547                 (setq-local outline-regexp (rx (* blank)))
   3548                 (outline-minor-mode))))
   3549 #+end_src
   3550 ** calc
   3551 #+begin_src emacs-lisp
   3552   (use-package calc
   3553     :config
   3554     (setq math-additional-units
   3555      ;; elements:
   3556      ;; - symbol identifying the unit,
   3557      ;; - expression indicatingv alue of unit or nil for fundamental units
   3558      ;; - textual description
   3559      '((b nil "Bit")
   3560        (B "b * 8" "Bytes")
   3561        (KiB "1024 * B" "Kibibyte")
   3562        (MiB "1024 * KiB" "Mebibyte")
   3563        (GiB "1024 * MiB" "Gibibyte")
   3564        (TiB "1024 * GiB" "Tebibyte")
   3565        (PiB "1024 * TiB" "Pebibyte")
   3566        (EiB "1024 * PiB" "Exbibyte")
   3567        (ZiB "1024 * EiB" "Zebibyte")
   3568        (YiB "1024 * ZiB" "Yobibyte")
   3569        (KB "1000 * B" "Kilobyte")
   3570        (MB "1000 * KB" "Megabyte")
   3571        (GB "1000 * MB" "Gigabyte")
   3572        (TB "1000 * GB" "Terabyte")
   3573        (PB "1000 * TB" "Petabyte")
   3574        (EB "1000 * PB" "Exabyte")
   3575        (ZB "1000 * EB" "Zettabyte")
   3576        (YB "1000 * ZB" "Yottabyte")
   3577        (Kib "1024 * b" "Kibibit")
   3578        (Mib "1024 * Kib" "Mebibit")
   3579        (Gib "1024 * Mib" "Gibibit")
   3580        (Kb "1000 * b" "Kilobit")
   3581        (Mb "1000 * Kb" "Megabit")
   3582        (Gb "1000 * Mb" "Gigabit")))
   3583     (setq math-units-table nil))
   3584 #+end_src
   3585 ** casual
   3586 #+begin_src emacs-lisp
   3587   (use-package casual
   3588     :config
   3589     (require 'casual-image)
   3590     :bind (:map calc-mode-map
   3591            ("C-o" . 'casual-calc-tmenu)
   3592            :map dired-mode-map
   3593            ("C-o" . 'casual-dired-tmenu)
   3594            ("C-u C-o" . 'dired-display-file)
   3595            :map calendar-mode-map
   3596            ("C-o" . 'casual-calendar-tmenu)
   3597            :map image-mode-map
   3598            ("C-o" . 'casual-image-tmenu)))
   3599 #+end_src
   3600 ** json
   3601 #+begin_src emacs-lisp
   3602   (use-package json-mode)
   3603 #+end_src
   3604 ** rust
   3605 #+begin_src emacs-lisp
   3606   (use-package rust-mode)
   3607 #+end_src
   3608 ** artist mode
   3609 #+begin_src emacs-lisp
   3610   (use-package artist
   3611     :ensure nil ; included with emacs
   3612     :custom (artist-figlet-default-font "term"))
   3613 #+end_src
   3614 * Override some faces
   3615 #+begin_src emacs-lisp
   3616   (with-eval-after-load 'org-faces
   3617     (set-face-attribute 'org-table nil :inherit 'fixed-pitch)
   3618     (set-face-attribute 'org-block nil :inherit 'fixed-pitch))
   3619 #+end_src
   3620 * Shortdoc
   3621 Set a better keybinding (I'm never gonna use ~view-hello-file~ anyways):
   3622 
   3623 #+begin_src emacs-lisp
   3624   (bind-key "C-h h" #'shortdoc-display-group)
   3625 #+end_src
   3626 * Upcoming new features
   3627 In a new version of use-package, I can use the :vc keyword, so check for when that's available.
   3628 See [[https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=2ce279680bf9c1964e98e2aa48a03d6675c386fe][commit]] and [[https://tony-zorman.com/posts/use-package-vc.html][article]].
   3629 
   3630 #+begin_src emacs-lisp
   3631   (when (fboundp 'use-package-vc-install)
   3632     (user-error "use-package :vc keyword now available!"))
   3633 #+end_src
   3634 * References
   3635 Here's a list of good articles I encountered about configging emacs:
   3636 - [[https://karthinks.com/software/batteries-included-with-emacs/][Batteries included with Emacs]]
   3637 - [[https://karthinks.com/software/more-batteries-included-with-emacs/][More batteries included with emacs]]
   3638 
   3639 For Org mode, [[https://www.youtube.com/playlist?list=PLVtKhBrRV_ZkPnBtt_TD1Cs9PJlU0IIdE][Rainer König's tutorials]] are the best.
   3640 [[https://emacs.cafe/emacs/orgmode/gtd/2017/06/30/orgmode-gtd.html][Here's a good reference for setting up gtd in org mode]]