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

(docs): Update org-roam-capture documentation (#904)

Browse Source
This commit is contained in:
Jethro Kuan
2020-07-09 12:56:17 +08:00
committed by GitHub
parent 3348298527
commit ca4a7421bc
2 changed files with 26 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/org-roam.org
View File

@@ -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

23
doc/org-roam.texi
View File

@@ -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::