awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-29 14:33:29 -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

97
manual/Index-File.html Normal file
View File

@@ -0,0 +1,97 @@
<!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>Index File (Org-roam User Manual)</title>
<meta name="description" content="Index File (Org-roam User Manual)">
<meta name="keywords" content="Index File (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="Navigating-Around.html#Navigating-Around" rel="up" title="Navigating Around">
<link href="Encryption.html#Encryption" rel="next" title="Encryption">
<link href="Navigating-Around.html#Navigating-Around" rel="prev" title="Navigating Around">
<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="Index-File"></a>
<div class="header">
<p>
Up: <a href="Navigating-Around.html#Navigating-Around" accesskey="u" rel="up">Navigating Around</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Index-File-1"></a>
<h3 class="section">7.1 Index File</h3>
<p>As your collection grows, you might want to create an index where you keep links
to your main files.
</p>
<p>In Org-roam, you can define the path to your index file by setting
&lsquo;<samp>org-roam-index-file</samp>&rsquo;.
</p>
<ul>
<li> Variable: org-roam-index-file
<p>Path to the Org-roam index file.
</p>
<p>The path can be a string or a function. If it is a string, it should be the
path (absolute or relative to &lsquo;<samp>org-roam-directory</samp>&rsquo;) to the index file. If it
is is a function, the function should return the path to the index file.
Otherwise, the index is assumed to be a note in &lsquo;<samp>org-roam-index</samp>&rsquo; whose
title is &lsquo;<samp>&quot;Index&quot;</samp>&rsquo;.
</p>
</li><li> Function: org-roam-find-index
<p>Opens the Index file in the current &lsquo;<samp>org-roam-directory</samp>&rsquo;.
</p></li></ul>
</body>
</html>