tfelypoc/-._protesilaos-s-___denote___.-
tfelypoc/-._protesilaos-s-___denote___.-
1
1
Fork 0
Code Issues Projects 1 Releases Activity

Document denote-dired-post-rename-functions

Browse source
This commit is contained in:
Protesilaos Stavrou 2022-06-16 12:23:47 +03:00
parent a436cdf07e
commit f4e7cc9ab4
No known key found for this signature in database
GPG key ID: 99BD6459CD5CA3EA
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.org
View file

@ -362,6 +362,23 @@ extension are simply left without one.
Renaming only occurs relative to the current directory. Files are not
moved between directories.
#+vindex: denote-dired-post-rename-functions
#+findex: denote-dired-rewrite-front-matter
The final step of the ~denote-dired-rename-file~ command is to call the
special hook ~denote-dired-post-rename-functions~. Functions added to
that hook must accept three arguments, as explained in its doc string.
For the time being, the only function we define is the one which updates
the underlying note's front matter to match the new file name:
~denote-dired-rewrite-front-matter~. The function takes care to only
operate on an actual note, instead of arbitrary files.
DEVELOPMENT NOTE: the ~denote-dired-rewrite-front-matter~ needs to be
tested thoroughly. It rewrites file contents so we have to be sure it
does the right thing. To avoid any trouble, it always asks for
confirmation before performing the replacement. This confirmation
ignores ~denote-dired-rename-expert~ for the time being, though we might
want to lift that restriction once everything works as intended.
* Front matter
:PROPERTIES:
:CUSTOM_ID: h:13218826-56a5-482a-9b91-5b6de4f14261