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

(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
2 changed files with 16 additions and 8 deletions
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 Completion System
Org-roam offers completion when choosing note titles etc. The completion Org-roam allows customization of which minibuffer completion system to use for
system is configurable. The default setting, its interactive commands. The default setting uses Emacs' standard
~completing-read~ mechanism.
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(setq org-roam-completion-system 'default) (setq org-roam-completion-system 'default)
#+END_SRC #+END_SRC
uses Emacs' standard ~completing-read~. If you prefer If you have installed Helm or Ivy, and have their modes enabled, under the
[[https://emacs-helm.github.io/helm/][Helm]], use ~'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 #+BEGIN_SRC emacs-lisp
(setq org-roam-completion-system 'helm) (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 @node Org-roam Completion System
@chapter Org-roam Completion System @chapter Org-roam Completion System
Org-roam offers completion when choosing note titles etc. The completion Org-roam allows customization of which minibuffer completion system to use for
system is configurable. The default setting, its interactive commands. The default setting uses Emacs' standard
@code{completing-read} mechanism.
@lisp @lisp
(setq org-roam-completion-system 'default) (setq org-roam-completion-system 'default)
@end lisp @end lisp
uses Emacs' standard @code{completing-read}. If you prefer If you have installed Helm or Ivy, and have their modes enabled, under the
@uref{https://emacs-helm.github.io/helm/, Helm}, use @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 @lisp
(setq org-roam-completion-system 'helm) (setq org-roam-completion-system 'helm)