yogsototh/org-roam
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

(docs): clarify org-roam-completion-system (#948)

Browse source
This commit is contained in:
Jethro Kuan 2020-07-19 12:26:00 +08:00 committed by GitHub
parent 10e91a88c1
commit fb5beeb14d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/org-roam.org
View file

@ -645,15 +645,19 @@ This setting excludes all files whose path contain "private" or "dailies".
* Org-roam Completion System
Org-roam offers completion when choosing note titles etc. The completion
system is configurable. The default setting,
Org-roam allows customization of which minibuffer completion system to use for
its interactive commands. The default setting uses Emacs' standard
~completing-read~ mechanism.
#+BEGIN_SRC emacs-lisp
(setq org-roam-completion-system 'default)
#+END_SRC
uses Emacs' standard ~completing-read~. If you prefer
[[https://emacs-helm.github.io/helm/][Helm]], use
If you have installed Helm or Ivy, and have their modes enabled, under the
~'default~ setting they will be used.
In the rare scenario where you use Ivy globally, but prefer [[https://emacs-helm.github.io/helm/][Helm]] for org-roam
commands, set:
#+BEGIN_SRC emacs-lisp
(setq org-roam-completion-system 'helm)

12
doc/org-roam.texi
View file

@ -921,15 +921,19 @@ This setting excludes all files whose path contain ``private'' or ``dailies''.
@node Org-roam Completion System
@chapter Org-roam Completion System
Org-roam offers completion when choosing note titles etc. The completion
system is configurable. The default setting,
Org-roam allows customization of which minibuffer completion system to use for
its interactive commands. The default setting uses Emacs' standard
@code{completing-read} mechanism.
@lisp
(setq org-roam-completion-system 'default)
@end lisp
uses Emacs' standard @code{completing-read}. If you prefer
@uref{https://emacs-helm.github.io/helm/, Helm}, use
If you have installed Helm or Ivy, and have their modes enabled, under the
@code{'default} setting they will be used.
In the rare scenario where you use Ivy globally, but prefer @uref{https://emacs-helm.github.io/helm/, Helm} for org-roam
commands, set:
@lisp
(setq org-roam-completion-system 'helm)