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

Merge branch 'v2' of github.com:org-roam/org-roam into v2

Browse Source
This commit is contained in:
Jethro Kuan
2021-04-15 03:14:37 +08:00
parent f52c3a47d4 b1ebba4b9a
commit 3615969b35
2 changed files with 190 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
org-roam-capture.el
View File

@ -64,23 +64,25 @@ during the Org-roam capture process.")
Each entry is a list with the following items: Each entry is a list with the following items:
keys The keys that will select the template, as a string, characters only, keys The keys that will select the template, as a string, characters only, for
for example \"a\" for a template to be selected with a single key, or \"bt\" example \"a\" for a template to be selected with a single key, or
for selection with two keys. When using several keys, keys using the same prefix \"bt\" for selection with two keys. When using several keys, keys
must be together in the list and preceded by a 2-element entry using the same prefix must be together in the list and preceded by a
explaining the prefix key, for example: 2-element entry explaining the prefix key, for example:
(\"b\" \"Templates for marking stuff to buy\") (\"b\" \"Templates for marking stuff to buy\")
The \"C\" key is used by default for quick access to the customization of the template The \"C\" key is used by default for quick access to the customization of
variable. But if you want to use that key for a template, you can. the template variable. But if you want to use that key for a template,
you can.
description A short string describing the template, which will be shown during selection. description A short string describing the template, which will be shown
during selection.
type The type of entry. Valid types are: type The type of entry. Valid types are:
entry an Org node, with a headline. Will be filed entry an Org node, with a headline. Will be filed
as the child of the target entry or as a as the child of the target entry or as a
top-level entry. Its default template is: top level entry. Its default template is:
\"* %?\n %a\" \"* %?\n %a\"
item a plain list item, will be placed in the item a plain list item, will be placed in the
first plain list at the target location. first plain list at the target location.
@ -119,12 +121,13 @@ the following options:
inserted into the file. inserted into the file.
(file+olp \"path/to/file\" '(\"h1\" \"h2\")) (file+olp \"path/to/file\" '(\"h1\" \"h2\"))
The file will be created, prescribed an ID. The OLP (h1, h2) will be created, The file will be created, prescribed an ID. The OLP (h1, h2) will be
and the point placed after. created, and the point placed after.
(file+head+olp \"path/to/file\" \"head content\" '(\"h1\" \"h2\")) (file+head+olp \"path/to/file\" \"head content\" '(\"h1\" \"h2\"))
The file will be created, prescribed an ID. Head content will be inserted at the The file will be created, prescribed an ID. Head content will be
start of the file. The OLP (h1, h2) will be created, and the point placed after. inserted at the start of the file. The OLP (h1, h2) will be created,
and the point placed after.
The rest of the entry is a property list of additional options. Recognized The rest of the entry is a property list of additional options. Recognized
properties are: properties are:
@ -199,7 +202,7 @@ be replaced with content and expanded:
introduced with %[pathname] are expanded this way. Since this introduced with %[pathname] are expanded this way. Since this
happens after expanding non-interactive %-escapes, those can happens after expanding non-interactive %-escapes, those can
be used to fill the expression. be used to fill the expression.
%<...> The result of format-time-string on the ... format specification. %<...> The result of `format-time-string' on the ... format specification.
%t Time stamp, date only. The time stamp is the current time, %t Time stamp, date only. The time stamp is the current time,
except when called from agendas with `\\[org-agenda-capture]' or except when called from agendas with `\\[org-agenda-capture]' or
with `org-capture-use-agenda-date' set. with `org-capture-use-agenda-date' set.
@ -218,7 +221,7 @@ be replaced with content and expanded:
%k Title of currently clocked task. %k Title of currently clocked task.
%K Link to currently clocked task. %K Link to currently clocked task.
%n User name (taken from the variable `user-full-name'). %n User name (taken from the variable `user-full-name').
%f File visited by current buffer when org-capture was called. %f File visited by current buffer when `org-capture' was called.
%F Full path of the file or directory visited by current buffer. %F Full path of the file or directory visited by current buffer.
%:keyword Specific information for certain link types, see below. %:keyword Specific information for certain link types, see below.
%^g Prompt for tags, with completion on tags in target file. %^g Prompt for tags, with completion on tags in target file.
@ -271,8 +274,7 @@ Org-roam templates are NOT compatible with regular Org capture:
they rely on additional hacks and hooks to achieve the they rely on additional hacks and hooks to achieve the
streamlined user experience in Org-roam." streamlined user experience in Org-roam."
:group 'org-roam :group 'org-roam
:type :type '(repeat
'(repeat
(choice (list :tag "Multikey description" (choice (list :tag "Multikey description"
(string :tag "Keys ") (string :tag "Keys ")
(string :tag "Description")) (string :tag "Description"))
@ -338,8 +340,7 @@ streamlined user experience in Org-roam. "
"The Org-roam templates used during a capture from the roam-ref protocol. "The Org-roam templates used during a capture from the roam-ref protocol.
See `org-roam-capture-templates' for the template documentation." See `org-roam-capture-templates' for the template documentation."
:group 'org-roam :group 'org-roam
:type :type '(repeat
'(repeat
(choice (list :tag "Multikey description" (choice (list :tag "Multikey description"
(string :tag "Keys ") (string :tag "Keys ")
(string :tag "Description")) (string :tag "Description"))

4
org-roam-dailies.el
View File

@ -68,8 +68,7 @@
"Capture templates for daily-notes in Org-roam. "Capture templates for daily-notes in Org-roam.
See `org-roam-capture-templates' for the template documentation." See `org-roam-capture-templates' for the template documentation."
:group 'org-roam :group 'org-roam
:type :type '(repeat
'(repeat
(choice (list :tag "Multikey description" (choice (list :tag "Multikey description"
(string :tag "Keys ") (string :tag "Keys ")
(string :tag "Description")) (string :tag "Description"))
@ -272,7 +271,6 @@ creating an entry."
(defun org-roam-dailies-find-date (&optional prefer-future) (defun org-roam-dailies-find-date (&optional prefer-future)
"Find the daily-note for a date using the calendar, creating it if necessary. "Find the daily-note for a date using the calendar, creating it if necessary.
Prefer past dates, unless PREFER-FUTURE is non-nil." Prefer past dates, unless PREFER-FUTURE is non-nil."
(interactive) (interactive)
(org-roam-dailies-capture-date t prefer-future)) (org-roam-dailies-capture-date t prefer-future))