diff options
author | Sebastian Miele <sebastian.miele@gmail.com> | 2019-10-14 23:29:30 +0000 |
---|---|---|
committer | Kyle Meyer <kyle@kyleam.com> | 2019-11-16 17:17:21 -0500 |
commit | 634880a2e94eca78f57deb0e4331d74e75450d24 (patch) | |
tree | f34b932b464efaf6645ddaa27be6be1edff86eca | |
parent | bc15277156a97c550c3736ffaef2cc06fd1b285e (diff) | |
download | org-mode-634880a2e94eca78f57deb0e4331d74e75450d24.tar.gz |
org-manual: Dynamic Blocks: Fix explanation of :content
* doc/org-manual.org (Dynamic Blocks): Correct the information given
on :content in the plist passed to the writer function.
-rw-r--r-- | doc/org-manual.org | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/org-manual.org b/doc/org-manual.org index 50f6ad8..a1c595f 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -19902,13 +19902,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: |