[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote b054600d84 2/8: BREAKING: change default value o
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote b054600d84 2/8: BREAKING: change default value of 'denote-allow-multi-word-keywords' |
Date: |
Mon, 22 May 2023 15:57:58 -0400 (EDT) |
branch: externals/denote
commit b054600d842554754be0af1fbd25f16ec619e707
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
BREAKING: change default value of 'denote-allow-multi-word-keywords'
---
README.org | 41 ++++++++++++++++++++++++-----------------
denote.el | 14 +++++++++-----
2 files changed, 33 insertions(+), 22 deletions(-)
diff --git a/README.org b/README.org
index 7828c9c76f..d091ddcecc 100644
--- a/README.org
+++ b/README.org
@@ -1193,20 +1193,26 @@ automatically gets downcased and hyphenated. An entry
about "Economics
in the Euro Area" produces an =economics-in-the-euro-area= string for
the =TITLE= of the file name.
-#+vindex: denote-allow-multi-word-keywords
The =KEYWORDS= field consists of one or more entries demarcated by an
-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. Keywords that need to be more than
-one-word-long must be 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 supports multi-word keywords by default, the user option
-~denote-allow-multi-word-keywords~ can be set to nil to forcibly join
-all words into one, meaning that an input of =word1 word2= will be
-written as =word1word2=.
+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.
+
+[ The ~denote-allow-multi-word-keywords~ has a ~nil~ value as part of
+ {{{development-version}}}. ]
+
+#+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=.
#+vindex: denote-file-type
The =EXTENSION= is the file type. By default, it is =.org= (~org-mode~)
@@ -1324,8 +1330,8 @@ each other by virtue of their signature.
Users can get a lot of value out of this simple yet effective
arrangement, even if they have no knowledge of regular expressions.
One thing to consider, for maximum effect, is to avoid using
-multi-word keywords as those get hyphenated like the title and will
-thus interfere with the above: either set the user option
+multi-word keywords as those can get hyphenated like the title and
+will thus interfere with the above: either set the user option
~denote-allow-multi-word-keywords~ to nil or simply insert single
words at the relevant prompts.
@@ -3086,8 +3092,9 @@ Everything is in place to set up the package.
;; include an example here to avoid potential confusion.
-;; We allow multi-word keywords by default. The author's personal
-;; preference is for single-word keywords for a more rigid workflow.
+;; 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
diff --git a/denote.el b/denote.el
index 9b73af441d..e4b560e0d3 100644
--- a/denote.el
+++ b/denote.el
@@ -291,7 +291,7 @@ If nil, show the keywords in their given order."
:package-version '(denote . "0.1.0")
:type 'boolean)
-(defcustom denote-allow-multi-word-keywords t
+(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
@@ -299,11 +299,15 @@ 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, 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>."
+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 . "0.1.0")
+ :package-version '(denote . "2.0.0")
:type 'boolean)
(defcustom denote-file-type nil
- [elpa] externals/denote updated (4b3ba57386 -> 73dfc1f1bc), ELPA Syncer, 2023/05/22
- [elpa] externals/denote 6837f8df06 1/8: Make the creation of 'denote-directory' its own function, ELPA Syncer, 2023/05/22
- [elpa] externals/denote b054600d84 2/8: BREAKING: change default value of 'denote-allow-multi-word-keywords',
ELPA Syncer <=
- [elpa] externals/denote 5dc40e40e4 5/8: Fix typo in doc string, ELPA Syncer, 2023/05/22
- [elpa] externals/denote 583e567f65 4/8: Throw an error if denote-sluggify-keywords does not get a list of strings, ELPA Syncer, 2023/05/22
- [elpa] externals/denote 6f99ba8ab5 6/8: Revise docs of two deprecations to mention current development release version, ELPA Syncer, 2023/05/22
- [elpa] externals/denote 2c377d4af8 3/8: Clarify 'denote--slug-no-punct' doc string, ELPA Syncer, 2023/05/22
- [elpa] externals/denote af2f2c0831 7/8: Clarify doc string of 'denote-desluggify'; add TODO for more, ELPA Syncer, 2023/05/22
- [elpa] externals/denote 73dfc1f1bc 8/8: Write some unit tests (WORK-IN-PROGRESS), ELPA Syncer, 2023/05/22