mirror of
https://github.com/org-roam/org-roam
synced 2025-08-01 12:17:21 -05:00
578 lines
25 KiB
EmacsLisp
578 lines
25 KiB
EmacsLisp
;;; org-roam-capture.el --- Capture functionality -*- coding: utf-8; lexical-binding: t; -*-
|
||
|
||
;; Copyright © 2020 Jethro Kuan <jethrokuan95@gmail.com>
|
||
|
||
;; Author: Jethro Kuan <jethrokuan95@gmail.com>
|
||
;; URL: https://github.com/org-roam/org-roam
|
||
;; Keywords: org-mode, roam, convenience
|
||
;; Version: 2.0.0
|
||
;; Package-Requires: ((emacs "26.1") (dash "2.13") (f "0.17.2") (s "1.12.0") (org "9.4") (emacsql "3.0.0") (emacsql-sqlite3 "1.0.2") (magit-section "2.90.1"))
|
||
|
||
;; This file is NOT part of GNU Emacs.
|
||
|
||
;; 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, 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 GNU Emacs; see the file COPYING. If not, write to the
|
||
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
||
;; Boston, MA 02110-1301, USA.
|
||
|
||
;;; Commentary:
|
||
;;
|
||
;; This library provides capture functionality for org-roam
|
||
;;; Code:
|
||
;;;; Library Requires
|
||
(require 'org-capture)
|
||
(eval-when-compile
|
||
(require 'org-roam-macs))
|
||
(require 'org-roam-db)
|
||
(require 'org-roam-structs)
|
||
(require 'dash)
|
||
(require 's)
|
||
(require 'cl-lib)
|
||
|
||
;; Declarations
|
||
(defvar org-roam-encrypt-files)
|
||
(defvar org-roam-directory)
|
||
(defvar org-roam-title-to-slug-function)
|
||
(defvar org-roam-file-extensions)
|
||
|
||
(defvar org-roam-capture--file-path nil
|
||
"The file path for the Org-roam capture.
|
||
This variable is set during the Org-roam capture process.")
|
||
|
||
(defvar org-roam-capture--info nil
|
||
"An alist of additional information passed to the Org-roam template.
|
||
This variable is populated dynamically, and is only non-nil
|
||
during the Org-roam capture process.")
|
||
|
||
(defvar org-roam-capture--context nil
|
||
"A symbol, that reflects the context for obtaining the exact point in a file.
|
||
This variable is populated dynamically, and is only active during
|
||
an Org-roam capture process.
|
||
|
||
The `title' context is used in `org-roam-insert' and
|
||
`org-roam-find-file', where the capture process is triggered upon
|
||
trying to create a new file without that `title'.
|
||
|
||
The `ref' context is used by `org-roam-protocol', where the
|
||
capture process is triggered upon trying to find or create a new
|
||
note with the given `ref'.")
|
||
|
||
(defvar org-roam-capture-additional-template-props nil
|
||
"Additional props to be added to the Org-roam template.")
|
||
|
||
(defconst org-roam-capture--template-keywords '(:file-name :head :olp)
|
||
"Keywords used in `org-roam-capture-templates' specific to Org-roam.")
|
||
|
||
(defcustom org-roam-capture-templates
|
||
`(("d" "default" plain (function org-roam-capture--get-point)
|
||
"%?"
|
||
:file-name "%<%Y%m%d%H%M%S>-${slug}"
|
||
:head "#+title: ${title}\n"
|
||
:unnarrowed t))
|
||
"Capture templates for Org-roam.
|
||
The Org-roam capture-templates builds on the default behaviours of
|
||
`org-capture-templates' by expanding them in 3 areas:
|
||
|
||
1. Template-expansion capabilities are extended with additional
|
||
custom syntax. See `org-roam-capture--fill-template' for more
|
||
details.
|
||
|
||
2. The `:file-name' key is added, which defines the naming format
|
||
to use when creating new notes. This file-name is relative to
|
||
`org-roam-directory', and is without the file-extension.
|
||
|
||
3. The `:head' key is added, which contains the template that is
|
||
inserted upon the creation of a new file. This is where you
|
||
your note metadata should go.
|
||
|
||
Each template should have the following structure:
|
||
|
||
\(KEY DESCRIPTION `plain' `(function org-roam-capture--get-point)'
|
||
TEMPLATE
|
||
`:file-name' FILENAME-FORMAT
|
||
`:head' HEADER-FORMAT
|
||
`:unnarrowed t'
|
||
OPTIONS-PLIST)
|
||
|
||
The elements of a template-entry and their placement are the same
|
||
as in `org-capture-templates', except that the entry type must
|
||
always be the symbol `plain', and that the target must always be
|
||
the list `(function org-roam-capture--get-point)'.
|
||
|
||
Org-roam requires the plist elements `:file-name' and `:head' to
|
||
be present, and it’s recommended that `:unnarrowed' be set to t."
|
||
:group 'org-roam
|
||
;; Adapted from `org-capture-templates'
|
||
:type
|
||
'(repeat
|
||
(choice :value ("d" "default" plain (function org-roam-capture--get-point)
|
||
"%?"
|
||
:file-name "%<%Y%m%d%H%M%S>-${slug}"
|
||
:head "#+title: ${title}\n"
|
||
:unnarrowed t)
|
||
(list :tag "Multikey description"
|
||
(string :tag "Keys ")
|
||
(string :tag "Description"))
|
||
(list :tag "Template entry"
|
||
(string :tag "Keys ")
|
||
(string :tag "Description ")
|
||
(const :format "" plain)
|
||
(const :format "" (function org-roam-capture--get-point))
|
||
(choice :tag "Template "
|
||
(string :tag "String"
|
||
:format "String:\n \
|
||
Template string :\n%v")
|
||
(list :tag "File"
|
||
(const :format "" file)
|
||
(file :tag "Template file "))
|
||
(list :tag "Function"
|
||
(const :format "" function)
|
||
(function :tag "Template function ")))
|
||
(const :format "File name format :" :file-name)
|
||
(string :format " %v" :value "#+title: ${title}\n")
|
||
(const :format "Header format :" :head)
|
||
(string :format "\n%v" :value "%<%Y%m%d%H%M%S>-${slug}")
|
||
(const :format "" :unnarrowed) (const :format "" t)
|
||
(plist :inline t
|
||
:tag "Options"
|
||
;; Give the most common options as checkboxes
|
||
:options
|
||
(((const :format "%v " :prepend) (const t))
|
||
((const :format "%v " :immediate-finish) (const t))
|
||
((const :format "%v " :jump-to-captured) (const t))
|
||
((const :format "%v " :empty-lines) (const 1))
|
||
((const :format "%v " :empty-lines-before) (const 1))
|
||
((const :format "%v " :empty-lines-after) (const 1))
|
||
((const :format "%v " :clock-in) (const t))
|
||
((const :format "%v " :clock-keep) (const t))
|
||
((const :format "%v " :clock-resume) (const t))
|
||
((const :format "%v " :time-prompt) (const t))
|
||
((const :format "%v " :tree-type) (const week))
|
||
((const :format "%v " :table-line-pos) (string))
|
||
((const :format "%v " :kill-buffer) (const t))))))))
|
||
|
||
(defcustom org-roam-capture-ref-templates
|
||
'(("r" "ref" plain #'org-roam-capture--get-point
|
||
"%?"
|
||
:file-name "${slug}"
|
||
:head "#+title: ${title}\n#+roam_key: ${ref}"
|
||
:unnarrowed t))
|
||
"The Org-roam templates used during a capture from the roam-ref protocol.
|
||
Details on how to specify for the template is given in `org-roam-capture-templates'."
|
||
:group 'org-roam
|
||
;; Adapted from `org-capture-templates'
|
||
:type
|
||
'(repeat
|
||
(choice :value ("d" "default" plain (function org-roam-capture--get-point)
|
||
"%?"
|
||
:file-name "${slug}"
|
||
:head "#+title: ${title}\n#+roam_key: ${ref}\n"
|
||
:unnarrowed t)
|
||
(list :tag "Multikey description"
|
||
(string :tag "Keys ")
|
||
(string :tag "Description"))
|
||
(list :tag "Template entry"
|
||
(string :tag "Keys ")
|
||
(string :tag "Description ")
|
||
(const :format "" plain)
|
||
(const :format "" (function org-roam-capture--get-point))
|
||
(choice :tag "Template "
|
||
(string :tag "String"
|
||
:format "String:\n \
|
||
Template string :\n%v")
|
||
(list :tag "File"
|
||
(const :format "" file)
|
||
(file :tag "Template file "))
|
||
(list :tag "Function"
|
||
(const :format "" function)
|
||
(function :tag "Template function ")))
|
||
(const :format "File name format :" :file-name)
|
||
(string :format " %v" :value "#+title: ${title}\n")
|
||
(const :format "Header format :" :head)
|
||
(string :format "\n%v" :value "%<%Y%m%d%H%M%S>-${slug}")
|
||
(const :format "" :unnarrowed) (const :format "" t)
|
||
(plist :inline t
|
||
:tag "Options"
|
||
;; Give the most common options as checkboxes
|
||
:options
|
||
(((const :format "%v " :prepend) (const t))
|
||
((const :format "%v " :immediate-finish) (const t))
|
||
((const :format "%v " :jump-to-captured) (const t))
|
||
((const :format "%v " :empty-lines) (const 1))
|
||
((const :format "%v " :empty-lines-before) (const 1))
|
||
((const :format "%v " :empty-lines-after) (const 1))
|
||
((const :format "%v " :clock-in) (const t))
|
||
((const :format "%v " :clock-keep) (const t))
|
||
((const :format "%v " :clock-resume) (const t))
|
||
((const :format "%v " :time-prompt) (const t))
|
||
((const :format "%v " :tree-type) (const week))
|
||
((const :format "%v " :table-line-pos) (string))
|
||
((const :format "%v " :kill-buffer) (const t))))))))
|
||
|
||
(defun org-roam-capture-p ()
|
||
"Return t if the current capture process is an Org-roam capture.
|
||
This function is to only be called when org-capture-plist is
|
||
valid for the capture (i.e. initialization, and finalization of
|
||
the capture)."
|
||
(plist-get org-capture-plist :org-roam))
|
||
|
||
(defun org-roam-capture--get (keyword)
|
||
"Get the value for KEYWORD from the `org-roam-capture-template'."
|
||
(plist-get (plist-get org-capture-plist :org-roam) keyword))
|
||
|
||
(defun org-roam-capture--put (&rest stuff)
|
||
"Put properties from STUFF into the `org-roam-capture-template'."
|
||
(let ((p (plist-get org-capture-plist :org-roam)))
|
||
(while stuff
|
||
(setq p (plist-put p (pop stuff) (pop stuff))))
|
||
(setq org-capture-plist
|
||
(plist-put org-capture-plist :org-roam p))))
|
||
|
||
;; FIXME: Pending upstream patch
|
||
;; https://orgmode.org/list/87h7tv9pkm.fsf@hidden/T/#u
|
||
;;
|
||
;; Org-capture's behaviour right now is that `org-capture-plist' is valid only
|
||
;; during the initialization of the Org-capture buffer. The value of
|
||
;; `org-capture-plist' is saved into buffer-local `org-capture-current-plist'.
|
||
;; However, the value for that particular capture is no longer accessible for
|
||
;; hooks in `org-capture-after-finalize-hook', since the capture buffer has been
|
||
;; cleaned up.
|
||
;;
|
||
;; This advice restores the global `org-capture-plist' during finalization, so
|
||
;; the plist is valid during both initialization and finalization of the
|
||
;; capture.
|
||
(defun org-roam-capture--update-plist (&optional _)
|
||
"Update global plist from local var."
|
||
(setq org-capture-plist org-capture-current-plist))
|
||
|
||
(advice-add 'org-capture-finalize :before #'org-roam-capture--update-plist)
|
||
|
||
(defun org-roam-capture--finalize ()
|
||
"Finalize the `org-roam-capture' process."
|
||
(let* ((finalize (org-roam-capture--get :finalize))
|
||
;; In case any regions were shielded before, unshield them
|
||
(region (when-let ((region (org-roam-capture--get :region)))
|
||
(org-roam-unshield-region (car region) (cdr region))))
|
||
(beg (car region))
|
||
(end (cdr region)))
|
||
(unless org-note-abort
|
||
(pcase finalize
|
||
('find-file
|
||
(when-let ((file-path (org-roam-capture--get :file-path)))
|
||
(find-file file-path)
|
||
(run-hooks 'org-roam-capture-after-find-file-hook)))
|
||
('insert-link
|
||
(when-let* ((mkr (org-roam-capture--get :insert-at))
|
||
(buf (marker-buffer mkr)))
|
||
(with-current-buffer buf
|
||
(when region
|
||
(delete-region (car region) (cdr region)))
|
||
(let ((path (org-roam-capture--get :file-path))
|
||
(type (org-roam-capture--get :link-type))
|
||
(desc (org-roam-capture--get :link-description)))
|
||
(if (eq (point) (marker-position mkr))
|
||
(insert (org-roam-format-link path desc type))
|
||
(org-with-point-at mkr
|
||
(insert (org-roam-format-link path desc type))))))))))
|
||
(when region
|
||
(set-marker beg nil)
|
||
(set-marker end nil))
|
||
(org-roam-capture--save-file-maybe)
|
||
(remove-hook 'org-capture-after-finalize-hook #'org-roam-capture--finalize)))
|
||
|
||
(defun org-roam-capture--install-finalize ()
|
||
"Install `org-roam-capture--finalize' if the capture is an Org-roam capture."
|
||
(when (org-roam-capture-p)
|
||
(add-hook 'org-capture-after-finalize-hook #'org-roam-capture--finalize)))
|
||
|
||
(add-hook 'org-capture-prepare-finalize-hook #'org-roam-capture--install-finalize)
|
||
|
||
(defun org-roam-capture--fill-template (str)
|
||
"Expand the template STR, returning the string.
|
||
This is an extension of org-capture's template expansion.
|
||
|
||
First, it expands ${var} occurrences in STR, using `org-roam-capture--info'.
|
||
If there is a ${var} with no matching var in the alist, the value
|
||
of var is prompted for via `completing-read'.
|
||
|
||
Next, it expands the remaining template string using
|
||
`org-capture-fill-template'."
|
||
(-> str
|
||
(s-format (lambda (key)
|
||
(or (s--aget org-roam-capture--info key)
|
||
(when-let ((val (completing-read (format "%s: " key) nil)))
|
||
(push (cons key val) org-roam-capture--info)
|
||
val))) nil)
|
||
(org-capture-fill-template)))
|
||
|
||
(defun org-roam-capture--save-file-maybe ()
|
||
"Save the file conditionally.
|
||
The file is saved if the original value of :no-save is not t and
|
||
`org-note-abort' is not t. It is added to
|
||
`org-capture-after-finalize-hook'."
|
||
(cond
|
||
((and (org-roam-capture--get :new-file)
|
||
org-note-abort)
|
||
(with-current-buffer (org-capture-get :buffer)
|
||
(set-buffer-modified-p nil)
|
||
(kill-buffer)))
|
||
((and (not (org-roam-capture--get :orig-no-save))
|
||
(not org-note-abort))
|
||
(with-current-buffer (org-capture-get :buffer)
|
||
(save-buffer)))))
|
||
|
||
(defun org-roam-capture--get-file-path (basename)
|
||
"Return path for Org-roam file with BASENAME."
|
||
(let* ((ext (or (car org-roam-file-extensions)
|
||
"org"))
|
||
(file (concat basename "." ext)))
|
||
(expand-file-name
|
||
(if org-roam-encrypt-files
|
||
(concat file ".gpg")
|
||
file)
|
||
org-roam-directory)))
|
||
|
||
(defun org-roam-capture--new-file (&optional allow-existing-file-p)
|
||
"Return the path to file during an Org-roam capture.
|
||
|
||
This function reads the file-name attribute of the currently
|
||
active Org-roam template.
|
||
|
||
If the file path already exists, and not ALLOW-EXISTING-FILE-P,
|
||
raise a warning.
|
||
|
||
Else, to insert the header content in the file, `org-capture'
|
||
prepends the `:head' property of the Org-roam capture template.
|
||
|
||
To prevent the creation of a new file if the capture process is
|
||
aborted, we do the following:
|
||
|
||
1. Save the original value of the capture template's :no-save.
|
||
2. Set the capture template's :no-save to t.
|
||
3. Add a function on `org-capture-before-finalize-hook' that saves
|
||
the file if the original value of :no-save is not t and
|
||
`org-note-abort' is not t."
|
||
(let* ((name-templ (or (org-roam-capture--get :file-name)
|
||
(user-error "Template needs to specify `:file-name'")))
|
||
(new-id (s-trim (org-roam-capture--fill-template
|
||
name-templ)))
|
||
(file-path (org-roam-capture--get-file-path new-id))
|
||
(roam-head (or (org-roam-capture--get :head)
|
||
""))
|
||
(org-template (org-capture-get :template))
|
||
(roam-template (concat roam-head org-template)))
|
||
(if (or (file-exists-p file-path)
|
||
(find-buffer-visiting file-path))
|
||
(unless allow-existing-file-p
|
||
(lwarn '(org-roam) :warning
|
||
"Attempted to recreate existing file: %s.
|
||
This can happen when your org-roam db is not in sync with your notes.
|
||
Using existing file..." file-path))
|
||
(make-directory (file-name-directory file-path) t)
|
||
(org-roam-capture--put :orig-no-save (org-capture-get :no-save)
|
||
:new-file t)
|
||
(pcase org-roam-capture--context
|
||
('dailies
|
||
;; Populate the header of the daily file before capture to prevent it
|
||
;; from appearing in the buffer-restriction
|
||
(save-window-excursion
|
||
(find-file file-path)
|
||
(insert (substring (org-capture-fill-template (concat roam-head "*"))
|
||
0 -2))
|
||
(set-buffer-modified-p nil))
|
||
(org-capture-put :template org-template))
|
||
(_
|
||
(org-capture-put :template roam-template
|
||
:type 'plain)))
|
||
(org-capture-put :no-save t))
|
||
file-path))
|
||
|
||
(defun org-roam-capture-find-or-create-olp (olp)
|
||
"Return a marker pointing to the entry at OLP in the current buffer.
|
||
If OLP does not exist, create it. If anything goes wrong, throw
|
||
an error, and if you need to do something based on this error,
|
||
you can catch it with `condition-case'."
|
||
(let* ((level 1)
|
||
(lmin 1)
|
||
(lmax 1)
|
||
(start (point-min))
|
||
(end (point-max))
|
||
found flevel)
|
||
(unless (derived-mode-p 'org-mode)
|
||
(error "Buffer %s needs to be in Org mode" (current-buffer)))
|
||
(org-with-wide-buffer
|
||
(goto-char start)
|
||
(dolist (heading olp)
|
||
(let ((re (format org-complex-heading-regexp-format
|
||
(regexp-quote heading)))
|
||
(cnt 0))
|
||
(while (re-search-forward re end t)
|
||
(setq level (- (match-end 1) (match-beginning 1)))
|
||
(when (and (>= level lmin) (<= level lmax))
|
||
(setq found (match-beginning 0) flevel level cnt (1+ cnt))))
|
||
(when (> cnt 1)
|
||
(error "Heading not unique on level %d: %s" lmax heading))
|
||
(when (= cnt 0)
|
||
;; Create heading if it doesn't exist
|
||
(goto-char end)
|
||
(unless (bolp) (newline))
|
||
(org-insert-heading nil nil t)
|
||
(unless (= lmax 1) (org-do-demote))
|
||
(insert heading)
|
||
(setq end (point))
|
||
(goto-char start)
|
||
(while (re-search-forward re end t)
|
||
(setq level (- (match-end 1) (match-beginning 1)))
|
||
(when (and (>= level lmin) (<= level lmax))
|
||
(setq found (match-beginning 0) flevel level cnt (1+ cnt))))))
|
||
(goto-char found)
|
||
(setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
|
||
(setq start found
|
||
end (save-excursion (org-end-of-subtree t t))))
|
||
(point-marker))))
|
||
|
||
(defun org-roam-capture--get-ref-path (type path)
|
||
"Get the file path to the ref with TYPE and PATH."
|
||
(caar (org-roam-db-query
|
||
[:select [file]
|
||
:from refs
|
||
:where (= type $s1)
|
||
:and (= ref $s2)
|
||
:limit 1]
|
||
type path)))
|
||
|
||
(defun org-roam-capture--get-point ()
|
||
"Return exact point to file for org-capture-template.
|
||
The file to use is dependent on the context:
|
||
|
||
If the search is via title, it is assumed that the file does not
|
||
yet exist, and Org-roam will attempt to create new file.
|
||
|
||
If the search is via daily notes, 'time will be passed via
|
||
`org-roam-capture--info'. This is used to alter the default time
|
||
in `org-capture-templates'.
|
||
|
||
If the search is via ref, it is matched against the Org-roam database.
|
||
If there is no file with that ref, a file with that ref is created.
|
||
|
||
This function is used solely in Org-roam's capture templates: see
|
||
`org-roam-capture-templates'."
|
||
(let* ((file-path (pcase org-roam-capture--context
|
||
('capture
|
||
(or (cdr (assoc 'file org-roam-capture--info))
|
||
(org-roam-capture--new-file)))
|
||
('title
|
||
(org-roam-capture--new-file))
|
||
('dailies
|
||
(org-capture-put :default-time (cdr (assoc 'time org-roam-capture--info)))
|
||
(org-roam-capture--new-file 'allow-existing))
|
||
;; ('ref
|
||
;; (if-let ((ref (cdr (assoc 'ref org-roam-capture--info))))
|
||
;; (pcase (org-roam--split-ref ref)
|
||
;; (`(,type . ,path)
|
||
;; (or (org-roam-capture--get-ref-path type path)
|
||
;; (org-roam-capture--new-file)))
|
||
;; (_ (user-error "%s is not a valid ref" ref)))
|
||
;; (error "Ref not found in `org-roam-capture--info'")))
|
||
(_ (error "Invalid org-roam-capture-context")))))
|
||
(org-capture-put :template
|
||
(org-roam-capture--fill-template (org-capture-get :template)))
|
||
(org-roam-capture--put :file-path file-path
|
||
:finalize (or (org-capture-get :finalize)
|
||
(org-roam-capture--get :finalize)))
|
||
(while org-roam-capture-additional-template-props
|
||
(let ((prop (pop org-roam-capture-additional-template-props))
|
||
(val (pop org-roam-capture-additional-template-props)))
|
||
(org-roam-capture--put prop val)))
|
||
(set-buffer (org-capture-target-buffer file-path))
|
||
(widen)
|
||
(if-let* ((olp (org-roam-capture--get :olp)))
|
||
(condition-case err
|
||
(when-let ((marker (org-roam-capture-find-or-create-olp olp)))
|
||
(goto-char marker)
|
||
(set-marker marker nil))
|
||
(error
|
||
(when (org-roam-capture--get :new-file)
|
||
(kill-buffer))
|
||
(signal (car err) (cdr err))))
|
||
(goto-char (point-max)))))
|
||
|
||
(defun org-roam-capture--convert-template (template)
|
||
"Convert TEMPLATE from Org-roam syntax to `org-capture-templates' syntax."
|
||
(pcase template
|
||
(`(,_key ,_description) template)
|
||
(`(,key ,description ,type ,target . ,rest)
|
||
(let ((converted `(,key ,description ,type ,target
|
||
,(unless (keywordp (car rest)) (pop rest))))
|
||
org-roam-plist
|
||
options)
|
||
(while rest
|
||
(let* ((key (pop rest))
|
||
(val (pop rest))
|
||
(custom (member key org-roam-capture--template-keywords)))
|
||
(when (and custom
|
||
(not val))
|
||
(user-error "Invalid capture template format: %s\nkey %s cannot be nil" template key))
|
||
(push val (if custom org-roam-plist options))
|
||
(push key (if custom org-roam-plist options))))
|
||
(append converted options `(:org-roam ,org-roam-plist))))
|
||
(_ (user-error "Invalid capture template format: %s" template))))
|
||
|
||
(defcustom org-roam-capture-after-find-file-hook nil
|
||
"Hook that is run right after an Org-roam capture process is finalized.
|
||
Suitable for moving point."
|
||
:group 'org-roam
|
||
:type 'hook)
|
||
|
||
(defcustom org-roam-capture-function #'org-capture
|
||
"Function that is invoked to start the `org-capture' process."
|
||
:group 'org-roam
|
||
:type 'function)
|
||
|
||
(defun org-roam-capture--capture (&optional goto keys)
|
||
"Create a new file, and return the path to the edited file.
|
||
The templates are defined at `org-roam-capture-templates'. The
|
||
GOTO and KEYS argument have the same functionality as
|
||
`org-capture'."
|
||
(let* ((org-capture-templates (mapcar #'org-roam-capture--convert-template org-roam-capture-templates))
|
||
(one-template-p (= (length org-capture-templates) 1))
|
||
org-capture-templates-contexts)
|
||
(when one-template-p
|
||
(setq keys (caar org-capture-templates)))
|
||
(if (or one-template-p
|
||
(eq org-roam-capture-function 'org-capture))
|
||
(org-capture goto keys)
|
||
(funcall-interactively org-roam-capture-function))))
|
||
|
||
;;;###autoload
|
||
(defun org-roam-capture (&optional goto keys)
|
||
"Launches an `org-capture' process for a new or existing note.
|
||
This uses the templates defined at `org-roam-capture-templates'.
|
||
Arguments GOTO and KEYS see `org-capture'."
|
||
(interactive "P")
|
||
(let ((node (org-roam-node-read)))
|
||
(if (org-roam-node-id node)
|
||
(let ((org-roam-capture--info (list (cons 'title (org-roam-node-title node))
|
||
(cons 'slug (funcall org-roam-title-to-slug-function
|
||
(org-roam-node-title node)))
|
||
(cons 'file (org-roam-node-file node))))
|
||
(org-roam-capture--context 'capture))
|
||
(condition-case err
|
||
(org-roam-capture--capture goto keys)
|
||
(error (user-error "%s. Please adjust `org-roam-capture-templates'"
|
||
(error-message-string err))))))))
|
||
|
||
(provide 'org-roam-capture)
|
||
|
||
;;; org-roam-capture.el ends here
|