mirror of
https://github.com/org-roam/org-roam
synced 2025-08-17 13:33:31 -05:00
110 lines
5.4 KiB
HTML
110 lines
5.4 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>Org-roam Template Expansion (Org-roam User Manual)</title>
|
|
|
|
<meta name="description" content="Org-roam Template Expansion (Org-roam User Manual)">
|
|
<meta name="keywords" content="Org-roam Template Expansion (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="The-Templating-System.html#The-Templating-System" rel="up" title="The Templating System">
|
|
<link href="Concepts-and-Configuration.html#Concepts-and-Configuration" rel="next" title="Concepts and Configuration">
|
|
<link href="Template-Walkthrough.html#Template-Walkthrough" rel="prev" title="Template Walkthrough">
|
|
<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="Org_002droam-Template-Expansion"></a>
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="Template-Walkthrough.html#Template-Walkthrough" accesskey="p" rel="prev">Template Walkthrough</a>, Up: <a href="The-Templating-System.html#The-Templating-System" accesskey="u" rel="up">The Templating System</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
|
</div>
|
|
<hr>
|
|
<a name="Org_002droam-Template-Expansion-1"></a>
|
|
<h3 class="section">5.2 Org-roam Template Expansion</h3>
|
|
|
|
<p>Org-roam’s template definitions also extend org-capture’s template syntax, to
|
|
allow prefilling of strings. We have seen a glimpse of this in <a href="Template-Walkthrough.html#Template-Walkthrough">Template
|
|
Walkthrough</a>.
|
|
</p>
|
|
<p>In org-roam templates, the ‘<samp>${var}</samp>’ syntax allows for the expansion of
|
|
variables, stored in ‘<samp>org-roam-capture--info</samp>’. For example, during
|
|
‘<samp>org-roam-insert</samp>’, the user is prompted for a title. Upon entering a
|
|
non-existent title, the ‘<samp>title</samp>’ key in ‘<samp>org-roam-capture--info</samp>’ is set to the
|
|
provided title. ‘<samp>${title}</samp>’ is then expanded into the provided title during the
|
|
org-capture process. Any variables that do not contain strings, are prompted for
|
|
values using ‘<samp>completing-read</samp>’.
|
|
</p>
|
|
<p>After doing this expansion, the org-capture’s template expansion system
|
|
is used to fill up the rest of the template. You may read up more on
|
|
this on <a href="https://orgmode.org/manual/Template-expansion.html#Template-expansion">org-capture’s documentation page</a>.
|
|
</p>
|
|
<p>To illustrate this dual expansion process, take for example the template string:
|
|
‘<samp>"%<%Y%m%d%H%M%S>-${title}"</samp>’, with the title ‘<samp>"Foo"</samp>’. The template is first
|
|
expanded into ‘<samp>%<%Y%m%d%H%M%S>-Foo</samp>’. Then org-capture expands ‘<samp>%<%Y%m%d%H%M%S></samp>’
|
|
with timestamp: e.g. ‘<samp>20200213032037-Foo</samp>’.
|
|
</p>
|
|
<p>All of the flexibility afforded by Emacs and Org-mode are available. For
|
|
example, if you want to encode a UTC timestamp in the filename, you can take
|
|
advantage of org-mode’s ‘<samp>%(EXP)</samp>’ template expansion to call ‘<samp>format-time-string</samp>’
|
|
directly to provide its third argument to specify UTC.
|
|
</p>
|
|
<div class="lisp">
|
|
<pre class="lisp">("d" "default" plain (function org-roam--capture-get-point)
|
|
"%?"
|
|
:file-name "%(format-time-string \"%Y-%m-%d--%H-%M-%SZ--${slug}\" (current-time) t)"
|
|
:head "#+TITLE: ${title}\n"
|
|
:unnarrowed t)
|
|
</pre></div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|