[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 3d4891b5dd 06/20: Rename denote-retrieve-title-*
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 3d4891b5dd 06/20: Rename denote-retrieve-title-* and denote-retrieve-keywords-* functions |
Date: |
Wed, 20 Dec 2023 03:58:01 -0500 (EST) |
branch: externals/denote
commit 3d4891b5dd7b19230e8ad26858e8bb1ebd09929a
Author: Jean-Philippe Gagné Guay <jeanphilippe150@gmail.com>
Commit: Jean-Philippe Gagné Guay <jeanphilippe150@gmail.com>
Rename denote-retrieve-title-* and denote-retrieve-keywords-* functions
---
README.org | 24 ++++++++++-----------
denote-rename-buffer.el | 4 ++--
denote.el | 56 +++++++++++++++++++++++++++++++++----------------
3 files changed, 52 insertions(+), 32 deletions(-)
diff --git a/README.org b/README.org
index f121c25bf8..b988818a91 100644
--- a/README.org
+++ b/README.org
@@ -3957,30 +3957,30 @@ might change them without further notice.
To only return an existing identifier, refer to the function
~denote-retrieve-filename-identifier~.
-#+findex: denote-retrieve-title-value
-+ Function ~denote-retrieve-title-value~ :: Return title value from
+#+findex: denote-retrieve-front-matter-title-value
++ Function ~denote-retrieve-front-matter-title-value~ :: Return title value
from
=FILE= front matter per =FILE-TYPE=.
-#+findex: denote-retrieve-title-line
-+ Function ~denote-retrieve-title-line~ :: Return title line from
+#+findex: denote-retrieve-front-matter-title-line
++ Function ~denote-retrieve-front-matter-title-line~ :: Return title line from
=FILE= front matter per =FILE-TYPE=.
-#+findex: denote-retrieve-keywords-value
-+ Function ~denote-retrieve-keywords-value~ :: Return keywords value
+#+findex: denote-retrieve-front-matter-keywords-value
++ Function ~denote-retrieve-front-matter-keywords-value~ :: Return keywords
value
from =FILE= front matter per =FILE-TYPE=. The return value is a list
of strings. To get a combined string the way it would appear in a
- Denote file name, use ~denote-retrieve-keywords-value-as-string~.
+ Denote file name, use
~denote-retrieve-front-matter-keywords-value-as-string~.
-#+findex: denote-retrieve-keywords-value-as-string
-+ Function ~denote-retrieve-keywords-value-as-string~ :: Return
+#+findex: denote-retrieve-front-matter-keywords-value-as-string
++ Function ~denote-retrieve-front-matter-keywords-value-as-string~ :: Return
keywords value from =FILE= front matter per =FILE-TYPE=. The return
value is a string, with the underscrore as a separator between
individual keywords. To get a list of strings instead, use
- ~denote-retrieve-keywords-value~ (the current function uses that
+ ~denote-retrieve-front-matter-keywords-value~ (the current function uses that
internally).
-#+findex: denote-retrieve-keywords-line
-+ Function ~denote-retrieve-keywords-line~ :: Return keywords line
+#+findex: denote-retrieve-front-matter-keywords-line
++ Function ~denote-retrieve-front-matter-keywords-line~ :: Return keywords line
from =FILE= front matter per =FILE-TYPE=.
#+findex: denote-signature-prompt
diff --git a/denote-rename-buffer.el b/denote-rename-buffer.el
index 2d52ac538f..352bfb73fa 100644
--- a/denote-rename-buffer.el
+++ b/denote-rename-buffer.el
@@ -94,11 +94,11 @@ buffer will be used, if available."
(type (denote-filetype-heuristics file)))
(string-trim
(format-spec denote-rename-buffer-format
- (list (cons ?t (or (denote-retrieve-title-value file type)
""))
+ (list (cons ?t (or (denote-retrieve-front-matter-title-value
file type) ""))
(cons ?i (or (denote-retrieve-filename-identifier
file) ""))
(cons ?d (or (denote-retrieve-filename-identifier
file) ""))
(cons ?s (or (denote-retrieve-filename-signature file)
""))
- (cons ?k (or (denote-retrieve-keywords-value-as-string
file type) ""))
+ (cons ?k (or
(denote-retrieve-front-matter-keywords-value-as-string file type) ""))
(cons ?% "%"))
'delete))))
diff --git a/denote.el b/denote.el
index c5ba74f11e..de4b233e38 100644
--- a/denote.el
+++ b/denote.el
@@ -1462,47 +1462,67 @@ Subroutine of `denote--file-with-temp-buffer'."
(goto-char (point-min))
,@body)))
-(defun denote-retrieve-title-value (file file-type)
+(defun denote-retrieve-front-matter-title-value (file file-type)
"Return title value from FILE front matter per FILE-TYPE."
(denote--file-with-temp-buffer file
(when (re-search-forward (denote--title-key-regexp file-type) nil t 1)
(funcall (denote--title-value-reverse-function file-type)
(buffer-substring-no-properties (point) (line-end-position))))))
-(defun denote-retrieve-title-line (file file-type)
+(defun denote-retrieve-front-matter-title-line (file file-type)
"Return title line from FILE front matter per FILE-TYPE."
(denote--file-with-temp-buffer file
(when (re-search-forward (denote--title-key-regexp file-type) nil t 1)
(buffer-substring-no-properties (line-beginning-position)
(line-end-position)))))
-(defun denote-retrieve-keywords-value (file file-type)
+(defun denote-retrieve-front-matter-keywords-value (file file-type)
"Return keywords value from FILE front matter per FILE-TYPE.
The return value is a list of strings. To get a combined string
the way it would appear in a Denote file name, use
-`denote-retrieve-keywords-value-as-string'."
+`denote-retrieve-front-matter-keywords-value-as-string'."
(denote--file-with-temp-buffer file
(when (re-search-forward (denote--keywords-key-regexp file-type) nil t 1)
(funcall (denote--keywords-value-reverse-function file-type)
(buffer-substring-no-properties (point) (line-end-position))))))
-(defun denote-retrieve-keywords-value-as-string (file file-type)
+(defun denote-retrieve-front-matter-keywords-value-as-string (file file-type)
"Return keywords value from FILE front matter per FILE-TYPE.
The return value is a string, with the underscrore as a separator
between individual keywords. To get a list of strings instead,
-use `denote-retrieve-keywords-value' (the current function uses
+use `denote-retrieve-front-matter-keywords-value' (the current function uses
that internally)."
- (denote-keywords-combine (denote-retrieve-keywords-value file file-type)))
+ (denote-keywords-combine (denote-retrieve-front-matter-keywords-value file
file-type)))
-(defun denote-retrieve-keywords-line (file file-type)
+(defun denote-retrieve-front-matter-keywords-line (file file-type)
"Return keywords line from FILE front matter per FILE-TYPE."
(denote--file-with-temp-buffer file
(when (re-search-forward (denote--keywords-key-regexp file-type) nil t 1)
(buffer-substring-no-properties (line-beginning-position)
(line-end-position)))))
+(make-obsolete
+ 'denote-retrieve-title-value
+ 'denote-retrieve-front-matter-title-value
+ "2.3.0")
+
+(make-obsolete
+ 'denote-retrieve-title-line
+ 'denote-retrieve-front-matter-title-line
+ "2.3.0")
+
+(make-obsolete
+ 'denote-retrieve-keywords-value
+ 'denote-retrieve-front-matter-keywords-value
+ "2.3.0")
+
+(make-obsolete
+ 'denote-retrieve-keywords-line
+ 'denote-retrieve-front-matter-keywords-line
+ "2.3.0")
+
(defun denote--retrieve-title-or-filename (file type)
"Return appropriate title for FILE given its TYPE."
(if-let (((denote-file-is-note-p file))
- (title (denote-retrieve-title-value file type))
+ (title (denote-retrieve-front-matter-title-value file type))
((not (string-blank-p title))))
title
(if-let ((title (denote-retrieve-filename-title file)))
@@ -2146,7 +2166,7 @@ the new front matter, per
`denote-rename-file-using-front-matter'."
(if-let ((file (buffer-file-name))
((denote-file-is-note-p file))
(file-type (denote-filetype-heuristics file)))
- (let* ((cur-keywords (denote-retrieve-keywords-value file file-type))
+ (let* ((cur-keywords (denote-retrieve-front-matter-keywords-value file
file-type))
(new-keywords (denote-keywords-sort
(seq-uniq (append keywords cur-keywords)))))
(denote-rewrite-keywords file new-keywords file-type)
@@ -2175,7 +2195,7 @@ the new front matter, per
`denote-rename-file-using-front-matter'."
(if-let ((file (buffer-file-name))
((denote-file-is-note-p file))
(file-type (denote-filetype-heuristics file)))
- (when-let ((cur-keywords (denote-retrieve-keywords-value file file-type))
+ (when-let ((cur-keywords (denote-retrieve-front-matter-keywords-value
file file-type))
(del-keyword (denote--keywords-delete-prompt cur-keywords)))
(denote-rewrite-keywords
file
@@ -2332,8 +2352,8 @@ values if appropriate.
With optional NO-CONFIRM, do not prompt to confirm the rewriting
of the front matter. Otherwise produce a `y-or-n-p' prompt to
that effect."
- (when-let ((old-title-line (denote-retrieve-title-line file file-type))
- (old-keywords-line (denote-retrieve-keywords-line file file-type))
+ (when-let ((old-title-line (denote-retrieve-front-matter-title-line file
file-type))
+ (old-keywords-line (denote-retrieve-front-matter-keywords-line
file file-type))
(new-title-line (denote--get-title-line-from-front-matter title
file-type))
(new-keywords-line (denote--get-keywords-line-from-front-matter
keywords file-type)))
(with-current-buffer (find-file-noselect file)
@@ -2503,7 +2523,7 @@ file-naming scheme."
(extension (denote-get-file-extension file))
(file-type (denote-filetype-heuristics file))
(title (or title (denote--retrieve-title-or-filename file file-type)))
- (keywords (or keywords (denote-retrieve-keywords-value file
file-type)))
+ (keywords (or keywords (denote-retrieve-front-matter-keywords-value
file file-type)))
(signature (or signature (denote-retrieve-filename-signature file)
""))
(new-name (denote-format-file-name dir id keywords (denote-sluggify
title 'title) extension (denote-sluggify-signature signature)))
(max-mini-window-height denote-rename-max-mini-window-height))
@@ -2638,10 +2658,10 @@ does internally."
(unless (denote-file-is-writable-and-supported-p file)
(user-error "The file is not writable or does not have a supported file
extension"))
(if-let ((file-type (denote-filetype-heuristics file))
- (title (denote-retrieve-title-value file file-type))
+ (title (denote-retrieve-front-matter-title-value file file-type))
(id (denote-retrieve-filename-identifier file)))
(let* ((sluggified-title (denote-sluggify title 'title))
- (keywords (denote-retrieve-keywords-value file file-type))
+ (keywords (denote-retrieve-front-matter-keywords-value file
file-type))
(signature (or (denote-retrieve-filename-signature file) ""))
(extension (denote-get-file-extension file))
(dir (file-name-directory file))
@@ -2748,7 +2768,7 @@ of the file. This needs to be done manually."
(old-file-type (denote-filetype-heuristics file))
(id (or (denote-retrieve-filename-identifier file) ""))
(title (denote--retrieve-title-or-filename file old-file-type))
- (keywords (denote-retrieve-keywords-value file old-file-type))
+ (keywords (denote-retrieve-front-matter-keywords-value file
old-file-type))
(signature (or (denote-retrieve-filename-signature file) ""))
(old-extension (denote-get-file-extension file))
(new-extension (denote--file-extension new-file-type))
@@ -3514,7 +3534,7 @@ ALIST is not used in favour of using
(setq overlay-arrow-position nil)
(denote-backlinks-mode)
(goto-char (point-min))
- (when-let ((title (denote-retrieve-title-value file file-type))
+ (when-let ((title (denote-retrieve-front-matter-title-value file
file-type))
(heading (format "Backlinks to %S (%s)" title id))
(l (length heading)))
(insert (format "%s\n%s\n\n" heading (make-string l ?-))))
- [elpa] externals/denote 7ca08f2a66 07/20: Refactor denote-org-capture and remove denote-org-capture-with-prompts, (continued)
- [elpa] externals/denote 7ca08f2a66 07/20: Refactor denote-org-capture and remove denote-org-capture-with-prompts, ELPA Syncer, 2023/12/20
- [elpa] externals/denote f0910d3146 13/20: Add denote-menu-bar-mode, making the Denote menu bar optional, ELPA Syncer, 2023/12/20
- [elpa] externals/denote 6e5ddc2623 01/20: Refactor denote-file-has-identifier-p and use it in various functions, ELPA Syncer, 2023/12/20
- [elpa] externals/denote faaf5f94ab 03/20: Use denote-rename-max-mini-window-height in denote-change-file-type-and-front-matter, ELPA Syncer, 2023/12/20
- [elpa] externals/denote e6b7ba74e6 05/20: Make denote-retrieve-filename-identifier consistent with other functions, ELPA Syncer, 2023/12/20
- [elpa] externals/denote f1730b7798 17/20: Acknowledge Ashton Wiersdorf for commit e2ba6c1, ELPA Syncer, 2023/12/20
- [elpa] externals/denote f26d8d7799 08/20: Handle nil case in denote-sort--define-lessp, ELPA Syncer, 2023/12/20
- [elpa] externals/denote 4899ca5c78 09/20: Remove separator for the last file in denote-org-dblock-add-files, ELPA Syncer, 2023/12/20
- [elpa] externals/denote 6acb25c7ec 10/20: Create aliases for denote-retrieve-front-matter-* functions, ELPA Syncer, 2023/12/20
- [elpa] externals/denote 195f0c3b7f 14/20: Acknowledge Joseph Turner for commits 4261d19, f0910d3, ELPA Syncer, 2023/12/20
- [elpa] externals/denote 3d4891b5dd 06/20: Rename denote-retrieve-title-* and denote-retrieve-keywords-* functions,
ELPA Syncer <=
- [elpa] externals/denote e2ba6c144d 16/20: Guard sorting keywords when given an empty string, ELPA Syncer, 2023/12/20
- [elpa] externals/denote ee58ae014d 20/20: Merge pull request #199 from jeanphilippegg/refactor, ELPA Syncer, 2023/12/20
- [elpa] externals/denote 2b627aaafd 11/20: Add denote-org-capture-with-prompts, ELPA Syncer, 2023/12/20