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

(doc): add FAQ for completion into manual (#1161)

Browse Source 
Fixes #960
This commit is contained in:
Jethro Kuan
2020-10-01 12:30:05 +08:00
committed by GitHub
parent ce17e7eecd
commit 6759bee56b
2 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/org-roam.org
View File

@ -1285,6 +1285,17 @@ file within that directory, at least once.
Fabio has produced a command-line tool that converts markdown files exported from Roam Research into Org-roam compatible markdown. More instructions are provided [[https://github.com/fabioberger/roam-migration][in the repository]]. Fabio has produced a command-line tool that converts markdown files exported from Roam Research into Org-roam compatible markdown. More instructions are provided [[https://github.com/fabioberger/roam-migration][in the repository]].
** How do I create a note whose title already matches one of the candidates?
This situation arises when, for example, one would like to create a note titled
"bar" when "barricade" already exists.
The solution is dependent on the mini-buffer completion framework in use. Here
are the solutions:
- Ivy :: call ~ivy-immediate-done~, typically bound to ~C-M-j~. Alternatively, set ~ivy-use-selectable-prompt~ to ~t~, so that "bar" is now selectable.
- Helm :: Org-roam should provide a selectable "[?] bar" candidate at the top of the candidate list.
# Local Variables: # Local Variables:
# eval: (require 'ol-info) # eval: (require 'ol-info)
# before-save-hook: org-make-toc # before-save-hook: org-make-toc

18
doc/org-roam.texi
View File

@ -151,6 +151,7 @@ FAQ
* How do I have more than one Org-roam directory?:: * How do I have more than one Org-roam directory?::
* How do I migrate from Roam Research?:: * How do I migrate from Roam Research?::
* How do I create a note whose title already matches one of the candidates?::
@end detailmenu @end detailmenu
@end menu @end menu
@ -1627,6 +1628,7 @@ files. Other alternatives include @uref{https://orgmode.org/worg/org-contrib/org
@menu @menu
* How do I have more than one Org-roam directory?:: * How do I have more than one Org-roam directory?::
* How do I migrate from Roam Research?:: * How do I migrate from Roam Research?::
* How do I create a note whose title already matches one of the candidates?::
@end menu @end menu
@node How do I have more than one Org-roam directory? @node How do I have more than one Org-roam directory?
@ -1654,5 +1656,21 @@ file within that directory, at least once.
Fabio has produced a command-line tool that converts markdown files exported from Roam Research into Org-roam compatible markdown. More instructions are provided @uref{https://github.com/fabioberger/roam-migration, in the repository}. Fabio has produced a command-line tool that converts markdown files exported from Roam Research into Org-roam compatible markdown. More instructions are provided @uref{https://github.com/fabioberger/roam-migration, in the repository}.
@node How do I create a note whose title already matches one of the candidates?
@section How do I create a note whose title already matches one of the candidates?
This situation arises when, for example, one would like to create a note titled
``bar'' when ``barricade'' already exists.
The solution is dependent on the mini-buffer completion framework in use. Here
are the solutions:
@table @asis
@item Ivy
call @code{ivy-immediate-done}, typically bound to @code{C-M-j}. Alternatively, set @code{ivy-use-selectable-prompt} to @code{t}, so that ``bar'' is now selectable.
@item Helm
Org-roam should provide a selectable ``[?] bar'' candidate at the top of the candidate list.
@end table
Emacs 28.0.50 (Org mode 9.4) Emacs 28.0.50 (Org mode 9.4)
@bye @bye