From: No Wayman <iarchivedmywholelife@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [Patch] Document org-capture-templates entry type default strings
Date: Tue, 31 Mar 2020 17:46:29 -0400 [thread overview]
Message-ID: <87a73wnqoa.fsf@gmail.com> (raw)
I've included the default entry type strings for each entry type
in org-capture-tempalte's
docstring. Made a couple clarifying edits as well. IMO this is
better than having the user hunt for the defaults in the source or
experimenting by creating each type of template:
diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index d292defd6..ac4d633cb 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -159,14 +159,20 @@ description A short string describing the
template, will be shown during
type The type of entry. Valid types are:
entry an Org node, with a headline. Will be
filed
as the child of the target entry or as
a
- top-level entry.
+ top-level entry. Its default template
is:
+ \"* %?\n %a\"
item a plain list item, will be placed in
the
- first plain list at the target
- location.
+ first plain list at the target
location.
+ Its default template is:
+ \"- %?\"
checkitem a checkbox item. This differs from
the
plain list item only in so far as it
uses a
- different default template.
+ different default template. Its
default
+ template is:
+ \"- [ ] %?\"
table-line a new line in the first table at
target location.
+ Its default template is:
+ \"| %? |\"
plain text to be inserted as it is.
target Specification of where the captured item should be
placed.
@@ -214,9 +220,10 @@ target Specification of where the
captured item should be placed.
Most general way: write your own function which
both visits
the file and moves point to the right location
-template The template for creating the capture item. If you
leave this
- empty, an appropriate default template will be used.
See below
- for more details. Instead of a string, this may
also be one of
+template The template for creating the capture item.
+ If it is an empty string or nil, a default template
based on
+ the entry type will be used (see the \"type\"
section above).
+ Instead of a string, this may also be one of:
(file \"/path/to/template-file\")
(function function-returning-the-template)
===File
/mnt/data/programming/repos/org-mode/0001-Document-entry-type-default-template-strings.patch===
From 1b91f8ad184d191e1ee09e79e150d7f51c0c3b18 Mon Sep 17 00:00:00
2001
From: Nicholas Vollmer <iarchivedmywholelife@gmail.com>
Subject: [PATCH] Document entry type default template strings
---
lisp/org-capture.el | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index d292defd6..ac4d633cb 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -159,14 +159,20 @@ description A short string describing the
template, will be shown during
type The type of entry. Valid types are:
entry an Org node, with a headline. Will be
filed
as the child of the target entry or as
a
- top-level entry.
+ top-level entry. Its default template
is:
+ \"* %?\n %a\"
item a plain list item, will be placed in
the
- first plain list at the target
- location.
+ first plain list at the target
location.
+ Its default template is:
+ \"- %?\"
checkitem a checkbox item. This differs from
the
plain list item only in so far as it
uses a
- different default template.
+ different default template. Its
default
+ template is:
+ \"- [ ] %?\"
table-line a new line in the first table at
target location.
+ Its default template is:
+ \"| %? |\"
plain text to be inserted as it is.
target Specification of where the captured item should be
placed.
@@ -214,9 +220,10 @@ target Specification of where the
captured item should be placed.
Most general way: write your own function which
both visits
the file and moves point to the right location
-template The template for creating the capture item. If you
leave this
- empty, an appropriate default template will be used.
See below
- for more details. Instead of a string, this may
also be one of
+template The template for creating the capture item.
+ If it is an empty string or nil, a default template
based on
+ the entry type will be used (see the \"type\"
section above).
+ Instead of a string, this may also be one of:
(file \"/path/to/template-file\")
(function function-returning-the-template)
--
2.26.0
============================================================
next reply other threads:[~2020-03-31 21:46 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-31 21:46 No Wayman [this message]
2020-05-24 13:28 ` [Patch] Document org-capture-templates entry type default strings Bastien
2020-05-24 16:30 ` Kyle Meyer
-- strict thread matches above, loose matches on Subject: below --
2020-05-04 16:18 No Wayman
2020-05-04 17:07 ` No Wayman
2020-05-04 18:08 ` Nicolas Goaziou
2020-05-05 0:34 ` Kyle Meyer
2020-05-05 0:48 ` No Wayman
2020-05-05 0:59 ` Kyle Meyer
2020-05-21 7:52 ` Bastien
2020-05-21 19:35 ` No Wayman
2020-05-22 15:37 ` Bastien
2020-06-04 5:21 ` No Wayman
2020-06-04 5:57 ` Bastien
2020-07-31 20:33 ` No Wayman
2020-09-04 9:35 ` Bastien
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87a73wnqoa.fsf@gmail.com \
--to=iarchivedmywholelife@gmail.com \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).