branch: externals/denote
commit f8ea03abfb62a793fc008de28c368e7203d4f2eb
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Add documentation about renaming non-notes
---
README.org | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/README.org b/README.org
index 36d7a4135a..fa698d0d5f 100644
--- a/README.org
+++ b/README.org
@@ -259,6 +259,30 @@ for the notes Denote produces).
For the time being, the =diredfl= package is not compatible with this
facility.
+* Renaming non-notes
+:PROPERTIES:
+:CUSTOM_ID: h:532e8e2a-9b7d-41c0-8f4b-3c5cbb7d4dca
+:END:
+
+#+findex: denote-dired-rename-file
+Denote's file-naming scheme is not specific to notes or text files: it
+is useful for all sorts of files, such as multimedia and PDFs that form
+part of the user's longer-term storage
([[#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d][The file-naming scheme]]). While
+Denote does not manage such files, it already has all the mechanisms to
+facilitate the task of renaming them.
+
+To this end, invoke ~denote-dired-rename-file~ when point is over a file
+in Dired to rename it. The commaand prompts for a =TITLE= and
+=KEYWORDS= the same way the ~denote~ command does it
([[#h:17896c8c-d97a-4faa-abf6-31df99746ca6][Points of entry]]).
+It finally asks for confirmation before renaming the file at point.
+
+The file type extension (e.g. =.pdf=) is read from the underlying file
+and is preserved in the renaming process. Files that have no extension
+are simply left without one.
+
+Renaming only occurs relative to the current directory. Files are not
+moved between directories.
+
* Extending Denote
:PROPERTIES:
:CUSTOM_ID: h:8ed2bb6f-b5be-4711-82e9-8bee5bb06ece
