branch: externals/denote
commit a13919d3b1399caff4bd2b989ba6df60e8bb45fd
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Mention the user option 'denote-file-name-components-order' in more places
---
README.org | 21 ++++++++++++++++++++-
denote.el | 16 ++++++++++++++--
2 files changed, 34 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index ebebdf1bf3..f011ae7747 100644
--- a/README.org
+++ b/README.org
@@ -159,6 +159,9 @@ subsequent sections. Other more specialised commands exist
as well,
which one shall learn about as they read through this manual. We do
not want to overwhelm the user with options at this stage.
+All these commands constructs the file name in accordance with the user option
+~denote-file-name-components-order~
([[#h:dc8c40e0-233a-4991-9ad3-2cf5f05ef1cd][Change the order of file name
components]]).
+
** Standard note creation
:PROPERTIES:
:CUSTOM_ID: h:6a92a8b5-d766-42cc-8e5b-8dc255466a23
@@ -1298,7 +1301,8 @@ mechanisms to facilitate the task of renaming them.
#+vindex: denote-after-rename-file-hook
All renaming commands run the ~denote-after-rename-file-hook~ after a
-succesful operation.
+succesful operation. They also construct the file name in accordance
+with the user option ~denote-file-name-components-order~
([[#h:dc8c40e0-233a-4991-9ad3-2cf5f05ef1cd][Change the order of file name
components]]).
Apart from renaming files, Denote can also rename only the buffer.
The idea is that the underlying file name is correct but it can be
@@ -1406,6 +1410,11 @@ types (per ~denote-file-type~), add front matter to the
top of it and
leave the buffer unsaved for further inspection
([[#h:13218826-56a5-482a-9b91-5b6de4f14261][Front matter]]). Save
the buffer if ~denote-save-buffers~ is non-nil
([[#h:bf80f4cd-6f56-4f7c-a991-8573161e4511][The ~denote-save-buffers~ option]]).
+Construct the file name in accordance with the user option
+~denote-file-name-components-order~
([[#h:dc8c40e0-233a-4991-9ad3-2cf5f05ef1cd][Change the order of file name
components]]).
+
+Run the ~denote-after-rename-file-hook~ after renaming =FILE=.
+
This command is intended to (i) rename Denote files, (ii) convert
existing supported file types to Denote notes, and (ii) rename
non-note files (e.g. =PDF=) that can benefit from Denote's file-naming
@@ -1515,6 +1524,9 @@ edited in the front matter: Denote considers the file
name to be the
source of truth in this case, to avoid potential breakage with typos and
the like.
+This command constructs the file name in accordance with the user option
+~denote-file-name-components-order~
([[#h:dc8c40e0-233a-4991-9ad3-2cf5f05ef1cd][Change the order of file name
components]]).
+
** Rename multiple files interactively
:PROPERTIES:
:CUSTOM_ID: h:1b6b2c78-42f0-45b8-9ef0-6de21a8b2cde
@@ -1575,6 +1587,10 @@ so by writing keywords to them. Specifically, it does
the following:
string). ]
[ The following two commands are part of {{{development-version}}}. ]
+Construct the file name in accordance with the user option
+~denote-file-name-components-order~
([[#h:dc8c40e0-233a-4991-9ad3-2cf5f05ef1cd][Change the order of file name
components]]).
+
+Run the ~denote-after-rename-file-hook~ after the renaming is done.
#+findex: denote-dired-rename-marked-files-add-keywords
#+findex: denote-dired-rename-marked-files-remove-keywords
@@ -1628,6 +1644,9 @@ field in the file's front matter, depending on the
previous file type
As a final step, the command asks for confirmation, showing the
difference between old and new file names.
+This command constructs the file name in accordance with the user option
+~denote-file-name-components-order~
([[#h:dc8c40e0-233a-4991-9ad3-2cf5f05ef1cd][Change the order of file name
components]]).
+
** Rename a file by adding or removing keywords interactively
:PROPERTIES:
:CUSTOM_ID: h:ad4dde4a-8e88-470a-97ae-e7b9d4b41fb4
diff --git a/denote.el b/denote.el
index 23e7f464f2..1dd59ea0f2 100644
--- a/denote.el
+++ b/denote.el
@@ -3012,6 +3012,9 @@ For the front matter of each file type, refer to the
variables:
- `denote-toml-front-matter'
- `denote-yaml-front-matter'
+Construct the file name in accordance with the user option
+`denote-file-name-components-order'.
+
Run the `denote-after-rename-file-hook' after renaming FILE.
This command is intended to (i) rename Denote files, (ii) convert
@@ -3149,6 +3152,9 @@ Specifically, do the following:
it is recognized as a Denote note (per `denote-file-type'),
such that it includes the new keywords.
+Construct the file name in accordance with the user option
+`denote-file-name-components-order'.
+
Run the `denote-after-rename-file-hook' after renaming is done.
Also see the specialized commands to only add or remove keywords:
@@ -3195,7 +3201,10 @@ The values of `denote-rename-confirmations' and
The identifier of the file, if any, is never modified even if it
is edited in the front matter: Denote considers the file name to
be the source of truth in this case, to avoid potential breakage
-with typos and the like."
+with typos and the like.
+
+Construct the file name in accordance with the user option
+`denote-file-name-components-order'."
(interactive (list buffer-file-name))
(unless (denote-file-is-writable-and-supported-p file)
(user-error "The file is not writable or does not have a supported file
extension"))
@@ -3303,7 +3312,10 @@ As a final step, ask for confirmation, showing the
difference
between old and new file names.
Important note: No attempt is made to modify any other elements
-of the file. This needs to be done manually."
+of the file. This needs to be done manually.
+
+Construct the file name in accordance with the user option
+`denote-file-name-components-order'."
(interactive
(list
(denote--rename-dired-file-or-current-file-or-prompt)
