mirror of
https://github.com/org-roam/org-roam
synced 2025-08-03 12:27:23 -05:00
(doc): reflect that we now allow multiple refs (#1251)
This commit is contained in:
@ -432,29 +432,33 @@ accepts the absolute file path as its argument. See
|
|||||||
|
|
||||||
** File Refs
|
** File Refs
|
||||||
|
|
||||||
Refs are unique identifiers for files. Each note can only have 1 ref.
|
Refs are unique identifiers for files. For example, a note for a website may contain a ref:
|
||||||
For example, a note for a website may contain a ref:
|
|
||||||
|
|
||||||
#+BEGIN_SRC org
|
#+BEGIN_SRC org
|
||||||
#+title: Google
|
#+title: Google
|
||||||
#+roam_key: https://www.google.com/
|
#+roam_key: https://www.google.com/
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
These keys come in useful for when taking website notes, using the
|
These keys allow references to the key to show up in the backlinks buffer. For instance,
|
||||||
~roam-ref~ protocol (see [[*Roam Protocol][Roam Protocol]]).
|
with the example above, if another file then links to https://www.google.com, that will
|
||||||
|
show up as a “Ref Backlink”.
|
||||||
|
|
||||||
Alternatively, add a ref for notes for a specific paper, using its
|
These keys also come in useful for when taking website notes, using the ~roam-ref~ protocol
|
||||||
[[https://github.com/jkitchin/org-ref][org-ref]] citation key:
|
(see [[*Roam Protocol][Roam Protocol]]).
|
||||||
|
|
||||||
|
[[https://github.com/jkitchin/org-ref][org-ref]] citation keys can also be used as refs:
|
||||||
|
|
||||||
#+BEGIN_SRC org
|
#+BEGIN_SRC org
|
||||||
#+title: Neural Ordinary Differential Equations
|
#+title: Neural Ordinary Differential Equations
|
||||||
#+roam_key: cite:chen18_neural_ordin_differ_equat
|
#+roam_key: cite:chen18_neural_ordin_differ_equat
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
The backlinks buffer will show any cites of this key: e.g.
|
|
||||||
|
|
||||||
#+CAPTION: org-ref-citelink
|
#+CAPTION: org-ref-citelink
|
||||||
[[file:images/org-ref-citelink.png]]
|
[[file:images/org-ref-citelink.png]]
|
||||||
|
|
||||||
|
You may assign multiple refs to a single file, for example when you want multiple papers
|
||||||
|
in a series to share the same note, or an article has a citation key and a URL at the same
|
||||||
|
time.
|
||||||
* The Templating System
|
* The Templating System
|
||||||
|
|
||||||
Rather than creating blank files on ~org-roam-insert~ and ~org-roam-find-file~,
|
Rather than creating blank files on ~org-roam-insert~ and ~org-roam-find-file~,
|
||||||
|
@ -647,32 +647,36 @@ accepts the absolute file path as its argument. See
|
|||||||
@node File Refs
|
@node File Refs
|
||||||
@section File Refs
|
@section File Refs
|
||||||
|
|
||||||
Refs are unique identifiers for files. Each note can only have 1 ref.
|
Refs are unique identifiers for files. For example, a note for a website may contain a ref:
|
||||||
For example, a note for a website may contain a ref:
|
|
||||||
|
|
||||||
@example
|
@example
|
||||||
#+title: Google
|
#+title: Google
|
||||||
#+roam_key: https://www.google.com/
|
#+roam_key: https://www.google.com/
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
These keys come in useful for when taking website notes, using the
|
These keys allow references to the key to show up in the backlinks buffer. For instance,
|
||||||
@code{roam-ref} protocol (see @ref{Roam Protocol}).
|
with the example above, if another file then links to @uref{https://www.google.com}, that will
|
||||||
|
show up as a “Ref Backlink”.
|
||||||
|
|
||||||
Alternatively, add a ref for notes for a specific paper, using its
|
These keys also come in useful for when taking website notes, using the @code{roam-ref} protocol
|
||||||
@uref{https://github.com/jkitchin/org-ref, org-ref} citation key:
|
(see @ref{Roam Protocol}).
|
||||||
|
|
||||||
|
@uref{https://github.com/jkitchin/org-ref, org-ref} citation keys can also be used as refs:
|
||||||
|
|
||||||
@example
|
@example
|
||||||
#+title: Neural Ordinary Differential Equations
|
#+title: Neural Ordinary Differential Equations
|
||||||
#+roam_key: cite:chen18_neural_ordin_differ_equat
|
#+roam_key: cite:chen18_neural_ordin_differ_equat
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
The backlinks buffer will show any cites of this key: e.g.
|
|
||||||
|
|
||||||
@float Figure
|
@float Figure
|
||||||
@image{images/org-ref-citelink,,,,png}
|
@image{images/org-ref-citelink,,,,png}
|
||||||
@caption{org-ref-citelink}
|
@caption{org-ref-citelink}
|
||||||
@end float
|
@end float
|
||||||
|
|
||||||
|
You may assign multiple refs to a single file, for example when you want multiple papers
|
||||||
|
in a series to share the same note, or an article has a citation key and a URL at the same
|
||||||
|
time.
|
||||||
|
|
||||||
@node The Templating System
|
@node The Templating System
|
||||||
@chapter The Templating System
|
@chapter The Templating System
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user