From f4e7cc9ab408a8a9aa8d31f91fb73387883c8ea9 Mon Sep 17 00:00:00 2001 From: Protesilaos Stavrou Date: Thu, 16 Jun 2022 12:23:47 +0300 Subject: [PATCH] Document denote-dired-post-rename-functions --- README.org | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.org b/README.org index 192d5bf..21e38d4 100644 --- a/README.org +++ b/README.org @@ -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