emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org-remark 69b6cd0b25: bump to version 1.0.0


From: ELPA Syncer
Subject: [elpa] externals/org-remark 69b6cd0b25: bump to version 1.0.0
Date: Sat, 12 Feb 2022 07:57:51 -0500 (EST)

branch: externals/org-remark
commit 69b6cd0b25814aeb150101eb203895c21be1f2e1
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    bump to version 1.0.0
---
 NEWS                |  2 +-
 docs/org-remark.org | 12 +++++++++---
 org-remark.el       |  4 ++--
 3 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/NEWS b/NEWS
index abc8a64bcc..256c198551 100644
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,4 @@
-Current development version
+Version 1.0.0
   - chg: align with GNU convention: path -> file name
 
          Regarding user option `org-remark-notes-file-path`, the GNU convention
diff --git a/docs/org-remark.org b/docs/org-remark.org
index 1f6426daa7..d7570b1b90 100644
--- a/docs/org-remark.org
+++ b/docs/org-remark.org
@@ -1,7 +1,7 @@
 #+title: Org-remark User Manual
 #+author: Noboru Ota <me@nobiot.com>
-#+macro: version 0.2.x
-#+macro: modified 05 February 2022
+#+macro: version 1.0.x
+#+macro: modified 12 February 2022
 #+language: en
 #+export_file_name: org-remark.texi
 #+texinfo_dir_category: Emacs
@@ -234,7 +234,7 @@ Org-remark displays the marginal notes buffer narrowed to 
the highlight the curs
 
 The location of the marginal notes file is specified by user option 
~org-remark-notes-file-name~ and its default is "marginalia.org". This means 
the marginal notes file will reside in the same directory as the source files 
as a separate file.
 
-~org-remark-notes-file-name~ also takes a function as a value, so you have a 
wide range of customizability. In ~customize~, the default function to be used 
is ~org-remark-notes-file-name-function~, which adds =-notes.org= as a suffix 
to the source file's name without the extension. For example, for 
=my-main-file.txt= Org-remark will create and store highlights in  
=my-main-file-notes.org=.
+~org-remark-notes-file-name~ can also take a function as a value, so you have 
a wide range of customizability. In ~customize~, the default function to be 
used is ~org-remark-notes-file-name-function~. It adds =-notes.org= as a suffix 
to the source file's name without the extension. For example, for a file named 
=my-main-file.txt=,  Org-remark will store highlights in  
=my-main-file-notes.org=.
 
 In order to use the source file also as the marginal notes file (storing the 
notes in the source file), you can set the built-in function ~buffer-file-name~ 
as the value of ~org-remark-notes-file-name~. Note that you will need to ensure 
that the source files are an Org file.
 
@@ -242,6 +242,12 @@ In order to use the source file also as the marginal notes 
file (storing the not
 #+findex: org-remark-remove
 #+findex: org-remark-delete
 
+You can remove the highlight under the cursor with command 
`org-remark-remove`. This command does not delete the corresponding entry in 
the marginal notes file. This is intentional; Org-roam is conservative when it 
deletes anything that the user might have edited.
+
+If you wish to delete the entry and the highlight at the same time, pass a 
universal argument to `org-remark-remove` (e.g. by adding ~C-u~ before ~M-x 
org-remark-remove~) or use ~org-remark-delete~. ~org-remark-delete~ is 
identical with adding ~C-u~ to ~org-remark-remove~.
+
+The delete function will prompt for confirmation if it detects any notes 
present in the corresponding entry for the highlight in question in the 
marginal notes buffer.
+
 - Command ~org-remark-remove~ ::
   Remove the highlight at point.
   It will remove the highlight and the properties from the marginal notes 
file, but will keep the headline and annotations. This is to ensure to keep any 
notes you might have written intact.
diff --git a/org-remark.el b/org-remark.el
index 6dfcbb9d1f..9aec19f49e 100644
--- a/org-remark.el
+++ b/org-remark.el
@@ -4,9 +4,9 @@
 
 ;; Author: Noboru Ota <me@nobiot.com>
 ;; URL: https://github.com/nobiot/org-remark
-;; Version: 0.2.0
+;; Version: 1.0.0
 ;; Created: 22 December 2020
-;; Last modified: 05 February 2022
+;; Last modified: 12 February 2022
 ;; Package-Requires: ((emacs "27.1") (org "9.4"))
 ;; Keywords: org-mode, annotation, writing, note-taking, marginal-notes
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]