branch: externals/denote
commit 04a09aff1964b01f671869a16b8bc8f6281e0f24
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Update the denote-prompts documentation to better describe signatures
---
README.org | 18 +++++++---------
denote.el | 71 ++++++++++++++++++++++++++++++--------------------------------
2 files changed, 42 insertions(+), 47 deletions(-)
diff --git a/README.org b/README.org
index 53507681ee..08d87764a3 100644
--- a/README.org
+++ b/README.org
@@ -262,16 +262,14 @@ of the following:
of that KEY is used to populate the new note with content, which is
added after the front matter ([[#h:f635a490-d29e-4608-9372-7bd13b34d56c][The
denote-templates option]]).
-- =signature=: - Prompts for an arbitrary string that can be used to
- establish a sequential relationship between files (e.g. 1, 1a, 1b,
- 1b1, 1b2, ...). Signatures have no strictly defined function and
- are up to the user to apply as they see fit. One use-case is to
- implement Niklas Luhmann's Zettelkasten system for a sequence of
- notes (Folgezettel). Signatures are not included in a file's front
- matter. They are reserved solely for creating a sequence in a file
- listing, at least for the time being. To insert a link that
- includes the signature, use the command ~denote-link-with-signature~
- ([[#h:066e5221-9844-474b-8858-398398646f86][Insert link to file with
signature]]).
+- =signature=: - Prompts for an arbitrary string that can be used for
+ any kind of workflow, such as a special tag to label the =part1= and
+ =part2= of a large file that is split in half, or to add special
+ contexts like =home= and =work=, or even priorities like =a=, =b=,
+ =c=. One other use-case is to implement a sequencing scheme that
+ makes notes have hierarchical relationships. This is handled by our
+ optional extension =denote-sequence.el=, which is part of the
+ ~denote~ package ([[#h:d5ca722d-e7fa-46fa-9a57-6363b1d4186f][Write sequence
notes or "folgezettel"]]).
The prompts occur in the given order.
diff --git a/denote.el b/denote.el
index 00adfe33ee..c20f430694 100644
--- a/denote.el
+++ b/denote.el
@@ -248,45 +248,42 @@ of the following:
- `title': Prompt for the title of the new note.
-- `keywords': Prompts with completion for the keywords of the new
- note. Available candidates are those specified in the user
- option `denote-known-keywords'. If the user option
- `denote-infer-keywords' is non-nil, keywords in existing note
- file names are included in the list of candidates. The
- `keywords' prompt uses `completing-read-multiple', meaning that
- it can accept multiple keywords separated by a comma (or
+- `keywords': Prompts with completion for the keywords of the new note.
+ Available candidates are those specified in the user option
+ `denote-known-keywords'. If the user option `denote-infer-keywords'
+ is non-nil, keywords in existing note file names are included in the
+ list of candidates. The `keywords' prompt uses `completing-read-multiple',
+ meaning that it can accept multiple keywords separated by a comma (or
whatever the value of `crm-separator' is).
-- `file-type': Prompts with completion for the file type of the
- new note. Available candidates are those specified in the user
- option `denote-file-type'. Without this prompt, `denote' uses
- the value of the variable `denote-file-type'.
-
-- `subdirectory': Prompts with completion for a subdirectory in
- which to create the note. Available candidates are the value
- of the user option `denote-directory' and all of its
- subdirectories. Any subdirectory must already exist: Denote
- will not create it.
-
-- `date': Prompts for the date of the new note. It will expect
- an input like 2022-06-16 or a date plus time: 2022-06-16 14:30.
- Without the `date' prompt, the `denote' command uses the
- `current-time'. (To leverage the more sophisticated Org
- method, see the `denote-date-prompt-use-org-read-date'.)
-
-- `template': Prompts for a KEY among `denote-templates'. The
- value of that KEY is used to populate the new note with
- content, which is added after the front matter.
-
-- `signature': Prompts for an arbitrary string that can be used
- to qualify the note according to the user's methodology.
- Signatures have no strictly defined function and are up to the
- user to apply as they see fit. One use-case is to implement
- Niklas Luhmann's Zettelkasten system for a sequence of notes
- (Folgezettel). Signatures are not included in a file's front
- matter. They are reserved solely for creating a structure in a
- file listing. To insert a link that includes the signature,
- use the command `denote-link-with-signature'.
+- `file-type': Prompts with completion for the file type of the new
+ note. Available candidates are those specified in the user option
+ `denote-file-type'. Without this prompt, `denote' uses the value of
+ the variable `denote-file-type'.
+
+- `subdirectory': Prompts with completion for a subdirectory in which to
+ create the note. Available candidates are the value of the user
+ option `denote-directory' and all of its subdirectories. Any
+ subdirectory must already exist: Denote will not create it.
+
+- `date': Prompts for the date of the new note. It will expect an input
+ like 2022-06-16 or a date plus time: 2022-06-16 14:30. Without the
+ `date' prompt, the `denote' command uses the `current-time'. (To
+ leverage the more sophisticated Org method, see the
+ `denote-date-prompt-use-org-read-date'.)
+
+- `template': Prompts for a KEY among `denote-templates'. The value of
+ that KEY is used to populate the new note with content, which is added
+ after the front matter.
+
+- `signature': Prompts for an arbitrary string that can be used for any
+ kind of workflow, such as a special tag to label the part1 and part2
+ of a large file that is split in half, or to add special contexts like
+ home and work, or even priorities like a, b, c. One other use-case is
+ to implement a sequencing scheme that makes notes have hierarchical
+ relationships. This is handled by our optional extension
+ denote-sequence.el, which is part of the denote package (read the
+ manual).
The prompts occur in the given order.
