branch: externals/denote
commit 4af8a8faa718116b3ff8ef6fed25633ae5da4ebd
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Clarify wording about how multi-word keywords are handled
In short, you have to follow some convention that control the letter
casing of individual words to make them readable, while keeping them
part of the same keyword. Using the new user option we provide:
(setq denote-file-name-letter-casing
'((title . downcase)
(signature . downcase)
(keywords . verbatim) ; notice the `verbatim' here
(t . downcase)))
With this in place, typing something like 'camelCase' at the keywords
prompt will insert that as-is and treat as a single keyword.
I am clarifying the documentation here as part of the process of
introducing the new 'denote-file-name-letter-casing' option. I do it
in response to the question raised by Peter Smith in issue 184 on the
GitHub mirror: <https://github.com/protesilaos/denote/issues/184>.
---
README.org | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index 8f9d47fe91..e3bf78d6e4 100644
--- a/README.org
+++ b/README.org
@@ -1430,14 +1430,19 @@ holds the relevant value. In simple terms:
+ Input for a file title is hyphenated. The original value is
preserved in the note's contents
([[#h:13218826-56a5-482a-9b91-5b6de4f14261][Front matter]]).
-+ Keywords should not have spaces or other delimiters. If they do, they
- are converted into hyphens.
++ Keywords should not have spaces or other delimiters. If they do,
+ they are removed, meaning that =hello-world= becomes =helloworld=.
+ This is because hyphens in keywords do not work everywhere, such as
+ in Org.
+ Signatures are like the above, but use the equals sign instead of
hyphens.
All file name components are downcases by default, though users can
configure this behaviour ([[#h:6ae1ab8c-5e36-4216-8e93-f37f4447582c][Contol
the letter casing of file names]]).
+Consider a =helloWorld= or =HelloWorld= convention for those cases
+where you would want to have a hyphen between consistuent words of a
+keyword.
** Contol the letter casing of file names
:PROPERTIES:
