808 lines
34 KiB
EmacsLisp
808 lines
34 KiB
EmacsLisp
;;; oni-org.el --- Org mode configuration -*- lexical-binding: t; -*-
|
||
|
||
;; Copyright (C) 2019 Tom Willemse
|
||
|
||
;; Author: Tom Willemse <tom@ryuslash.org>
|
||
;; Keywords: local
|
||
;; Version: 2022.0315.220855
|
||
;; Package-Requires: (oni-yasnippet oni-alert oni-hydra org org-contrib org-bullets org-edna diminish all-the-icons olivetti mixed-pitch)
|
||
|
||
;; This program is free software; you can redistribute it and/or modify
|
||
;; it under the terms of the GNU General Public License as published by
|
||
;; the Free Software Foundation, either version 3 of the License, or
|
||
;; (at your option) any later version.
|
||
|
||
;; This program is distributed in the hope that it will be useful,
|
||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
;; GNU General Public License for more details.
|
||
|
||
;; You should have received a copy of the GNU General Public License
|
||
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
|
||
;;; Commentary:
|
||
|
||
;; Configuration for `org-mode'. The icons used in
|
||
;; ‘org-agenda-category-icon-alist’ are from the following sites:
|
||
|
||
;; - bx*-*.svg: https://boxicons.com/ (bxs for Solid, and bx for not solid)
|
||
;; - mat-*.svg: https://fonts.google.com/icons?selected=Material+Icons
|
||
;; - bs-*.svg: https://icons.getbootstrap.com/
|
||
|
||
;; Add the following to your init file if you want to use this configuration:
|
||
;;
|
||
;; (with-eval-after-load 'org (require 'oni-org))
|
||
|
||
;;; Code:
|
||
|
||
(require 'diminish)
|
||
(require 'hydra)
|
||
(require 'ob)
|
||
;; (require 'ol-man)
|
||
(require 'org)
|
||
(require 'org-clock)
|
||
(require 'org-edna)
|
||
(require 'org-element)
|
||
(require 'org-faces)
|
||
(require 'org-habit)
|
||
(require 'org-protocol)
|
||
(require 'subr-x)
|
||
(require 'yasnippet)
|
||
|
||
;;; Constants
|
||
|
||
(defconst oni-org-root
|
||
(file-name-directory
|
||
(or load-file-name
|
||
(buffer-file-name)))
|
||
"The directory where ‘oni-org’ was loaded from.")
|
||
|
||
(defconst oni-org-snippets-dir
|
||
(expand-file-name "snippets" oni-org-root)
|
||
"The directory where ‘oni-org’ stores its snippets.")
|
||
|
||
(defconst oni-org-icons-dir
|
||
(expand-file-name "icons" oni-org-root)
|
||
"The directory where ‘oni-org’ stores its icons.")
|
||
|
||
(defconst oni-org-todo-dir
|
||
(expand-file-name "documents/gtd" (getenv "HOME"))
|
||
"The directory where all the TODO notes are stored.")
|
||
|
||
(defconst oni-org-todo-main-file
|
||
(expand-file-name "everything.org" oni-org-todo-dir)
|
||
"The main file for TODO notes.")
|
||
|
||
(defconst oni-org-todo-someday-file
|
||
(expand-file-name "someday.org" oni-org-todo-dir)
|
||
"The file for TODO notes I will want to do some day, but not today.")
|
||
|
||
;;; Fake org-roam -- oni-org-exocortex
|
||
;; I tried using org-roam v2 with Orgro, but it didn’t work. I’ve only been
|
||
;; using org-roam to more easily find and insert strings. The file renaming in
|
||
;; v1 always seemed to have some issue, so I never really used that. And I
|
||
;; didn’t even look any further into any of the functionality. So these
|
||
;; functions are my re-implementation of the convenience of org-roam. This way
|
||
;; Orgro still works and I can easily build up my knowledge base as well. I call
|
||
;; it fake org-roam for now because I’m too tired to think of anything else,
|
||
;; it’s not actually enough to be a fake anything.
|
||
|
||
(eval-when-compile (require 'cl-macs))
|
||
|
||
(defvar oni-org-exocortex-directory (expand-file-name "~/documents/org"))
|
||
|
||
;; Expected (I need to turn these into tests):
|
||
|
||
;; - C++ :: c
|
||
;; - Crafting Interpreters - 10 - Fucntions - Native Functions :: crafting_interpreters_10_functions_native_functions
|
||
|
||
;; This is a helper function to turn the strings into the same kind of slugs
|
||
;; that org-roam uses so I stay consistent in my naming.
|
||
(defun oni-org--slugify (str)
|
||
"Turn STR into a filesystem-safe slug."
|
||
(let ((regexp (rx (one-or-more (not alphanumeric)))))
|
||
(downcase
|
||
(replace-regexp-in-string regexp "_" (string-trim-right str regexp)))))
|
||
|
||
;; This mimicks the file name pattern of org-roam with a date and time, followed
|
||
;; by a filesystem-safe slug of the actual title.
|
||
(defun oni-org--create-name (title)
|
||
(interactive "MTitle: ")
|
||
(format "%s-%s.org"
|
||
(format-time-string "%Y%m%d%H%M%S")
|
||
(oni-org--slugify title)))
|
||
|
||
;; Collect all of the files under the ‘oni-org-exocortex-directory’. org-roam indexes
|
||
;; all of the files in a database, but I really didn’t want to recreate that
|
||
;; today. For the moment I don’t have so many files that parsing all of them
|
||
;; like this is a huge problem.
|
||
(defun oni-org--get-exocortex-files ()
|
||
(cl-labels ((add-titles (file)
|
||
(list (with-temp-buffer
|
||
(insert-file-contents (expand-file-name file))
|
||
(goto-char (point-min))
|
||
(let ((line-end-position (line-end-position)))
|
||
(when (search-forward ":" line-end-position t)
|
||
(buffer-substring-no-properties (1+ (point)) line-end-position))))
|
||
file))
|
||
(unimportant-file-p (file)
|
||
(or (string-prefix-p "." (file-name-nondirectory file))
|
||
(string-match-p (rx bos "#" (one-or-more any) "#" eos) (file-name-nondirectory file))))
|
||
(unimportant-directory-p (directory)
|
||
(not (string-match-p (rx "/.") directory))))
|
||
(mapcar #'add-titles
|
||
(cl-delete-if #'unimportant-file-p
|
||
(directory-files-recursively oni-org-exocortex-directory (rx bos (repeat 14 digit) "-" (one-or-more (any alphanumeric "_")) ".org") nil #'unimportant-directory-p)))))
|
||
|
||
;; Find and visit a file in the ‘oni-org-exocortex-directory’. If the file doesn’t
|
||
;; exist yet, it’s created and the title is inserted into it.
|
||
(defun oni-org-find-exocortex-file ()
|
||
(interactive)
|
||
(let* ((default-directory oni-org-exocortex-directory)
|
||
(completions (oni-org--get-exocortex-files))
|
||
(pick (completing-read "File: " completions))
|
||
(file (car (alist-get pick completions nil nil #'string=))))
|
||
(if file
|
||
(find-file file)
|
||
(find-file (oni-org--create-name pick))
|
||
(insert "#+TITLE: " pick "\n\n"))))
|
||
|
||
;; Insert a link to a file in the ‘oni-org-exocortex-directory’ into the current
|
||
;; buffer. Don’t visit the file, just insert a link to it.
|
||
(defun oni-org-insert-exocortex-link ()
|
||
(interactive)
|
||
(let* ((completions (oni-org--get-exocortex-files))
|
||
(pick (completing-read "File: " completions))
|
||
(file (car (alist-get pick completions nil nil #'string=))))
|
||
(unless file
|
||
(setq file (oni-org--create-name pick))
|
||
(with-current-buffer (find-file-noselect file)
|
||
(insert "#+TITLE: " pick "\n\n")
|
||
(save-buffer)))
|
||
(insert "[[file:" (file-relative-name file oni-org-exocortex-directory) "][" pick "]]")))
|
||
|
||
;;; Functions
|
||
|
||
(defun oni-org-document-add-inline-images-startup ()
|
||
"Add a line to the current org buffer that will make it load images inline."
|
||
(interactive)
|
||
(unless (derived-mode-p 'org-mode)
|
||
(error "Not currently in an org-mode buffer"))
|
||
(save-excursion
|
||
(goto-char (point-min))
|
||
(let ((header-end (or (search-forward "\n\n" nil t)
|
||
(point-max)))
|
||
(case-fold-search t))
|
||
(goto-char (point-min))
|
||
(unless (search-forward "#+startup: inlineimages" header-end t)
|
||
(goto-char (1- header-end))
|
||
(insert "#+STARTUP: inlineimages\n")))))
|
||
|
||
(defun oni-org-document-remove-inline-images-startup ()
|
||
"Remove a line to the current org buffer that will make it load images inline."
|
||
(interactive)
|
||
(unless (derived-mode-p 'org-mode)
|
||
(error "Not currently in an org-mode buffer"))
|
||
(save-excursion
|
||
(goto-char (point-min))
|
||
(let ((header-end (or (search-forward "\n\n" nil t)
|
||
(point-max)))
|
||
(case-fold-search t))
|
||
(goto-char (point-min))
|
||
(when (search-forward "#+startup: inlineimages" header-end t)
|
||
(kill-whole-line)))))
|
||
|
||
(defun oni-org-document-toggle-inline-images-startup ()
|
||
"Add or remove a line to the current org buffer that will make it load images inline."
|
||
(interactive)
|
||
(unless (derived-mode-p 'org-mode)
|
||
(error "Not currently in an org-mode buffer"))
|
||
(save-excursion
|
||
(goto-char (point-min))
|
||
(let ((header-end (or (search-forward "\n\n" nil t)
|
||
(point-max)))
|
||
(case-fold-search t))
|
||
(goto-char (point-min))
|
||
(if (search-forward "#+startup: inlineimages" header-end t)
|
||
(kill-whole-line)
|
||
(goto-char (1- header-end))
|
||
(insert "#+STARTUP: inlineimages\n")))))
|
||
|
||
(defun oni-org-expand-to-home (file-name)
|
||
"Expand FILE-NAME to the base directory for that system.
|
||
The base for all org files on Windows is u:/, but on my linux
|
||
installs it will always be ~."
|
||
(let ((base-dir "~"))
|
||
(expand-file-name file-name base-dir)))
|
||
|
||
(defun oni-org-set-yasnippet-condition ()
|
||
"Change the ‘yas-buffer-local-condition’ variable to work for org.
|
||
This condition requires that the key used for the snippet is
|
||
located at the start of the line."
|
||
(setq-local yas-buffer-local-condition
|
||
'(looking-back (rx line-start (one-or-more (not space))))))
|
||
|
||
(defun oni-org-setup-prettify-symbols-mode ()
|
||
"Set up prettify symbols mode for org mode."
|
||
(setq-local prettify-symbols-alist
|
||
'(("[ ]" . ?)
|
||
("[X]" . ?)
|
||
("#+TITLE: " . "")
|
||
("#+title: " . "")))
|
||
(prettify-symbols-mode))
|
||
|
||
(defun oni-org-snippets-initialize ()
|
||
"Initialize the snippets for ‘oni-org’."
|
||
(when (boundp 'yas-snippet-dirs)
|
||
(add-to-list 'yas-snippet-dirs oni-org-snippets-dir t))
|
||
(yas-load-directory oni-org-snippets-dir))
|
||
|
||
(defun oni-org-maybe-change-todo-state (current-state)
|
||
"Change the state of the current task to in-progress CURRENT-STATE is todo."
|
||
(if (and (not org-capture-mode)
|
||
(member current-state org-todo-heads))
|
||
(cadr (member current-state org-todo-keywords-1))
|
||
current-state))
|
||
|
||
;;;###autoload
|
||
(defun oni-org-open-index ()
|
||
"Open the index of my org-based personal wiki."
|
||
(interactive)
|
||
(find-file (oni-org-expand-to-home "documents/gtd/index.org")))
|
||
|
||
(defun oni-org-color-for (object)
|
||
"Generate a hex color by taking the first 6 characters of OBJECT’s MD5 sum."
|
||
(format "#%s" (substring (md5 object) 0 6)))
|
||
|
||
(defun oni-org-generate-todo-keyword-faces ()
|
||
"Create faces for all todo keywords in the current buffer."
|
||
(if-let ((keywords (cl-remove-if (lambda (tag) (assoc tag org-todo-keyword-faces))
|
||
org-todo-keywords-1)))
|
||
(append org-todo-keyword-faces
|
||
(mapcar (lambda (keyword) (cons keyword (oni-org-color-for keyword)))
|
||
keywords))
|
||
org-todo-keyword-faces))
|
||
|
||
(defun oni-org-generate-tag-faces ()
|
||
"Create faces for all the tags in the current buffer."
|
||
(if-let ((tags (cl-remove-if (lambda (tag) (assoc (car tag) org-tag-faces))
|
||
(org-get-buffer-tags))))
|
||
(append org-tag-faces
|
||
(mapcar (lambda (tag)
|
||
(let ((tag (car tag)))
|
||
(cons tag (oni-org-color-for tag))))
|
||
tags))
|
||
org-tag-faces))
|
||
|
||
(defun oni-org-set-todo-keyword-faces ()
|
||
"Set ‘org-todo-keyword-faces’ to all different colors."
|
||
(setq org-todo-keyword-faces (oni-org-generate-todo-keyword-faces)))
|
||
|
||
(defun oni-org-set-tag-faces ()
|
||
"Set ‘org-tag-faces’ to all different colors."
|
||
(setq org-tag-faces (oni-org-generate-tag-faces))
|
||
(org-set-tag-faces 'org-tag-faces org-tag-faces))
|
||
|
||
;;;###autoload(autoload 'oni-hydra-org/body "oni-org")
|
||
(defhydra oni-hydra-org (:color teal :hint nil)
|
||
"
|
||
^Tasks^ ^Buffer^ ^Capture^
|
||
^^^^^^------------------------------------------------------------------------
|
||
_a_: Show Agenda _b_: Switch to org buffer _t_: Note
|
||
_c_: Capture new heading _s_: Save all org buffers _A_: Appointment
|
||
_l_: Store link ^^ _j_: Journal entry
|
||
^^ ^Roam^^^
|
||
^^^^^^------------------------------------------------------------------------
|
||
_f_: Find note _i_: Insert note
|
||
^^ ^Document^^^
|
||
^^^^^^------------------------------------------------------------------------
|
||
_di_: Add inlineimages STARTUP
|
||
"
|
||
("l" org-store-link)
|
||
("a" org-agenda)
|
||
("c" org-capture)
|
||
("b" org-switchb)
|
||
("s" org-save-all-org-buffers)
|
||
("t" (org-capture nil "t"))
|
||
("A" (org-capture nil "a"))
|
||
("j" (org-capture nil "j"))
|
||
("f" org-roam-node-find)
|
||
("i" org-roam-node-insert)
|
||
("di" oni-org-document-add-inline-images-startup))
|
||
|
||
(defun oni-org-in-dblock-p ()
|
||
"Non-nil when point belongs to a dynamic block."
|
||
(save-match-data
|
||
(let ((case-fold-search t)
|
||
(lim-up (save-excursion (outline-previous-heading)))
|
||
(lim-down (save-excursion (outline-next-heading))))
|
||
(org-between-regexps-p
|
||
"^[ \t]*#\\+begin"
|
||
"^[ \t]*#\\+end"
|
||
lim-up lim-down))))
|
||
|
||
(defun oni-org-at-origin-property-p ()
|
||
"Non-nil when point is in an origin property."
|
||
(save-match-data
|
||
(save-excursion
|
||
(goto-char (line-beginning-position))
|
||
(and (looking-at org-property-re)
|
||
(string= (match-string 2) "ORIGIN")))))
|
||
|
||
(defun oni-org-dblock-write-backlinks (_params)
|
||
"Generate backlinks to org headings."
|
||
(let ((current-heading (nth 4 (org-heading-components)))
|
||
(current-heading-id (alist-get "CUSTOM_ID" (org-entry-properties) nil nil #'string=))
|
||
backlinks)
|
||
(save-excursion
|
||
(goto-char (point-min))
|
||
(while (re-search-forward (rx-to-string `(and "*" ,current-heading "]")) nil t)
|
||
(unless (or (oni-org-in-dblock-p)
|
||
(oni-org-at-origin-property-p))
|
||
(let ((components (org-heading-components)))
|
||
(push (cons (nth 2 components) (nth 4 components)) backlinks)))))
|
||
(when (not (null current-heading-id))
|
||
(save-excursion
|
||
(goto-char (point-min))
|
||
(while (re-search-forward (rx-to-string `(and "#" ,current-heading-id "]")) nil t)
|
||
(unless (or (oni-org-in-dblock-p)
|
||
(oni-org-at-origin-property-p))
|
||
(let ((components (org-heading-components)))
|
||
(push (cons (nth 2 components) (nth 4 components)) backlinks))))))
|
||
(insert (string-join
|
||
(mapcar (lambda (link)
|
||
(concat "- [[*" (cdr link) "][" (if (car link) (format "%s - " (car link)) "") (cdr link) "]]"))
|
||
(sort (seq-uniq backlinks (lambda (a b) (string= (cdr a) (cdr b))))
|
||
(lambda (a b) (string< (cdr a) (cdr b)))))
|
||
"\n"))))
|
||
|
||
(defun oni-org-wrap-region-in-block (block-name beginning end)
|
||
"Create a block BLOCK-NAME and wrap the text between BEGINNING and END in there."
|
||
(interactive "sName: \nr")
|
||
(save-excursion
|
||
(goto-char end)
|
||
(unless (looking-back (rx "\n") nil) (insert "\n"))
|
||
(insert "#+end_" block-name)
|
||
(unless (looking-at (rx "\n")) (insert "\n"))
|
||
(goto-char beginning)
|
||
(unless (looking-back (rx "\n") nil) (insert "\n"))
|
||
(insert "#+begin_" block-name)
|
||
(unless (looking-at (rx "\n")) (insert "\n"))))
|
||
|
||
(defalias 'org-dblock-write:oni-backlinks 'oni-org-dblock-write-backlinks)
|
||
|
||
(setq org-catch-invisible-edits 'error)
|
||
(setq org-clock-in-switch-to-state #'oni-org-maybe-change-todo-state)
|
||
(setq org-extend-today-until 2)
|
||
(setq org-fontify-whole-heading-line t)
|
||
(setq org-footnote-auto-adjust t)
|
||
(setq org-habit-graph-column 60)
|
||
(setq org-hide-emphasis-markers t)
|
||
(setq org-hide-macro-markers t)
|
||
(setq org-pretty-entities t)
|
||
(setq org-return-follows-link t)
|
||
(setq org-return-follows-link t)
|
||
(setq org-special-ctrl-a/e t)
|
||
(setq org-src-fontify-natively t)
|
||
(setq org-tags-column -72)
|
||
(setq org-tags-sort-function #'string<)
|
||
(setq org-tags-exclude-from-inheritance '("project"))
|
||
(setq org-use-fast-todo-selection t)
|
||
(setq org-use-sub-superscripts '{})
|
||
|
||
;; Generally, for state updates and such, I like to have all of the notes added
|
||
;; into the logbook, but when I want to add a note manually I definitely want it
|
||
;; to show up easily seen in the buffer.
|
||
(setq org-log-into-drawer t)
|
||
|
||
(defun oni-org-logging-outside-drawer (func &rest args)
|
||
"Call FUNC with ARGS.
|
||
Set ‘org-log-into-drawer’ to nil if we’re trying to take a note,
|
||
and not a state update."
|
||
(let ((org-log-into-drawer (not (eql org-log-note-purpose 'note))))
|
||
(apply func args)))
|
||
|
||
(add-function :around (symbol-function 'org-store-log-note)
|
||
#'oni-org-logging-outside-drawer)
|
||
|
||
;; Set the maximum indentation level for description lists to 5 (which is the
|
||
;; seemingly hardcoded value of the indentation it gets when it goes over
|
||
;; ‘org-list-description-max-indent’) so that I don’t get dangling descriptions
|
||
;; when my term is 19 characters long.
|
||
(setq org-list-description-max-indent 5)
|
||
|
||
(setq org-default-notes-file (expand-file-name "inbox.org" oni-org-todo-dir))
|
||
(setq org-bibtex-autogen-keys t)
|
||
|
||
(defun oni-org-find-heading-in-file (heading file &optional move)
|
||
"Try to find HEADING somewhere in FILE.
|
||
This function returns nil if HEADING couldn’t be found, and the
|
||
position where the chapter starts otherwise. If MOVE is non-nil
|
||
also move point to the start of the heading."
|
||
(let ((buffer (find-file-noselect file)))
|
||
(with-current-buffer buffer
|
||
(save-excursion
|
||
(goto-char (point-min))
|
||
(org-find-exact-headline-in-buffer heading buffer (not move))))))
|
||
|
||
(defun oni-org-create-book-heading (book-title file)
|
||
"Create a new heading for BOOK-TITLE in FILE."
|
||
(let ((buffer (find-file file)))
|
||
(with-current-buffer buffer
|
||
(goto-char (point-max))
|
||
(insert "\n* " book-title "\n\n "))))
|
||
|
||
(defun oni-org-create-chapter-heading (book-title chapter-title file)
|
||
"Create a new heading under BOOK-TITLE for CHAPTER-TITLE in FILE."
|
||
(let ((buffer (find-file file)))
|
||
(with-current-buffer buffer
|
||
(goto-char (point-min))
|
||
(goto-char (oni-org-find-heading-in-file book-title file t))
|
||
(goto-char (org-element-property :end (org-element-at-point)))
|
||
(unless (= (point) (point-max))
|
||
(open-line 2))
|
||
(insert "\n** " chapter-title "\n\n "))))
|
||
|
||
(defun oni-org-create-chapter-section (chapter-title file)
|
||
"Create a new notes section under CHAPTER-TITLE in FILE."
|
||
(let ((buffer (find-file file)))
|
||
(with-current-buffer buffer
|
||
(goto-char (point-min))
|
||
(goto-char (oni-org-find-heading-in-file chapter-title file t))
|
||
(goto-char (org-element-property :contents-end (org-element-at-point)))
|
||
(insert "\n"))))
|
||
|
||
(defun oni-org-reading-note ()
|
||
"Find the org-header associated with the current chapter or page."
|
||
(let* ((headers (split-string (format-mode-line header-line-format) ":" t " "))
|
||
(book-name (car headers))
|
||
(chapter-name (cadr headers))
|
||
(notes-file (oni-org-expand-to-home "documents/gtd/reading-notes.org"))
|
||
(chapter-start (oni-org-find-heading-in-file chapter-name notes-file)))
|
||
(if (not chapter-start)
|
||
(let ((book-start (oni-org-find-heading-in-file book-name notes-file)))
|
||
(unless book-start
|
||
(oni-org-create-book-heading book-name notes-file))
|
||
(oni-org-create-chapter-heading book-name chapter-name notes-file))
|
||
(oni-org-create-chapter-section chapter-name notes-file))))
|
||
|
||
(defun oni-org-todo-maybe-hide-body ()
|
||
"Hide the current outline body if ‘org-state’ is a DONE state."
|
||
(when (member org-state org-done-keywords)
|
||
(outline-hide-body)))
|
||
|
||
(setq org-todo-keywords
|
||
'((sequence "TODO(t)" "WIP" "BLOCKED(b@)" "|" "DONE(d!)")
|
||
(sequence "READ(r)" "READING(!)" "|" "FINISHED(!)" "STOPPED(@)")
|
||
(sequence "WATCH(w)" "WATCHING" "|" "WATCHED(!)")
|
||
(sequence "LISTEN(l)" "LISTENING" "|" "DONE(d!)")
|
||
(sequence "|" "CANCELLED(c@)")))
|
||
|
||
(add-hook 'org-after-todo-state-change-hook 'oni-org-todo-maybe-hide-body)
|
||
|
||
(setf (alist-get 'file org-link-frame-setup) 'find-file)
|
||
|
||
(add-to-list 'org-modules 'org-habit)
|
||
(add-to-list 'org-modules 'org-tempo)
|
||
|
||
(add-to-list 'org-babel-load-languages '(java . t))
|
||
|
||
(add-hook 'org-mode-hook #'oni-org-set-tag-faces)
|
||
(add-hook 'org-mode-hook #'oni-org-set-todo-keyword-faces)
|
||
(add-hook 'org-mode-hook #'oni-org-set-yasnippet-condition)
|
||
(add-hook 'org-mode-hook 'electric-pair-local-mode)
|
||
(add-hook 'org-mode-hook 'electric-quote-local-mode)
|
||
(add-hook 'org-mode-hook 'flyspell-mode)
|
||
(add-hook 'org-mode-hook 'mixed-pitch-mode)
|
||
(add-hook 'org-mode-hook 'olivetti-mode)
|
||
(add-hook 'org-mode-hook 'org-indent-mode)
|
||
(add-hook 'org-mode-hook 'visual-line-mode)
|
||
|
||
(org-edna-mode)
|
||
|
||
(unless (eq system-type 'windows-nt)
|
||
(require 'org-bullets)
|
||
(add-hook 'org-mode-hook 'org-bullets-mode)
|
||
(add-hook 'org-mode-hook #'oni-org-setup-prettify-symbols-mode))
|
||
|
||
;;;###autoload
|
||
(global-set-key (kbd "C-c o") 'oni-hydra-org/body)
|
||
|
||
;;;###autoload
|
||
(global-set-key (kbd "C-<home>") #'oni-org-open-index)
|
||
|
||
(with-eval-after-load 'org
|
||
(with-eval-after-load 'yasnippet
|
||
(oni-org-snippets-initialize)))
|
||
|
||
(with-eval-after-load 'org-edna (diminish 'org-edna-mode))
|
||
|
||
|
||
;;;; Agenda
|
||
|
||
(defun oni-org-agenda-window-p (_target _action)
|
||
"Check if the current buffer is the agenda buffer."
|
||
(string= (buffer-name) org-agenda-buffer-name))
|
||
|
||
(defun oni-org-initialize-agenda-category-icons ()
|
||
"Set ‘org-agenda-category-icon-alist’ if it hasn’t already been set."
|
||
(when (and (display-graphic-p)
|
||
(null org-agenda-category-icon-alist))
|
||
(oni-org-set-agenda-category-icons)))
|
||
|
||
(defun oni-org-set-agenda-category-icons ()
|
||
"Set ‘org-agenda-category-icon-alist’."
|
||
(let* ((icon-height (window-default-font-height))
|
||
(defaults `(nil :height ,icon-height :ascent center))
|
||
(svg `(svg ,@defaults)))
|
||
(setq org-agenda-category-icon-alist
|
||
`((,(rx string-start "task" string-end) ,(expand-file-name "bx-task.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "inbox" string-end) ,(expand-file-name "bxs-inbox.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "email" string-end) ,(expand-file-name "mat-email.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "life" string-end) ,(expand-file-name "mat-one-up.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "feature" string-end) ,(expand-file-name "mat-star-circle-outline.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "work" string-end) ,(expand-file-name "bs-building.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "game" string-end) ,(expand-file-name "bxs-game.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "shopping" string-end) ,(expand-file-name "bx-shopping-bag.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "bug" string-end) ,(expand-file-name "bx-bug.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "idea" string-end) ,(expand-file-name "bxs-bulb.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "article" string-end) ,(expand-file-name "mat-post-outline.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "project" string-end) ,(expand-file-name "bs-kanban.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "ebook" string-end) ,(expand-file-name "bxs-book-content.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "book" string-end) ,(expand-file-name "mat-book-open-variant.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "Morning Cup of Coding" string-end) ,(expand-file-name "bxs-coffee.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "paper" string-end) ,(expand-file-name "mat-note-text-outline.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "question" string-end) ,(expand-file-name "mat-head-question.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "music" string-end) ,(expand-file-name "bxs-music.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "emacs" string-end) ,(expand-file-name "emacs.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "moving" string-end) ,(expand-file-name "bxs-truck.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "security" string-end) ,(expand-file-name "mat-security.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "website" string-end) ,(expand-file-name "mat-web.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "desktop" string-end) ,(expand-file-name "bx-desktop.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "maint" string-end) ,(expand-file-name "bs-tools.svg" oni-org-icons-dir) ,@svg)
|
||
(,(rx string-start "comm" string-end) ,(expand-file-name "bs-telephone-fill.svg" oni-org-icons-dir) ,@svg)))))
|
||
|
||
(setq org-agenda-files
|
||
(cons oni-org-todo-main-file
|
||
(mapcar (lambda (file) (expand-file-name file oni-org-exocortex-directory))
|
||
(split-string
|
||
(let ((default-directory oni-org-exocortex-directory))
|
||
(shell-command-to-string "grep -E -l \"^\\\\*+ (TODO|WIP|BLOCKED|DONE|READ|READING|FINISHED|STOPPED|WATCH|WATCHING|WATCHED|LISTEN|LISTENING|CANCELLED)\" *.org"))
|
||
"\n" t))))
|
||
(setq org-agenda-tags-todo-honor-ignore-options t)
|
||
(setq org-agenda-todo-ignore-scheduled 'future)
|
||
(setq org-agenda-restore-windows-after-quit t)
|
||
(setq org-agenda-start-with-log-mode t)
|
||
(setq org-agenda-window-setup 'only-window)
|
||
|
||
(setq org-agenda-custom-commands
|
||
'(("i"
|
||
"Inbox: The giant list of things that I haven’t sorted through yet."
|
||
todo ""
|
||
((org-agenda-files (list org-default-notes-file))
|
||
(org-agenda-cmp-user-defined (lambda (_ _) -1))
|
||
(org-agenda-sorting-strategy '(user-defined-up))))
|
||
("t" "Todo" tags-todo "TODO=\"TODO\"-CATEGORY=\"inbox\"+SCHEDULED=\"\""
|
||
((org-overriding-columns-format "%TODO %46ITEM %1BLOCKED %Effort")))
|
||
("r" "Reading list" tags-todo "TODO=\"READ\"+SCHEDULED=\"\"-Effort=\"\""
|
||
((org-overriding-columns-format "%8CATEGORY %ITEM %3EFFORT")
|
||
(org-agenda-sorting-strategy '(priority-down effort-up))
|
||
(org-agenda-prefix-format " (%3e) %i %-12:c")))
|
||
("R" "Reading list (requires estimating)" tags-todo "TODO=\"READ\"+Effort=\"\"")
|
||
("s" "Someday" tags-todo "TODO=\"TODO\"-CATEGORY=\"inbox\"")
|
||
("p" "Projects & ideas" tags "CATEGORY=\"project\"|CATEGORY=\"idea\"")
|
||
("c" "Today's (Current) tasks" tags "SCHEDULED=\"<today>\"")
|
||
("w" . "Work topics")
|
||
("wo" "Overview" ((tags-todo "+work+FOR=\"\"")
|
||
(tags-todo "+work+FOR=\"Jordan\"")
|
||
(tags-todo "+work+FOR=\"Remy\"")))
|
||
("wt" "Work todo" tags-todo "+work+FOR=\"\"")
|
||
("wj" "Topics for Jordan" tags-todo "+work+1o1+FOR=\"Jordan\"")
|
||
("wr" "Topics for Remy" tags-todo "+work+1o1+FOR=\"Remy\"")
|
||
("S" "Shopping" tags-todo "+shopping")))
|
||
|
||
(add-hook 'org-mode-hook #'oni-org-initialize-agenda-category-icons)
|
||
|
||
(add-to-list 'display-buffer-alist
|
||
'(oni-org-agenda-window-p
|
||
display-buffer-in-previous-window
|
||
(inhibit-same-window . t)))
|
||
|
||
;;;; Capture
|
||
|
||
(require 'org-capture)
|
||
|
||
(defconst oni-org-capture-template-directory
|
||
(expand-file-name "capture-templates" oni-org-root)
|
||
"Directory where the template files for ‘org-capture’ are located.")
|
||
|
||
(defun oni-org-delete-frame-once ()
|
||
"Run `delete-frame'.
|
||
|
||
After running it once remove it from `org-capture-after-finalize-hook'."
|
||
(delete-frame)
|
||
(remove-hook 'org-capture-after-finalize-hook 'oni-org-delete-frame-once))
|
||
|
||
(defun oni-org-run-capture-in-dedicated-frame ()
|
||
"Run `org-capture' in a dedicated frame."
|
||
(interactive)
|
||
(with-selected-frame (make-frame '((minibuffer . nil)
|
||
(name . "emacs-org-capture")
|
||
(width . 80)
|
||
(height . 24)))
|
||
(org-capture nil "t")
|
||
(delete-other-windows)
|
||
(setf (frame-width) 80)
|
||
(setf (frame-height) 24)
|
||
(add-hook 'org-capture-after-finalize-hook 'oni-org-delete-frame-once)))
|
||
|
||
(defun oni-org-get-url-title (url)
|
||
"Load URL and parse out the title."
|
||
(with-current-buffer
|
||
(url-retrieve-synchronously url)
|
||
(unwind-protect
|
||
(when (re-search-forward (rx "<title" (zero-or-more (not ">")) ">") nil t)
|
||
(let ((title-start (point)))
|
||
(when (re-search-forward (rx "</title>") nil t)
|
||
(string-trim (buffer-substring title-start (- (point) 8))))))
|
||
(kill-buffer))))
|
||
|
||
(defun oni-org-get-url-link (url)
|
||
"Turn URL into an org link."
|
||
(let ((title (oni-org-get-url-title url)))
|
||
(format "[[%s][%s]]" url title)))
|
||
|
||
(defun oni-org-format-months ()
|
||
(let* ((time (org-timestamp-to-time
|
||
(org-timestamp-from-string (concat "<" (org-read-date) ">"))))
|
||
(decoded (decode-time time))
|
||
(next-month
|
||
(time-add time (days-to-time (date-days-in-month
|
||
(decoded-time-year decoded)
|
||
(decoded-time-month decoded))))))
|
||
(concat (format-time-string "%b " time)
|
||
(format-time-string "%b " next-month)
|
||
(format-time-string "%Y" time))))
|
||
|
||
(defun oni-org-ask-names ()
|
||
(let ((n 1)
|
||
article-name
|
||
names)
|
||
(while (not (string-empty-p (setq article-name (read-string (format "Article Name %d: " n)))))
|
||
(push article-name names)
|
||
(cl-incf n))
|
||
(reverse names)))
|
||
|
||
(defun oni-org-format-names (names)
|
||
(mapconcat (lambda (n) (format "** READ %s" n)) names "\n"))
|
||
|
||
(setq org-capture-templates
|
||
`(("t" "Task" entry (file "")
|
||
(file ,(expand-file-name "task.org" oni-org-capture-template-directory)))
|
||
("u" "URL to read" entry (file "")
|
||
(file ,(expand-file-name "reading-url.org" oni-org-capture-template-directory))
|
||
:immediate-finish t)
|
||
("U" "URL to read" entry (file "")
|
||
(file ,(expand-file-name "reading-url-protocol.org" oni-org-capture-template-directory))
|
||
:immediate-finish t)
|
||
("j" "Journal entry" entry
|
||
(file+olp+datetree ,(oni-org-expand-to-home "documents/gtd/journal.org"))
|
||
(file ,(expand-file-name "journal.org" oni-org-capture-template-directory)))
|
||
("n" "Reading note" item (function oni-org-reading-note)
|
||
(file ,(expand-file-name "reading-note.org" oni-org-capture-template-directory))
|
||
:empty-lines 1)
|
||
("A" "Album" entry (file "")
|
||
"* %^{Artist} - %^{Album Name}
|
||
:PROPERTIES:
|
||
:CATEGORY: music
|
||
:END:
|
||
** TODO Listen to %\\1 - %\\2
|
||
** TODO Rip %\\1 - %\\2 to disk
|
||
** TODO Add album art to %\\1 - %\\2
|
||
** TODO Transfer %\\1 - %\\2 to phone"
|
||
:immediate-finish t)
|
||
("m" "Code Magazine Issue" entry (file "")
|
||
"* CODE Issue %(oni-org-format-months)
|
||
** READ Editorial
|
||
%(oni-org-format-names (oni-org-ask-names))"
|
||
:immediate-finish t)
|
||
("c" "Add to currently clocked item")
|
||
("ca" "Note" plain
|
||
(clock)
|
||
(file ,(expand-file-name "clocked/note.org" oni-org-capture-template-directory))
|
||
:empty-lines 1)
|
||
("ci" "Item to current clocked task" item
|
||
(clock)
|
||
(file ,(expand-file-name "clocked/item.org" oni-org-capture-template-directory))
|
||
:empty-lines 1)
|
||
("cc" "Marked code example with notes" plain
|
||
(clock)
|
||
(file ,(expand-file-name "clocked/code-note.org" oni-org-capture-template-directory))
|
||
:empty-lines 1)
|
||
("cC" "Marked code example" plain
|
||
(clock)
|
||
(file ,(expand-file-name "clocked/code.org" oni-org-capture-template-directory))
|
||
:immediate-finish t
|
||
:empty-lines 1)
|
||
("ck" "Kill-ring contents" plain
|
||
(clock)
|
||
(file ,(expand-file-name "clocked/kill-ring.org" oni-org-capture-template-directory))
|
||
:immediate-finish t
|
||
:empty-lines 1)))
|
||
|
||
(setq org-capture-templates-contexts
|
||
'(("n" ((in-mode . "nov-mode")))))
|
||
|
||
(defun org-edna-finder/next-sibling-first-child ()
|
||
"A finder for ‘org-edna’ to find the first child of the next sibling."
|
||
(save-excursion
|
||
(org-back-to-heading t)
|
||
(org-goto-sibling)
|
||
(org-goto-first-child)
|
||
(list (point-marker))))
|
||
|
||
;;; Refile
|
||
|
||
;; Set it up so that I can refile easily and still create new nodes when I
|
||
;; refile. Include the file in the outline path so that I can refile into them
|
||
;; and create top-level headings.
|
||
(setq org-refile-use-outline-path 'file
|
||
org-outline-path-complete-in-steps nil
|
||
org-refile-allow-creating-parent-nodes 'confirm
|
||
org-log-refile 'time)
|
||
|
||
;; Refiling can go to any heading in the current file, any heading in
|
||
;; ‘oni-org-todo-main-file', and the top of ‘oni-org-todo-someday-file'.
|
||
(setq org-refile-targets '((nil . (:maxlevel . 10))
|
||
(oni-org-todo-main-file . (:maxlevel . 10))
|
||
(oni-org-todo-someday-file . (:maxlevel . 1))))
|
||
|
||
;;; Export
|
||
(require 'ox-html)
|
||
(require 'nxml-mode)
|
||
|
||
;; From https://emacs.stackexchange.com/a/57433
|
||
(defcustom oni-org-html-embed-svg nil
|
||
"Embed SVG images.
|
||
You can set this variable in Org files with
|
||
#+HTML_EMBED_SVG: t
|
||
or
|
||
#+OPTIONS: html-embed-svg:t"
|
||
:type 'boolean
|
||
:group 'org-export-html)
|
||
|
||
(cl-pushnew
|
||
'(:html-embed-svg "HTML_EMBED_SVG" "html-embed-svg" oni-org-html-embed-svg)
|
||
(org-export-backend-options (org-export-get-backend 'html)))
|
||
|
||
(defun oni-org-html-svg-image-embed (fun source attributes info)
|
||
"Make embedding of SVG images possible in org HTML export.
|
||
SVG images are embedded if :html-embed-svg is non-nil in the plist INFO.
|
||
Otherwise FUN called with SOURCE, ATTRIBUTES, and INFO as arguments.
|
||
SOURCE is the file name of the SVG file.
|
||
This is an around advice for ‘org-html--svg-image’ as FUN."
|
||
(if (member (plist-get info :html-embed-svg) '("yes" "t" t))
|
||
(with-temp-buffer
|
||
(insert-file-contents source)
|
||
(with-syntax-table nxml-mode-syntax-table
|
||
(while (and (search-forward "<svg" nil t)
|
||
(nth 8 (syntax-ppss))))
|
||
(delete-region (point-min) (match-beginning 0))
|
||
(buffer-string)))
|
||
(funcall fun source attributes info)))
|
||
|
||
(advice-add 'org-html--svg-image :around #'oni-org-html-svg-image-embed)
|
||
|
||
;;; Pomodoro
|
||
|
||
;; Add my current pomodoro time duration so that I can make estimates in
|
||
;; Pomodoros like 1p.
|
||
(defconst oni-org-pomodoro-duration 25
|
||
"The duration in minutes of a single pomodoro.")
|
||
|
||
(with-eval-after-load 'org-duration
|
||
(add-to-list 'org-duration-units `("p" . ,oni-org-pomodoro-duration))
|
||
(org-duration-set-regexps))
|
||
|
||
(provide 'oni-org)
|
||
;;; oni-org.el ends here
|