[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote f4e7cc9ab4 222/355: Document denote-dired-post-r
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote f4e7cc9ab4 222/355: Document denote-dired-post-rename-functions |
Date: |
Sun, 26 Jun 2022 23:58:26 -0400 (EDT) |
branch: externals/denote
commit f4e7cc9ab408a8a9aa8d31f91fb73387883c8ea9
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Document denote-dired-post-rename-functions
---
README.org | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/README.org b/README.org
index 192d5bfa7c..21e38d45be 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
- [elpa] externals/denote e783662363 159/355: Tweak sample configuration, (continued)
- [elpa] externals/denote e783662363 159/355: Tweak sample configuration, ELPA Syncer, 2022/06/27
- [elpa] externals/denote fc9f909061 179/355: Change denote--id to denote--id-format, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 4a5ba1603a 190/355: Document how to write metanotes, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 92a4ff20b6 192/355: Remove obsolete description from doc string, ELPA Syncer, 2022/06/27
- [elpa] externals/denote ebd14ebbd6 187/355: Change placement of maxdepth argument for find, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 979bf352d6 208/355: Clarify requirements for good front matter value, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 0db5be04be 213/355: Use new helper FN for title value in links, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 31fc567702 209/355: Accept optional filetype in front matter formatter, ELPA Syncer, 2022/06/27
- [elpa] externals/denote b64cc491bc 199/355: Add history to denote-link-add-links command, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 4041e437b2 214/355: Add PROTOTYPE of front matter rewrite post-rename, ELPA Syncer, 2022/06/27
- [elpa] externals/denote f4e7cc9ab4 222/355: Document denote-dired-post-rename-functions,
ELPA Syncer <=
- [elpa] externals/denote edbd2f7f1b 270/355: Use our pred instead of generic in file filtering, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 10b30d1e15 232/355: Expand manual on journaling with past date, ELPA Syncer, 2022/06/27
- [elpa] externals/denote b5c7bab15c 227/355: Update manual's Acknowledgements, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 8dcb3aea4e 234/355: Add minor tweaks to the manual, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 429763c246 257/355: Fix broken buttons in backlinks' buffer, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 78f6c7ce35 279/355: Add missing doclicense.texi, ELPA Syncer, 2022/06/27
- [elpa] externals/denote b0d8ad46cf 273/355: Update denote-known-keywords doc string, ELPA Syncer, 2022/06/27
- [elpa] externals/denote da32e7f7f9 249/355: Tweak denote-dired-rewrite-front-matter docstring, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 855c677724 277/355: Reword a minor statement, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 9d599a518e 297/355: Include 'id:' link type in task list, ELPA Syncer, 2022/06/27