[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 8d489a33fe 6/7: BREAKING: Deprecate denote-allow
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 8d489a33fe 6/7: BREAKING: Deprecate denote-allow-multi-word-keywords; use denote-file-name-letter-casing |
Date: |
Fri, 13 Oct 2023 06:57:55 -0400 (EDT) |
branch: externals/denote
commit 8d489a33fea1bfa8a439886893eb2244f2ccf1e1
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
BREAKING: Deprecate denote-allow-multi-word-keywords; use
denote-file-name-letter-casing
---
README.org | 25 ++++++++-----------------
denote.el | 33 +++++++--------------------------
2 files changed, 15 insertions(+), 43 deletions(-)
diff --git a/README.org b/README.org
index 447d513beb..2c860a57db 100644
--- a/README.org
+++ b/README.org
@@ -1321,18 +1321,14 @@ underscore (the separator is inserted automatically).
Each keyword is
a string provided by the user at the relevant prompt which broadly
describes the contents of the entry.
-#+vindex: denote-allow-multi-word-keywords
-Optionally, when the user option ~denote-allow-multi-word-keywords~ is
-non-nil, keywords that need to be more than one-word-long are written
-with hyphens: any other character, such as spaces or the plus sign is
-automatically converted into a hyphen. So when =emacs_library=
-appears in a file name, it is interpreted as two distinct keywords,
-whereas =emacs-library= is one keyword. This is reflected in how the
-keywords are recorded in the note
([[#h:13218826-56a5-482a-9b91-5b6de4f14261][Front matter]]). While Denote
-optional supports multi-word keywords, default ~nil~ value of
-~denote-allow-multi-word-keywords~ forcibly joins all words into one,
-meaning that an input of =word1 word2= will be written as
-=word1word2=.
+Each of the keywords is a single word, with multiple keywords
+providing the multi-dimensionality needed for advanced searches
+through Denote files. Users who need to compose a keyword out of
+multiple words are encouraged to apply a letter casing convention such
+as camelCase/CamelCase and set the ~denote-file-name-letter-casing~
+user option accordingly ([[#h:6ae1ab8c-5e36-4216-8e93-f37f4447582c][Contol the
letter casing of file names]]).
+[ The ~denote-allow-multi-word-keywords~ is obsolete as part of
+ {{{development-version}}}. ]
#+vindex: denote-file-type
The =EXTENSION= is the file type. By default, it is =.org= (~org-mode~)
@@ -3403,11 +3399,6 @@ Everything is in place to set up the package.
;; include an example here to avoid potential confusion.
-;; We do not allow multi-word keywords by default. The author's
-;; personal preference is for single-word keywords for a more rigid
-;; workflow.
-(setq denote-allow-multi-word-keywords t)
-
(setq denote-date-format nil) ; read doc string
;; By default, we do not show the context of links. We just display
diff --git a/denote.el b/denote.el
index 77648e7a66..45863a5008 100644
--- a/denote.el
+++ b/denote.el
@@ -153,8 +153,8 @@ directory and also checks if a safe local value should be
used."
(defcustom denote-known-keywords
'("emacs" "philosophy" "politics" "economics")
"List of strings with predefined keywords for `denote'.
-Also see user options: `denote-allow-multi-word-keywords',
-`denote-infer-keywords', `denote-sort-keywords'."
+Also see user options: `denote-infer-keywords',
+`denote-sort-keywords', `denote-file-name-letter-casing'."
:group 'denote
:package-version '(denote . "0.1.0")
:type '(repeat string))
@@ -293,24 +293,10 @@ If nil, show the keywords in their given order."
:package-version '(denote . "0.1.0")
:type 'boolean)
-(defcustom denote-allow-multi-word-keywords nil
- "If non-nil keywords can consist of multiple words.
-Words are automatically separated by a hyphen when using the
-`denote' command or related. The hyphen is the only legal
-character---no spaces, no other characters. If, for example, the
-user types <word1_word2> or <word1 word2>, it is converted to
-<word1-word2>.
-
-When nil (the default), do not allow keywords to consist of
-multiple words. Reduce them to a single word, such as by turning
-<word1_word2> or <word1 word2> into <word1word2>.
-
-[ The author of Denote encourages you to use single words for
- keywords and, if needed, rely on multiple separate keywords to
- derive meaning.]"
- :group 'denote
- :package-version '(denote . "2.0.0")
- :type 'boolean)
+(make-obsolete
+ 'denote-allow-multi-word-keywords
+ 'denote-file-name-letter-casing
+ "2.1.0")
(defcustom denote-file-type nil
"The file type extension for new notes.
@@ -684,12 +670,7 @@ A nil value of COMPONENT has the same meaning as applying
(defun denote-sluggify-keywords (keywords)
"Sluggify KEYWORDS, which is a list of strings."
(if (listp keywords)
- ;; FIXME 2023-10-09: What to do with `denote-allow-multi-word-keywords
- (mapcar
- (if denote-allow-multi-word-keywords
- #'denote-sluggify
- #'denote-sluggify-and-join)
- keywords)
+ (mapcar #'denote-sluggify-and-join keywords)
(error "`%s' is not a list" keywords)))
;; TODO 2023-05-22: Review name of `denote-desluggify' to signify what
- [elpa] externals/denote updated (a820e94081 -> b954ade554), ELPA Syncer, 2023/10/13
- [elpa] externals/denote 33afae3d87 2/7: Fix version number in two obsolete calls, ELPA Syncer, 2023/10/13
- [elpa] externals/denote b954ade554 7/7: Fix typo in the manual, ELPA Syncer, 2023/10/13
- [elpa] externals/denote 4026e574eb 1/7: REMOVE deprecation notices that were about older Denote versions, ELPA Syncer, 2023/10/13
- [elpa] externals/denote 2b1e19ad22 5/7: Move denote-file-name-letter-casing further up and add :info link, ELPA Syncer, 2023/10/13
- [elpa] externals/denote eba5cd4c35 3/7: Make denote-commands-for-new-notes a user option, ELPA Syncer, 2023/10/13
- [elpa] externals/denote 86493c565e 4/7: Add :info link to denote-region-after-new-note-functions, ELPA Syncer, 2023/10/13
- [elpa] externals/denote 8d489a33fe 6/7: BREAKING: Deprecate denote-allow-multi-word-keywords; use denote-file-name-letter-casing,
ELPA Syncer <=