mirror of
https://github.com/org-roam/org-roam
synced 2025-08-31 14:43:32 -05:00
Deploying to gh-pages from @ ca4a7421bc
🚀
This commit is contained in:
@@ -69,8 +69,9 @@ Next: <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" acces
|
||||
<a name="The-Templating-System-1"></a>
|
||||
<h2 class="chapter">6 The Templating System</h2>
|
||||
|
||||
<p>Rather than creating blank files on ‘<samp>org-roam-insert</samp>’ and ‘<samp>org-roam-find-file</samp>’, it
|
||||
may be desirable to prefill the file with templated content. This may include:
|
||||
<p>Rather than creating blank files on <code>org-roam-insert</code> and <code>org-roam-find-file</code>,
|
||||
it may be desirable to prefill the file with templated content. This may
|
||||
include:
|
||||
</p>
|
||||
<ul>
|
||||
<li> Time of creation
|
||||
@@ -80,15 +81,17 @@ may be desirable to prefill the file with templated content. This may include:
|
||||
</li></ul>
|
||||
|
||||
<p>This requires a complex template insertion system. Fortunately, Org ships with a
|
||||
powerful one: ‘<samp>org-capture</samp>’. However, org-capture was not designed for such use.
|
||||
Org-roam abuses ‘<samp>org-capture</samp>’, extending its syntax. To first understand how
|
||||
org-roam’s templating system works, it may be useful to look into basic usage of
|
||||
‘<samp>org-capture</samp>’.
|
||||
powerful one: <code>org-capture</code> (see <a href="http://www.gnu.org/software/emacs/manual/html_node/org/capture.html#capture">(org)capture</a>). However, org-capture was not
|
||||
designed for such use. Org-roam abuses <code>org-capture</code>, extending its syntax and
|
||||
capabilities. To first understand how org-roam’s templating system works, it may
|
||||
be useful to look into basic usage of <code>org-capture</code>.
|
||||
</p>
|
||||
<p>Org-roam’s templates can be customized by modifying the variable
|
||||
‘<samp>org-roam-capture-templates</samp>’. Just like the base ‘<samp>org-capture</samp>’ this variable can
|
||||
contain multiple templates, in which case you will be prompted on which one to
|
||||
use when capturing a new note.
|
||||
<p>For these reasons, Org-roam capture templates are not compatible with regular
|
||||
<code>org-capture</code>. Hence, Org-roam’s templates can be customized by instead
|
||||
modifying the variable <code>org-roam-capture-templates</code>. Just like
|
||||
<code>org-capture-templates</code>, <code>org-roam-capture-templates</code> can contain multiple
|
||||
templates. If <code>org-roam-capture-templates</code> only contains one template, there
|
||||
will be no prompt for template selection.
|
||||
</p>
|
||||
<table class="menu" border="0" cellspacing="0">
|
||||
<tr><td align="left" valign="top">• <a href="Template-Walkthrough.html#Template-Walkthrough" accesskey="1">Template Walkthrough</a>:</td><td> </td><td align="left" valign="top">
|
||||
|
23
org-roam.org
23
org-roam.org
@@ -349,8 +349,9 @@ The backlinks buffer will show any cites of this key: e.g.
|
||||
[[file:images/org-ref-citelink.png]]
|
||||
* The Templating System
|
||||
|
||||
Rather than creating blank files on =org-roam-insert= and =org-roam-find-file=, it
|
||||
may be desirable to prefill the file with templated content. This may include:
|
||||
Rather than creating blank files on ~org-roam-insert~ and ~org-roam-find-file~,
|
||||
it may be desirable to prefill the file with templated content. This may
|
||||
include:
|
||||
|
||||
- Time of creation
|
||||
- File it was created from
|
||||
@@ -358,15 +359,17 @@ may be desirable to prefill the file with templated content. This may include:
|
||||
- Any other data you may want to input manually
|
||||
|
||||
This requires a complex template insertion system. Fortunately, Org ships with a
|
||||
powerful one: =org-capture=. However, org-capture was not designed for such use.
|
||||
Org-roam abuses =org-capture=, extending its syntax. To first understand how
|
||||
org-roam's templating system works, it may be useful to look into basic usage of
|
||||
=org-capture=.
|
||||
powerful one: ~org-capture~ (see info:org#capture). However, org-capture was not
|
||||
designed for such use. Org-roam abuses ~org-capture~, extending its syntax and
|
||||
capabilities. To first understand how org-roam's templating system works, it may
|
||||
be useful to look into basic usage of ~org-capture~.
|
||||
|
||||
Org-roam's templates can be customized by modifying the variable
|
||||
=org-roam-capture-templates=. Just like the base =org-capture= this variable can
|
||||
contain multiple templates, in which case you will be prompted on which one to
|
||||
use when capturing a new note.
|
||||
For these reasons, Org-roam capture templates are not compatible with regular
|
||||
~org-capture~. Hence, Org-roam's templates can be customized by instead
|
||||
modifying the variable ~org-roam-capture-templates~. Just like
|
||||
~org-capture-templates~, ~org-roam-capture-templates~ can contain multiple
|
||||
templates. If ~org-roam-capture-templates~ only contains one template, there
|
||||
will be no prompt for template selection.
|
||||
|
||||
** Template Walkthrough
|
||||
|
||||
|
@@ -525,8 +525,9 @@ The backlinks buffer will show any cites of this key: e.g.
|
||||
@node The Templating System
|
||||
@chapter The Templating System
|
||||
|
||||
Rather than creating blank files on @samp{org-roam-insert} and @samp{org-roam-find-file}, it
|
||||
may be desirable to prefill the file with templated content. This may include:
|
||||
Rather than creating blank files on @code{org-roam-insert} and @code{org-roam-find-file},
|
||||
it may be desirable to prefill the file with templated content. This may
|
||||
include:
|
||||
|
||||
@itemize
|
||||
@item
|
||||
@@ -540,15 +541,17 @@ Any other data you may want to input manually
|
||||
@end itemize
|
||||
|
||||
This requires a complex template insertion system. Fortunately, Org ships with a
|
||||
powerful one: @samp{org-capture}. However, org-capture was not designed for such use.
|
||||
Org-roam abuses @samp{org-capture}, extending its syntax. To first understand how
|
||||
org-roam's templating system works, it may be useful to look into basic usage of
|
||||
@samp{org-capture}.
|
||||
powerful one: @code{org-capture} (see @ref{capture,,,org,}). However, org-capture was not
|
||||
designed for such use. Org-roam abuses @code{org-capture}, extending its syntax and
|
||||
capabilities. To first understand how org-roam's templating system works, it may
|
||||
be useful to look into basic usage of @code{org-capture}.
|
||||
|
||||
Org-roam's templates can be customized by modifying the variable
|
||||
@samp{org-roam-capture-templates}. Just like the base @samp{org-capture} this variable can
|
||||
contain multiple templates, in which case you will be prompted on which one to
|
||||
use when capturing a new note.
|
||||
For these reasons, Org-roam capture templates are not compatible with regular
|
||||
@code{org-capture}. Hence, Org-roam's templates can be customized by instead
|
||||
modifying the variable @code{org-roam-capture-templates}. Just like
|
||||
@code{org-capture-templates}, @code{org-roam-capture-templates} can contain multiple
|
||||
templates. If @code{org-roam-capture-templates} only contains one template, there
|
||||
will be no prompt for template selection.
|
||||
|
||||
@menu
|
||||
* Template Walkthrough::
|
||||
|
Reference in New Issue
Block a user