awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

(doc): Add footnote for tab completion (#1348)

Browse Source 
Follow on to #1345.

The discussion in the Slack thread further clarified what was exactly
confusing for a beginner reader of this Getting Started. When a user is using
the built-in completion (no ivy, no ido), then `org-roam-find-file` does not
immediately show any files -- instead, the user has to press TAB. This is not
explicitly mentioned.
This commit is contained in:
Noboru Ota
2020-12-19 09:42:43 +01:00
committed by GitHub
parent 43831c5819
commit ecf515f650
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/org-roam.org
View File

@ -365,10 +365,10 @@ avoid getting in the way of writing. Org-roam queues updates to the files,
waits for you to be idle for 2 seconds, and then automatically triggers waits for you to be idle for 2 seconds, and then automatically triggers
updating the cache. After the cache has been updated, running ~M-x updating the cache. After the cache has been updated, running ~M-x
org-roam-find-file~ again should show the note you have created, and selecting org-roam-find-file~ again should show the note you have created, and selecting
that entry will bring you to that note. One can customize the waiting time by that entry will bring you to that note [fn:1]. One can customize the waiting
setting ~org-roam-db-update-idle-seconds~; or change the cache update to be time by setting ~org-roam-db-update-idle-seconds~; or change the cache update
triggered immediately after buffer save by setting ~org-roam-db-update-method~ to be triggered immediately after buffer save by setting
to ~'immediate~. ~org-roam-db-update-method~ to ~'immediate~.
Org-roam makes it easy to create notes, and link them together. To link notes 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 together, we call ~M-x org-roam-insert~. This brings up a prompt with a list of
@ -1667,6 +1667,9 @@ are the solutions:
:END: :END:
* Footnotes * Footnotes
[fn:1] Depending on your completion framework, you may need to press TAB to
see the list.
[fn:roam] To understand more about Roam, a collection of links are available in [[*Note-taking Workflows][Note-taking Workflows]]. [fn:roam] To understand more about Roam, a collection of links are available in [[*Note-taking Workflows][Note-taking Workflows]].
# Local Variables: # Local Variables:

9
doc/org-roam.texi
View File

@ -592,10 +592,11 @@ avoid getting in the way of writing. Org-roam queues updates to the files,
waits for you to be idle for 2 seconds, and then automatically triggers waits for you to be idle for 2 seconds, and then automatically triggers
updating the cache. After the cache has been updated, running @code{M-x updating the cache. After the cache has been updated, running @code{M-x
org-roam-find-file} again should show the note you have created, and selecting org-roam-find-file} again should show the note you have created, and selecting
that entry will bring you to that note. One can customize the waiting time by that entry will bring you to that note @footnote{Depending on your completion framework, you may need to press TAB to
setting @code{org-roam-db-update-idle-seconds}; or change the cache update to be see the list.}. One can customize the waiting
triggered immediately after buffer save by setting @code{org-roam-db-update-method} time by setting @code{org-roam-db-update-idle-seconds}; or change the cache update
to @code{'immediate}. to be triggered immediately after buffer save by setting
@code{org-roam-db-update-method} to @code{'immediate}.
Org-roam makes it easy to create notes, and link them together. To link notes 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 together, we call @code{M-x org-roam-insert}. This brings up a prompt with a list of