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

Deploying to gh-pages from @ 4266a81b51 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-05-13 11:45:38 +00:00
parent b9b6a60b69
commit ab1a5280f0
59 changed files with 6664 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
manual/File-Refs.html Normal file
View File

@@ -0,0 +1,100 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2020-2020 Jethro Kuan <jethrokuan95@gmail.com>
You can redistribute this document and/or modify it under the terms
of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any
later version.
This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
-->
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>File Refs (Org-roam User Manual)</title>
<meta name="description" content="File Refs (Org-roam User Manual)">
<meta name="keywords" content="File Refs (Org-roam User Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" rel="up" title="Anatomy of an Org-roam File">
<link href="The-Templating-System.html#The-Templating-System" rel="next" title="The Templating System">
<link href="File-Aliases.html#File-Aliases" rel="prev" title="File Aliases">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<a name="File-Refs"></a>
<div class="header">
<p>
Previous: <a href="File-Aliases.html#File-Aliases" accesskey="p" rel="prev">File Aliases</a>, Up: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="u" rel="up">Anatomy of an Org-roam File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="File-Refs-1"></a>
<h3 class="section">4.2 File Refs</h3>
<p>Refs are unique identifiers for files. Each note can only have 1 ref.
For example, a note for a website may contain a ref:
</p>
<div class="example">
<pre class="example">#+TITLE: Google
#+ROAM_KEY: https://www.google.com/
</pre></div>
<p>These keys come in useful for when taking website notes, using the
&lsquo;<samp>roam-ref</samp>&rsquo; protocol (see <a href="Roam-Protocol.html#Roam-Protocol">Roam Protocol</a>).
</p>
<p>Alternatively, add a ref for notes for a specific paper, using its
<a href="https://github.com/jkitchin/org-ref">org-ref</a> citation key:
</p>
<div class="example">
<pre class="example">#+TITLE: Neural Ordinary Differential Equations
#+ROAM_KEY: cite:chen18_neural_ordin_differ_equat
</pre></div>
<p>The backlinks buffer will show any cites of this key: e.g.
</p>
<div class="float">
<img src="images/org-ref-citelink.png" alt="images/org-ref-citelink">
<div class="float-caption"><p><strong>Figure: </strong>org-ref-citelink</p></div></div>
</body>
</html>