[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 258ddc7b2c 02/39: Update denote-prompts doc stri
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 258ddc7b2c 02/39: Update denote-prompts doc string |
Date: |
Mon, 11 Jul 2022 00:57:40 -0400 (EDT) |
branch: externals/denote
commit 258ddc7b2ca8278c873fdf4bb7c160de3c2d536e
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Update denote-prompts doc string
---
denote.el | 42 +++++++++++++++++++++++++++++++++---------
1 file changed, 33 insertions(+), 9 deletions(-)
diff --git a/denote.el b/denote.el
index 34516da8cc..36521572ea 100644
--- a/denote.el
+++ b/denote.el
@@ -165,15 +165,39 @@ the appropriate list of strings."
(defcustom denote-prompts '(title keywords)
"Specify the prompts of the `denote' command.
-Valid values are:
- date: The date of the note.
- file-type: The filetype of the note (md, txt, org).
- subdirectory: The subdirectory in which to create the note.
- title: The title of the note. If unspecified, the title is
- \"unspecified\".
- keywords: The keywords of the note.
-
-The prompts will happen in the given order."
+The value is a list of symbols, which includes any of the following:
+
+- `title': Prompt for the title of the new note. If unspecified, the
+ title is the \"unspecified\" string.
+
+- `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-sepator' is).
+
+- `date': Prompts for the date of the new note. It will expect a
+ date 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'.
+
+- `file-type': Prompts with completion for the filetype of the
+ new note. Available candidates are those specified in the user
+ option `denote-file-type'. Without this prompt `denote' uses
+ the value of `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 (except .git).
+
+The prompts will happen in the given order.
+
+If the value of this user option is nil, the `title' and
+`keywords' are used."
:group 'denote
:type '(repeat symbol))
- [elpa] externals/denote 218f7132bf 15/39: Remove private denote--prompts function, (continued)
- [elpa] externals/denote 218f7132bf 15/39: Remove private denote--prompts function, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 10e815c3fe 17/39: Refine denote-prompts Custom UI type, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 92e15886d5 20/39: Avoid errors with string value for keywords, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 5761ec5f89 34/39: BREAKING update journal samples for current 'denote', ELPA Syncer, 2022/07/11
- [elpa] externals/denote b05ea22a11 05/39: Add private function to normalise denote-prompts, ELPA Syncer, 2022/07/11
- [elpa] externals/denote d8ae24a80f 13/39: Merge branch 'main' into refactor-denote-prompts, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 8ea2a7b65d 30/39: Tweak denote-prompts doc string, ELPA Syncer, 2022/07/11
- [elpa] externals/denote d1a3fe3989 31/39: Revise manual on note creation; add denote-prompts, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 2c0727eb37 32/39: Add :link to manual in 'denote-prompts' definition, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 9cdd77d425 10/39: Add TODO for 'denote' command Lisp arguments, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 258ddc7b2c 02/39: Update denote-prompts doc string,
ELPA Syncer <=
- [elpa] externals/denote 0326ab3d75 04/39: Add TODO for denote-prompts value, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 05e70d4e5c 11/39: Update doc strings of convenience commands, ELPA Syncer, 2022/07/11
- [elpa] externals/denote c2c0d74dc1 16/39: Fix typo in denote-prompts doc string, ELPA Syncer, 2022/07/11
- [elpa] externals/denote c56ddd3fb9 19/39: Update doc string of 'denote' command, ELPA Syncer, 2022/07/11
- [elpa] externals/denote a283cc1139 21/39: Revert "Avoid errors with string value for keywords", ELPA Syncer, 2022/07/11
- [elpa] externals/denote 4cae3d4262 24/39: Rename args in 'denote' for consistency, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 23cebf0fe5 26/39: Simplify 'denote' doc string about TITLE arg, ELPA Syncer, 2022/07/11
- [elpa] externals/denote 840ffc522f 27/39: Reword and expand doc string of 'denote-prompts', ELPA Syncer, 2022/07/11
- [elpa] externals/denote 084bd4656e 28/39: Clarify interactivity for 'denote-prompts', ELPA Syncer, 2022/07/11
- [elpa] externals/denote b4b08f28e5 29/39: Improve denote-prompts reference to other commands, ELPA Syncer, 2022/07/11