awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-26 16:40:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

(docs): roam_key -> ROAM_REFS (#1703)

Browse Source 
Also fixes #1697
This commit is contained in:
Jethro Kuan
2021-07-29 02:09:53 +08:00
committed by GitHub
parent 20514b7c6d
commit b3b6277b96
2 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/org-roam.org
View File

@@ -840,7 +840,7 @@ graph navigable.
** The roam-ref protocol
This protocol finds or creates a new note with a given ~roam_key~:
This protocol finds or creates a new note with a given ~ROAM_REFS~:
[[file:images/roam-ref.gif]]
@@ -864,8 +864,7 @@ or as a keybinding in ~qutebrowser~ in , using the ~config.py~ file (see
#+END_SRC
where ~template~ is the template key for a template in
~org-roam-capture-ref-templates~ (see [[*The Templating System][The Templating System]]). These templates
should contain a ~#+roam_key: ${ref}~ in it.
~org-roam-capture-ref-templates~ (see [[*The Templating System][The Templating System]]).
* The Templating System
@@ -1218,7 +1217,7 @@ documents (PDF, EPUB etc.) within Org-mode.
For example, though helm-bibtex provides the ability to visit notes for
bibliographic entries, org-roam-bibtex extends it with the ability to visit the
file with the right =#+ROAM_KEYS=.
file with the right ~ROAM_REFS~.
** Spaced Repetition

7
doc/org-roam.texi
View File

@@ -1223,7 +1223,7 @@ graph navigable.
@node The roam-ref protocol
@section The roam-ref protocol
This protocol finds or creates a new note with a given @code{roam_key}:
This protocol finds or creates a new note with a given @code{ROAM_REFS}:
@image{images/roam-ref,,,,gif}
@@ -1247,8 +1247,7 @@ config.bind("<Ctrl-r>", "open javascript:location.href='org-protocol://roam-ref?
@end example
where @code{template} is the template key for a template in
@code{org-roam-capture-ref-templates} (see @ref{The Templating System}). These templates
should contain a @code{#+roam_key: $@{ref@}} in it.
@code{org-roam-capture-ref-templates} (see @ref{The Templating System}).
@node The Templating System
@chapter The Templating System
@@ -1704,7 +1703,7 @@ documents (PDF, EPUB etc.) within Org-mode.
For example, though helm-bibtex provides the ability to visit notes for
bibliographic entries, org-roam-bibtex extends it with the ability to visit the
file with the right @samp{#+ROAM_KEYS}.
file with the right @code{ROAM_REFS}.
@node Spaced Repetition
@section Spaced Repetition