Skip to content

Commit

Permalink
(docs): clarify behavior of capture functions (#1393)
Browse files Browse the repository at this point in the history
  • Loading branch information
paultopia committed Jan 20, 2021
1 parent 16c7a7b commit 2a1c73c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/org-roam.org
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,12 @@ time by setting ~org-roam-db-update-idle-seconds~; or change the cache update
to be triggered immediately after buffer save by setting
~org-roam-db-update-method~ to ~'immediate~.

For experienced ~org-capture~ users, the behavior of ~M-x org-roam-find-file~
may seem unfamiliar: after finishing a capture with ~C-c C-c~, you are returned
not to the original buffer from which you called ~M-x org-roam-find-file~, but
to a buffer pointing to the note you just created. For the usual ~org-capture~
behavior you can call ~M-x org-roam-capture~ instead of ~M-x org-roam-find-file~.

Org-roam makes it easy to create notes, and link them together. To link notes
together, we call ~M-x org-roam-insert~. This brings up a prompt with a list of
title for existing notes. Selecting an existing entry will create and insert a
Expand Down
6 changes: 6 additions & 0 deletions doc/org-roam.texi
Original file line number Diff line number Diff line change
Expand Up @@ -598,6 +598,12 @@ time by setting @code{org-roam-db-update-idle-seconds}; or change the cache upda
to be triggered immediately after buffer save by setting
@code{org-roam-db-update-method} to @code{'immediate}.

For experienced @code{org-capture} users, the behavior of @code{M-x org-roam-find-file}
may seem unfamiliar: after finishing a capture with @code{C-c C-c}, you are returned
not to the original buffer from which you called @code{M-x org-roam-find-file}, but
to a buffer pointing to the note you just created. For the usual @code{org-capture}
behavior you can call @code{M-x org-roam-capture} instead of @code{M-x org-roam-find-file}.

Org-roam makes it easy to create notes, and link them together. To link notes
together, we call @code{M-x org-roam-insert}. This brings up a prompt with a list of
title for existing notes. Selecting an existing entry will create and insert a
Expand Down

0 comments on commit 2a1c73c

Please sign in to comment.