From: Sebastian Miele <sebastian.miele@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] org-manual: Dynamic Blocks: Fix explanation of :content
Date: Mon, 14 Oct 2019 23:29:30 +0000 [thread overview]
Message-ID: <87ftjulxd1.fsf@gmail.com> (raw)
* doc/org-manual.org (Dynamic Blocks): Correct the information given
on :content in the plist passed to the writer function.
---
doc/org-manual.org | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 59591894d..79257b7e0 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -20089,13 +20089,12 @@ These commands update dynamic blocks:
Before updating a dynamic block, Org removes content between the
=BEGIN= and =END= markers. Org then reads the parameters on the
-=BEGIN= line for passing to the writer function. If the function
-expects to access the removed content, then Org expects an extra
-parameter, =:content=, on the =BEGIN= line.
+=BEGIN= line for passing to the writer function as a plist. The
+previous content of the dynamic block becomes erased from the buffer
+and appended to the plist under ~:content~.
The syntax for naming a writer function with a dynamic block labelled
-=myblock= is: ~org-dblock-write:myblock~. Parameters come from the
-=BEGIN= line.
+=myblock= is: ~org-dblock-write:myblock~.
The following is an example of a dynamic block and a block writer function
that updates the time when the function was last run:
--
2.23.0
next reply other threads:[~2019-10-14 23:29 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-14 23:29 Sebastian Miele [this message]
2019-11-16 23:04 ` [PATCH] org-manual: Dynamic Blocks: Fix explanation of :content Kyle Meyer
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=87ftjulxd1.fsf@gmail.com \
--to=sebastian.miele@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).