branch: externals/org-remark
commit 7226f4d01ebf4a124d68e855549c024b6808dc8c
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
docs: add delete; add help string to menu items
The help strings are displayed in the echo when selecting the menu item
---
docs/org-remark.org | 10 +++++++++-
org-remark.el | 19 ++++++++++++++-----
2 files changed, 23 insertions(+), 6 deletions(-)
diff --git a/docs/org-remark.org b/docs/org-remark.org
index 7a17faea71..120c407d69 100644
--- a/docs/org-remark.org
+++ b/docs/org-remark.org
@@ -1,7 +1,7 @@
#+title: Org-remark User Manual
#+author: Noboru Ota <m...@nobiot.com>
#+macro: version 0.1.x
-#+macro: modified 25 January 2022
+#+macro: modified 28 January 2022
#+language: en
#+export_file_name: org-remark.texi
@@ -223,6 +223,7 @@ Org-remark displays the marginal notes buffer narrowed to
the highlight the curs
#+findex: org-remark-toggle
#+findex: org-remark-change
#+findex: org-remark-remove
+#+findex: org-remark-delete
#+findex: org-remark-next
#+findex: org-remark-prev
@@ -241,6 +242,13 @@ This command will show you a list of available pens to
choose from.
To navigate through highlights in the current buffer, you can use
~org-remark-view-next~ / ~org-remark-view-prev~ or the following pair of
commands. The former moves your cursor and displays the marginal notes buffer;
the latter only moves your cursor.
+- Command ~org-remark-delete~ ::
+ Delete the highlight at POINT and marginal notes for it.
+ This function will prompt for confirmation if there is any notes present in
the marginal notes buffer. When the marginal notes buffer is not displayed in
the current frame, it will be temporarily displayed together with the prompt
for the user to see the notes.
+ If there is no notes, this function will not prompt for confirmation and
will remove the highlight and deletes the entry in the marginal notes buffer.
+ This command is identical with passing a universal argument to
+`org-remark-remove'.
+
- Command ~org-remark-next~ ::
Move to the next highlight, if any.
If there is none below the point but there is a highlight in the buffer,
cycle back to the first one.
diff --git a/org-remark.el b/org-remark.el
index 3a25e83fdd..c260448db3 100644
--- a/org-remark.el
+++ b/org-remark.el
@@ -6,7 +6,7 @@
;; URL: https://github.com/nobiot/org-remark
;; Version: 0.2.0
;; Created: 22 December 2020
-;; Last modified: 27 January 2022
+;; Last modified: 28 January 2022
;; Package-Requires: ((emacs "27.1") (org "9.4"))
;; Keywords: org-mode, annotation, writing, note-taking, marginal-notes
@@ -247,11 +247,13 @@ recommended to turn it on as part of Emacs initialization.
(define-key-after org-remark-menu-map
[org-remark-open]
- '(menu-item "Open" org-remark-open))
+ '(menu-item "Open" org-remark-open
+ :help "Display and move to marginal notes for highlight at
point"))
(define-key-after org-remark-menu-map
[org-remark-view]
- '(menu-item "View" org-remark-view))
+ '(menu-item "View" org-remark-view
+ :help "Display marginal notes for highlight at point; stay in
current buffer"))
(define-key-after org-remark-menu-map
[org-remark-view-next]
@@ -263,11 +265,18 @@ recommended to turn it on as part of Emacs initialization.
(define-key-after org-remark-menu-map
[org-remark-toggle]
- '(menu-item "Toggle" org-remark-toggle))
+ '(menu-item "Toggle" org-remark-toggle
+ :help "Toggle showing/hiding of highlights in current buffer"))
(define-key-after org-remark-menu-map
[org-remark-remove]
- '(menu-item "Remove" org-remark-remove))
+ '(menu-item "Remove" org-remark-remove
+ :help "Remove highlight at point, keeping the marginal notes
entry"))
+
+(define-key-after org-remark-menu-map
+ [org-remark-delete]
+ '(menu-item "Delete" org-remark-delete
+ :help "Delete highlight at point and the marginal notes entry"))
;; Make pen functions menu
(defvar org-remark-pen-map
