branch: externals/denote-review
commit abee285fcf57ddbcc56b3781bde7e0cd03163bfa
Author: Matto Fransen <[email protected]>
Commit: Matto Fransen <[email protected]>
Explanation of select a keyword using completion
---
README.org | 4 ++++
denote-review.texi | 28 +++++++++++++++++++++++-----
2 files changed, 27 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index b80e97f33e..abafdf256a 100644
--- a/README.org
+++ b/README.org
@@ -88,6 +88,10 @@ The command ~M-x denote-review-display-list~ creates a
tabulated list of the
notes that contain the ~reviewdate~ frontmatter. Notes without a ~reviewdate~
are ignored.
+This command prompts for a keyword.
+Select a keyword to display only notes with that keyword, or don't
+select any keyword to display all notes.
+
It evaluates the value of the variables ~denote-directory~ and
~denote-silo-directories~. When there is more than one directory, it
prompts the user to select a directory, using completion.
diff --git a/denote-review.texi b/denote-review.texi
index 5a28f2aba7..cad39f2624 100644
--- a/denote-review.texi
+++ b/denote-review.texi
@@ -94,10 +94,22 @@ Review one or more notes and update their review date.
@node Installation
@chapter Installation
-Copy the file @file{denote-review.el} in your load path and either
-visit the file and issue the command @code{M-x eval-buffer} to
-evaluate the code or add a line @code{(require 'denote-review)} to
-your Emacs configuration file.
+`denote-review' can be install from GNU ELPA.
+
+@itemize
+@item
+@code{M-x package-refresh-contents}
+@item
+@code{M-x package-install}
+@end itemize
+
+Or use @code{use-package}.
+
+To manually install @code{denote-review}, copy the file
+@file{denote-review.el} in your load path and either visit the file
+and issue the command @code{M-x eval-buffer} to evaluate the code or
+add a line @code{(require 'denote-review)} to your Emacs configuration
+file.
@node Getting started
@chapter Getting started
@@ -142,7 +154,13 @@ To make this easy, bind this command to a key, f.e.:
@findex denote-review-display-list
Issue the command @code{M-x denote-review-display-list} to open
-a list with notes. The list shows only notes with the review date frontmatter.
+a list with notes.
+
+This command prompts for a keyword, using completion.
+Select a keyword to display only notes with that keyword, or don't
+select any keyword to display all notes.
+
+The list shows only notes with the review date frontmatter.
Notes without a review date are ignored.
The list is created in the tabulated list mode.
