mirror of
https://github.com/org-roam/org-roam
synced 2025-08-31 14:43:32 -05:00
104 lines
4.3 KiB
HTML
104 lines
4.3 KiB
HTML
<!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>The Org-roam Buffer (Org-roam User Manual)</title>
|
|
|
|
<meta name="description" content="The Org-roam Buffer (Org-roam User Manual)">
|
|
<meta name="keywords" content="The Org-roam Buffer (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="Concepts-and-Configuration.html#Concepts-and-Configuration" rel="up" title="Concepts and Configuration">
|
|
<link href="Org_002droam-Files.html#Org_002droam-Files" rel="next" title="Org-roam Files">
|
|
<link href="Directories-and-Files.html#Directories-and-Files" rel="prev" title="Directories and Files">
|
|
<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>
|
|
<link rel="stylesheet" type="text/css" href="assets/page.css">
|
|
|
|
|
|
</head>
|
|
|
|
<body lang="en">
|
|
<a name="The-Org_002droam-Buffer"></a>
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="Org_002droam-Files.html#Org_002droam-Files" accesskey="n" rel="next">Org-roam Files</a>, Previous: <a href="Directories-and-Files.html#Directories-and-Files" accesskey="p" rel="prev">Directories and Files</a>, Up: <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="u" rel="up">Concepts and Configuration</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
|
</div>
|
|
<hr>
|
|
<a name="The-Org_002droam-Buffer-1"></a>
|
|
<h3 class="section">8.2 The Org-roam Buffer</h3>
|
|
|
|
<p>The Org-roam buffer displays backlinks for the currently active Org-roam note.
|
|
</p>
|
|
<ul>
|
|
<li> User Option: org-roam-buffer
|
|
|
|
<p>The name of the org-roam buffer. Defaults to <code>*org-roam*</code>.
|
|
</p>
|
|
</li><li> User Option: org-roam-buffer-position
|
|
|
|
<p>The position of the Org-roam buffer side window. Valid values are <code>'left</code>,
|
|
<code>'right</code>, <code>'top</code>, <code>'bottom</code>.
|
|
</p>
|
|
</li><li> User Option: org-roam-buffer-width
|
|
|
|
<p>Width of <code>org-roam-buffer</code>. Has an effect only if <code>org-roam-buffer-position</code> is
|
|
<code>'left</code> or <code>'right</code>.
|
|
</p>
|
|
</li><li> User Option: org-roam-buffer-height
|
|
|
|
<p>Height of <code>org-roam-buffer</code>. Has an effect only if <code>org-roam-buffer-position</code> is
|
|
<code>'top</code> or <code>'bottom</code>.
|
|
</p>
|
|
</li><li> User Option: org-roam-buffer-no-delete-other-windows
|
|
|
|
<p>The <code>no-delete-window</code> parameter for the org-roam buffer. Setting it to <code>'t</code> prevents the window from being deleted when calling <code>delete-other-windows</code>.
|
|
</p></li></ul>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|