branch: externals/denote
commit bb8af7362c8602efedc784c232f7aa925cf478d0
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Document 'denote-prompts' signature in the manual
---
README.org | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index 0ea8575ddc..34e0e42153 100644
--- a/README.org
+++ b/README.org
@@ -242,6 +242,16 @@ The value is a list of symbols, which includes any 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 and are not shown in the description of a link. They are
+ reserved solely for creating a sequence in a file listing, at least
+ for the time being. [Part of {{{development-version}}}.]
+
The prompts occur in the given order.
If the value of this user option is nil, no prompts are used. The
@@ -267,8 +277,9 @@ Finally, this user option only affects the interactive use
of the
~denote~ command (advanced users can call it from Lisp). For ad-hoc
interactive actions that do not change the default behaviour of the
~denote~ command, users can invoke these convenience commands:
-~denote-type~, ~denote-subdirectory~, ~denote-date~. They are described
-in the subsequent section
([[#h:887bdced-9686-4e80-906f-789e407f2e8f][Convenience commands for note
creation]]).
+~denote-type~, ~denote-subdirectory~, ~denote-date~,
+~denote-signature~. They are described in the subsequent section
+([[#h:887bdced-9686-4e80-906f-789e407f2e8f][Convenience commands for note
creation]]).
*** The ~denote-templates~ option
:PROPERTIES:
