branch: externals/org-remark
commit 211c2ccb05baa163eaf46aebdfcccb530282cf1f
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
break: Change om/open-at-point to om/open
---
README.org | 6 +++---
org-marginalia.el | 8 ++++----
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/README.org b/README.org
index 1e8e724b36..3bb68a98ff 100644
--- a/README.org
+++ b/README.org
@@ -72,11 +72,11 @@ Select a region of text, and call =om/mark= to highlight
the region. It will gen
- =om/save= ::
By default, Org-marginalia automatically creates or updates corresponding
entries in the marginalia file with location and text of highlights on saving
the buffer. Nevertheless, you can manually call =om/save= to do so (automatic
process also call this command).
-- =om/open-at-point= (=C-c n o= by default) ::
-Move your cursor on the highlighted text, and call =om/open-at-point= to open
the relevant margin notes in a separate window. Your cursor should move to the
marginalia buffer narrowed to the relevant margin notes entry. You can edit the
margin notes as a normal Org file. Once you have done editing, you can simply
save and close the buffer (kill or close the window) as per your normal
workflow. Technically, the marginalia buffer is a cloned indirect buffer of the
marginalia file.
+- =om/open= (=C-c n o= by default) ::
+Move your cursor on the highlighted text, and call =om/open= to open the
relevant margin notes in a separate window. Your cursor will move to the
marginalia buffer narrowed to the relevant margin notes entry. You can edit the
margin notes as a normal Org file. Once you have done editing, you may simply
save and close the buffer (kill or close the window) as per your normal
workflow. Technically, the marginalia buffer is a cloned indirect buffer of the
marginalia file.
- =om/load= ::
-This command open the marginalia file and load the saved highlights onto
current buffer. If there is no margin notes for it, it will output a message in
the echo. Highlights tracked locally by this packages cannot persist when you
kill the buffer, or quit Emacs. When you re-launch Emacs, ensure to turn on
=org-marginalia-mode= to load the highlights. Load is automatically done when
you activate the minor mode.
+This command visits the marginalia file and load the saved highlights onto the
current buffer. If there is no margin notes for it, it will output a message in
the echo. Highlights tracked locally by Org-marginalia cannot persist when you
kill the buffer, or quit Emacs. When you re-launch Emacs, ensure to turn on
=org-marginalia-mode= to load the highlights. Load is automatically done when
you activate the minor mode.
- =om/remove= ::
This command removes the highlight at point. It will remove the highlight, and
remove the properties from the marginalia, but will keep the headline and notes
in tact.
diff --git a/org-marginalia.el b/org-marginalia.el
index 4ccbf5f0a2..43d86aedbe 100644
--- a/org-marginalia.el
+++ b/org-marginalia.el
@@ -65,8 +65,8 @@
;; file. You can manually call =om/save= to manually do it (automatic
;; process also call this command).
-;; - =om/open-at-point= :: Move your cursor on the highlighted text, and call
-;; =om/open-at-point= to open the relevant margin notes in a separate window.
+;; - =om/open= :: Move your cursor on the highlighted text, and call
+;; =om/open= to open the relevant margin notes in a separate window.
;; Your cursor should move to the marginalia buffer narrowed to the relevant
;; margin notes entry. You can edit the margin notes as a normal Org file.
;; Once you have done editing, you can simply save and close the buffer (kill
@@ -232,7 +232,7 @@ current buffer. Each highlight is represented by this data
structure:
(om/save-single-highlight highlight title source-path))))
;;;###autoload
-(defun om/open-at-point (point)
+(defun om/open (point)
"Open the margin notes at POINT, narrowed to the relevant headline.
It creates a cloned indirect buffer of the marginalia file
\(`om/notes-file-path'\). You can edit the margin notes as a normal Org file.
@@ -350,7 +350,7 @@ the mode, `toggle' toggles the state."
:lighter " marginalia"
:global nil
:keymap (let ((map (make-sparse-keymap)))
- (define-key map (kbd "C-c n o") #'om/open-at-point)
+ (define-key map (kbd "C-c n o") #'om/open)
(define-key map (kbd "C-c m") #'om/mark)
map)
(cond
