emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Patch] Document org-capture-templates entry type default strings


From: No Wayman
Subject: [Patch] Document org-capture-templates entry type default strings
Date: Tue, 31 Mar 2020 17:46:29 -0400
User-agent: mu4e 1.3.9; emacs 28.0.50


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

============================================================



reply via email to

[Prev in Thread] Current Thread [Next in Thread]