[elpa] externals/org-remark eed28d7b8d 26/67: Merge branch 'main' into dev/nov.el

[ELPA Syncer]

branch: externals/org-remark
commit eed28d7b8d06c3f4329c7914872ece2a21ff85bb
Merge: 32149d5135 41a615c9f8
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    Merge branch 'main' into dev/nov.el
---
 NEWS                                               |   2 +-
 README-elpa                                        |  96 +++++++++++++---
 README.org                                         |   3 +-
 ...efractions,_inflexions_and_colours_of_light.png | Bin 352833 -> 0 bytes
 demo/custom-pens.el                                |  30 -----
 demo/demo.txt                                      |  55 ---------
 demo/marginalia.org                                | 127 ---------------------
 docs/org-remark.org                                |   8 +-
 org-remark-global-tracking.el                      |  13 ++-
 org-remark.el                                      |   7 +-
 10 files changed, 97 insertions(+), 244 deletions(-)

diff --git a/NEWS b/NEWS
index 38deb4e40d..c03df4851a 100644
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,4 @@
-Version 1.1.0-rc -- Current development version
+Version 1.1.0
 
   Features:
 
diff --git a/README-elpa b/README-elpa
index 96e311513b..b16206c716 100644
--- a/README-elpa
+++ b/README-elpa
@@ -8,9 +8,11 @@ Table of Contents
 _________________
 
 1. Introduction
-2. Installation
-3. Contributing and Feedback
-4. License
+2. Features
+3. Installation
+4. Contributing and Feedback
+5. Contributors
+6. License
 
 
 
@@ -19,11 +21,10 @@ _________________
 1 Introduction
 ==============
 
-  Org-remark lets you highlight and annotate any text file with using
-  Org mode.
+  Org-remark lets you highlight and annotate text files and websites
+  with using Org mode [1].
 
-  A user manual is available [online] (Info node will be available when
-  Org-remark is added to ELPA/MELPA) or Emacs in-system as an Info node
+  A user manual is available [online] or Emacs in-system as an Info node
   `(org-remark)': (`C-h i' and find the `Org-remark' node).
 
   For installation and minimum configuration, refer to [Installation]
@@ -41,7 +42,7 @@ _________________
 
 [online] <https://nobiot.github.io/org-remark/>
 
-[Installation] See section 2
+[Installation] See section 3
 
 [online] <https://nobiot.github.io/org-remark/#Installation>
 
@@ -52,7 +53,28 @@ _________________
 [introductory video] <https://youtu.be/c8DHrAsFiLc>
 
 
-2 Installation
+2 Features
+==========
+
+  - Highlight and annotate any text file. The highlights and notes are
+    kepted in an Org file as the plain text database. This lets you
+    easily manage your marginal notes and use the built-in Org
+    fecilities on them -- e.g. create a sparse tree based on the
+    category of the notes
+
+  - Have the same highlighting and annotating functionality for websites
+    when you use EWW to browse them (new in latest [GNU-devel ELPA] and
+    is planned to be part of v1.1.0.)
+
+  - Create your your own highlighter pens with different colors, type
+    (e.g. underline, squiggle, etc. optionally with Org's category for
+    search and filter on your highlights and notes)
+
+
+[GNU-devel ELPA] <https://elpa.gnu.org/devel/org-remark.html>
+
+
+3 Installation
 ==============
 
   This package is available on:
@@ -61,22 +83,24 @@ _________________
   - [GNU-devel ELPA] (unreleased development branch; equivalent to
     MELPA)
 
-
   GNU ELPA should be already set up in your Emacs by default. If you
   wish to add GNU-devel ELPA, simply add its URL to `package-archives'
   like this:
 
   ,----
   | (add-to-list 'package-archives
-  |         '("gnu-devel" . "https://elpa.gnu.org/devel/";) :append)
+  |              '("gnu-devel" . "https://elpa.gnu.org/devel/";) :append)
   `----
 
   After installation, we suggest you put the setup below in your
   configuration.
 
   ,----
-  | (require 'org-remark-global-tracking)
   | (org-remark-global-tracking-mode +1)
+  | 
+  | ;; Optional if you would like to highlight websites via eww-mode
+  | (with-eval-after-load 'eww
+  |   (org-remark-eww-mode +1))
   `----
 
   Unless you explicitly load `org' during Emacs initialization, I
@@ -108,17 +132,17 @@ _________________
 [GNU-devel ELPA] <https://elpa.gnu.org/devel/org-remark.html>
 
 
-3 Contributing and Feedback
+4 Contributing and Feedback
 ===========================
 
   Create issues, discussion, and/or pull requests in the GitHub
   repository. All welcome.
 
-  Org-remark is planned to be submitted to GNU ELPA and thus copyrighted
-  by the [Free Software Foundation] (FSF). This means that anyone who is
-  making a substantive code contribution will need to "assign the
-  copyright for your contributions to the FSF so that they can be
-  included in GNU Emacs" ([Org Mode website]).
+  Org-remark is available on GNU ELPA and thus copyrighted by the [Free
+  Software Foundation] (FSF). This means that anyone who is making a
+  substantive code contribution will need to "assign the copyright for
+  your contributions to the FSF so that they can be included in GNU
+  Emacs" ([Org Mode website]).
 
   Thank you.
 
@@ -128,7 +152,32 @@ _________________
 [Org Mode website] <https://orgmode.org/contribute.html#copyright>
 
 
-4 License
+5 Contributors
+==============
+
+  New features
+
+
+        `echo-text' update from the marginal notes to the source buffer
+        by marty hiatt (@mooseyboots)
+
+        Support for websites with `eww-mode' by Vedang Manerikar
+        (@vedang)
+
+  Bug fixes
+  Nan Jun Jie (@nanjj), @sgati-bodhi
+
+  Documentation (including README, NEWS, CHANGELOG)
+  @randomwangran, marty hiatt (@mooseyboots)
+
+  All the comments, issues, and questions on GitHub
+  @randomwangran, @karthink, @holtzermann17, @shombando, @magthe,
+  @linwaytin, @rtrppl, @ryanprior, @ericsfraga, @darcamo, @zhewy,
+  @QMeqGR, @Vidianos-Giannitsis, @AtomicNess123, @mooseyboots, @ouboub,
+  @dian-yu-luo, @SylvianHemus, @basaran, @Ypot, @oatmealm, @sati-bodhi
+
+
+6 License
 =========
 
   This work is licensed under a GPLv3 license. For a full copy of the
@@ -136,3 +185,12 @@ _________________
 
 
 [LICENSE] <./LICENSE>
+
+
+
+Footnotes
+_________
+
+[1] : Feature to highlight and annotate websites is new in the latest
+[GNU-devel ELPA] (<https://elpa.gnu.org/devel/org-remark.html>) and is
+part of v1.1.0.
diff --git a/README.org b/README.org
index 87ad5d35d2..6066ada9f2 100644
--- a/README.org
+++ b/README.org
@@ -23,7 +23,7 @@ For customization, refer to the customization group 
`org-remark' or user manual:
 
 An [[https://youtu.be/c8DHrAsFiLc][introductory video]] (8 minutes) is 
available on YouTube.
 
-[fn:1]: Feature to highlight and annotate websites is new in the latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned 
to be part of v1.1.0.
+[fn:1]: Feature to highlight and annotate websites is new in the latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is part of 
v1.1.0.
 
 * Features
 
@@ -54,7 +54,6 @@ This package is available on:
 - [[https://elpa.gnu.org/packages/org-remark.html][GNU-ELPA]] (releases only; 
equivalent to MELPA-Stable)
 - [[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] (unreleased 
development branch; equivalent to MELPA)
 
-
 GNU ELPA should be already set up in your Emacs by default. If you wish to add 
GNU-devel ELPA, simply add its URL to ~package-archives~ like this:
 
 #+BEGIN_SRC elisp
diff --git 
a/demo/Marginalia_from_Opticks_or,_A_treatise_of_the_reflexions,_refractions,_inflexions_and_colours_of_light.png
 
b/demo/Marginalia_from_Opticks_or,_A_treatise_of_the_reflexions,_refractions,_inflexions_and_colours_of_light.png
deleted file mode 100644
index 5bdcb1cab1..0000000000
Binary files 
a/demo/Marginalia_from_Opticks_or,_A_treatise_of_the_reflexions,_refractions,_inflexions_and_colours_of_light.png
 and /dev/null differ
diff --git a/demo/custom-pens.el b/demo/custom-pens.el
deleted file mode 100644
index 5391f5d5bd..0000000000
--- a/demo/custom-pens.el
+++ /dev/null
@@ -1,30 +0,0 @@
-;; Copyright (C) 2021-2022  Free Software Foundation, Inc.
-
-;; Author: Noboru Ota <me@nobiot.com>
-
-;; This file is not part of GNU Emacs.
-
-;; This program is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation, either version 3 of the License, or
-;; (at your option) any later version.
-
-;; This program is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;; GNU General Public License for more details.
-
-;; You should have received a copy of the GNU General Public License
-;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-
-(org-remark-create "memorize"
-                   '(:foreground "white" :underline "black")
-                   '(CATEGORY "exam"))
-
-(org-remark-create "magenta"
-                   '(modus-themes-nuanced-magenta))
-
-(org-remark-create "typo"
-                   '(:underline (:color "#8f0075" :style wave))
-                   '(help-echo "Fix the typo"))
diff --git a/demo/demo.txt b/demo/demo.txt
deleted file mode 100644
index 7f69cb4d89..0000000000
--- a/demo/demo.txt
+++ /dev/null
@@ -1,55 +0,0 @@
-
-      Org-remark
-
-      Highlight  and
-      annotate any text file.
-
-      † Name chagned from
-         Org-marginalia
-
----
-Art Nouveau
-Source: https://en.wikipedia.org/wiki/Art_Nouveau
-
-Art Nouveau (/ˌɑːrt nuːˈvoʊ, ˌɑːr/; French: [aʁ nuvo]) is an international 
style of art, architecture, and 
-applied art, especially the decorative arts, known in different languages by 
different names: Jugendstil in German, Stile Liberty in Italian, Modernisme 
català in Catalan, etc. In English it is also known as the Modern Style. The 
style was most popular between 1890 and 1910 during the Belle Époque period 
that ended with the start of World War I in 1914.[1] It was a reaction against 
the academic art, eclecticism and historicism of 19th century architecture and 
decoration. It was often ins [...]
-
-One major objective of Art Nouveau was to break down the traditional 
distinction between fine arts (especially painting and sculpture) and applied 
arts. It was most widely used in interior design, graphic arts, furniture, 
glass art, textiles, ceramics, jewellery and metal work.
-
-The mouvement responded to Viollet le Duc’s theories on rationalism which 
derided from his study of medieval art :
-
-- Function should define form[4].
-
-- Unity of the arts and the abolition of any distinction between major art 
(architecture) and minor arts (decorative arts).[5]
-
-- Nature’s logique is the model to be used for architecture[6].
-
-- Architecture should adapt itself to man’s environment and needs.
-
-- Use of modern technologie and materials [7]. 
-
----
-Custom pens
-
-(find-file "custom-pens.el")
-
-Example 1
-
- (org-remark-create "magenta"     
-                    '(modus-themes-nuanced-magenta))
-
-
-Example 2
-  
- (org-remark-create "memorize"
-                   '(:foreground "white" :underline "black")
-                   '(CATEGORY "exam"))
-
----
-Org-remark
-
-GitHub Repository
-‣ https://github.com/nobiot/org-remark
-
-User manual
-‣ https://nobiot.github.io/org-remark
diff --git a/demo/marginalia.org b/demo/marginalia.org
deleted file mode 100644
index 0d7b2093c2..0000000000
--- a/demo/marginalia.org
+++ /dev/null
@@ -1,127 +0,0 @@
-
-* demo
-:PROPERTIES:
-:org-remark-file: demo.txt
-:END:
-
-** World War I
-:PROPERTIES:
-:org-remark-beg: 633
-:org-remark-end: 644
-:org-remark-id: 598a701e
-:org-remark-label: nil
-:CATEGORY: exam
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-
-** Highlight
-:PROPERTIES:
-:org-remark-beg: 26
-:org-remark-end: 36
-:org-remark-id: 4d94d0fb
-:org-remark-label: blue
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::4]]
-:END:
-
-** any text file
-:PROPERTIES:
-:org-remark-beg: 56
-:org-remark-end: 69
-:org-remark-id: 6a4de876
-:org-remark-label: yellow
-:CATEGORY: important
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::5]]
-:END:
-
-** chagned
-:PROPERTIES:
-:org-remark-beg: 85
-:org-remark-end: 92
-:org-remark-id: 64f37ffc
-:org-remark-label: typo
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::7]]
-:END:
-Fix the typo
-
-** Org-marginalia
-:PROPERTIES:
-:org-remark-beg: 107
-:org-remark-end: 121
-:org-remark-id: 76539dd9
-:org-remark-label: nil
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::8]]
-:END:
-*** Pronunciation
-(General American) IPA(key): /mɑɹdʒɪˈneɪli.ə/
-(Received Pronunciation) IPA(key): /mɑːdʒɪˈneɪli.ə/
-Rhymes: -eɪliə
-Hyphenation: mar‧gi‧na‧lia
-
-*** Etymology
-From New Latin marginālia, from Medieval Latin neuter plural of marginālis 
(“on the periphery”), from Latin margō (“border, edge”). Compare margin.
-[[file:Marginalia_from_Opticks_or,_A_treatise_of_the_reflexions,_refractions,_inflexions_and_colours_of_light.png]]
-Marginalia from Opticks or, A treatise of the reflexions, refractions, 
inflexions and colours of light, is lincensed under  CC BY 2.0. Obtained via 
https://en.wiktionary.org/wiki/marginalia
-
-** org-remark-create
-
-** Nouveau
-:PROPERTIES:
-:org-remark-beg: 194
-:org-remark-end: 201
-:org-remark-id: d6c51623
-:org-remark-label: nil
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-Add annotation. 
-** German, Stile Liberty in Italian
-:PROPERTIES:
-:org-remark-beg: 406
-:org-remark-end: 438
-:org-remark-id: f0be9d61
-:org-remark-label: blue
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-** Other characteristics of Art Nouveau
-:PROPERTIES:
-:org-remark-beg: 866
-:org-remark-end: 902
-:org-remark-id: a90a5866
-:org-remark-label: nil
-:CATEGORY: exam
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-
-** 19th century
-:PROPERTIES:
-:org-remark-beg: 732
-:org-remark-end: 744
-:org-remark-id: c935365d
-:org-remark-label: red-line
-:CATEGORY: review
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-Annotation for the 19th centry.
-
-** 1890 and 1910
-:PROPERTIES:
-:org-remark-beg: 559
-:org-remark-end: 572
-:org-remark-id: 8ff2c5f8
-:org-remark-label: nil
-:CATEGORY: exam
-:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::10]]
-:END:
-
-** international
-:PROPERTIES:
-:org-remark-beg: 264
-:org-remark-end: 251
-:org-remark-id: 7a312b27
-:org-remark-label: nil
-:org-remark-link: [[file:demo.txt::14]]
-:END:
diff --git a/docs/org-remark.org b/docs/org-remark.org
index 5e42e9330c..a4ecd6cd47 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 1.0.x
-#+macro: modified 14 January 2023
+#+macro: modified 20 May 2023
 #+language: en
 #+export_file_name: org-remark.texi
 #+texinfo_dir_category: Emacs
@@ -85,7 +85,7 @@ Below are example keybindings you might like to consider:
     (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove))
 #+end_src
 
-[fn:1]: Feature to highlight and annotate websites is new in the latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned 
to be part of v1.1.0.
+[fn:1]: Feature to highlight and annotate websites is new in the latest 
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is part of 
v1.1.0.
 
 * Getting Started
 :PROPERTIES:
@@ -143,7 +143,7 @@ This is all you need to get started. For more detail, refer 
to the rest of this
 #+cindex: Highlighting websites with EWW
 #+findex: org-remark-eww-mode
 
-~org-remark-eww-mode~ lets you highlight and annotate websites just like text 
files. It is a global minor mode. It does not require any additional 
configuration. All you need is to turn it on, visit a website with ~eww-mode~, 
and select text and highlight it. Refer to the example of a basic setup given 
in [[#installation][Instalaltion]].
+~org-remark-eww-mode~ lets you highlight and annotate websites just like text 
files. It is a global minor mode. It does not require any additional 
configuration. All you need is to turn it on, visit a website with ~eww-mode~, 
and select text and highlight it. Refer to the example of a basic setup given 
in [[#installation][Installation]].
 
 * Usage
 :PROPERTIES:
@@ -246,7 +246,7 @@ Org-remark displays the marginal notes buffer narrowed to 
the highlight the curs
 
 After all the properties, you can freely write your notes for the highlight. 
Once you save the notes buffer, an excerpt of the text (currently up to 200 
characters) gets updated back onto the highlight in the source buffer. You can 
hover your mouse over the highlight to see the excerpt displayed in the echo 
area (bottom of the screen) of Emacs. If you have ~tooltip-mode~ mode turned 
on, the excerpt is displayed as a took tip for the highlight [fn:2].
 
-[fn:2]: Feature to display an excerpt of the body of marginal notes is new in 
latest [[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is 
planned to be part of v1.1.0.
+[fn:2]: Feature to display an excerpt of the body of marginal notes is new in 
latest [[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is 
part of v1.1.0.
 
 *** How to Change Where Marginal Notes File is Saved
 :PROPERTIES:
diff --git a/org-remark-global-tracking.el b/org-remark-global-tracking.el
index 43c6d68449..6c34ce2ba4 100644
--- a/org-remark-global-tracking.el
+++ b/org-remark-global-tracking.el
@@ -5,7 +5,7 @@
 ;; Author: Noboru Ota <me@nobiot.com>
 ;; URL: https://github.com/nobiot/org-remark
 ;; Created: 15 August 2021
-;; Last modified: 14 January 2023
+;; Last modified: 15 April 2023
 ;; Package-Requires: ((emacs "27.1") (org "9.4"))
 ;; Keywords: org-mode, annotation, note-taking, marginal-notes, wp
 
@@ -48,7 +48,9 @@ is an Org file.
 If it is a function, the default function is
 `org-remark-notes-file-name-function'.  It returns a file name
 like this: \"FILE-notes.org\" by adding \"-notes.org\" as a
-suffix to the file name without the extension."
+suffix to the file name without the extension. When the buffer is
+not visiting a file (e.g. a website via EWW), the file name will
+be \"marginalia.org\" in your `user-emacs-directory'."
   :group 'org-remark
   :safe #'stringp
   :type '(choice
@@ -97,7 +99,12 @@ This is the default function for the customizing variable
 
 When the current buffer is visiting a file, the name of marginal
 notes file will be \"FILE-notes.org\", adding \"-notes.org\" as a
-suffix to the file name without the extension."
+suffix to the file name without the extension.
+
+If the current buffer is not visiting a file, the file name will
+be marginalia.org in your `user-emacs-directory'.  If this file
+name is not suitable, either override the function or set the
+user option to use your own custom function."
   (if buffer-file-name
       (let ((source-filename (org-remark-source-find-file-name)))
         (when (and (stringp source-filename)
diff --git a/org-remark.el b/org-remark.el
index f51706dbf9..80ce0d5b30 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: 1.0.5
+;; Version: 1.1.0
 ;; Created: 22 December 2020
-;; Last modified: 14 January 2023
+;; Last modified: 20 May 2023
 ;; Package-Requires: ((emacs "27.1") (org "9.4"))
 ;; Keywords: org-mode, annotation, note-taking, marginal-notes, wp,
 
@@ -394,7 +394,7 @@ marginal notes file.  The expected values are nil, :load and
                      '(:underline (:color "dark red" :style wave))
                      '(CATEGORY "review" help-echo "Review this"))
   (org-remark-create "yellow"
-                     '(:inherit default :underline "gold2")
+                     '(:underline "gold2")
                      '(CATEGORY "important")))
 
 (defun org-remark-save ()
@@ -612,6 +612,7 @@ commands such as `org-remark-next' and `org-remark-prev'.
 
 Return t if the cursor has moved to next/prev.
 Return nil if not and outputs a message in the echo."
+  (org-remark-highlights-housekeep)
   (if (not org-remark-highlights)
       (progn (message "No highlights present in the buffer") nil)
     (let ((p (if next (org-remark-find-next-highlight)