[elpa] externals/org-remark 87404b78d3 14/16: Merge branch 'main' into dev/1.2.0

[ELPA Syncer]

branch: externals/org-remark
commit 87404b78d3bb75955b3960cba2807d37207cfa26
Merge: efe2c4d504 4c0137d90a
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    Merge branch 'main' into dev/1.2.0
---
 README.org        |  9 ++++++++-
 org-remark-nov.el | 40 +++++++++++++++++++++++++++++++++++++++-
 2 files changed, 47 insertions(+), 2 deletions(-)

diff --git a/README.org b/README.org
index 320fd993ec..3ce4db6892 100644
--- a/README.org
+++ b/README.org
@@ -72,6 +72,10 @@ After installation, we suggest you put the setup below in 
your configuration.
   ;; Optional if you would like to highlight websites via eww-mode
   (with-eval-after-load 'eww
     (org-remark-eww-mode +1))
+
+  ;; Optional if you would like to highlight EPUB books via nov.el
+  (with-eval-after-load 'nov
+    (org-remark-nov-mode +1))
 #+end_src
 
 Unless you explicitly load ~org~ during Emacs initialization, I suggest to 
defer loading ~org-remark~ (thus there is no ~(require 'org-remark)~ in the 
example above). This is because it will also pull in ~org~, which can slow down 
initialization. You can control the timing of loading ~org-remark~ by 
autoloading some commands in a similar way with the example keybindings below.
@@ -102,6 +106,9 @@ Thank you.
 
 * Contributors
 - New features ::
+
+- EPUB books (nov.el) support would not have been possible without
+  collaboration with @sati-bodhi
 - ~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)
 
@@ -109,7 +116,7 @@ Thank you.
 Nan Jun Jie (@nanjj), @sgati-bodhi
 
 - Documentation (including README, NEWS, CHANGELOG) ::
-@randomwangran, marty hiatt (@mooseyboots)
+@randomwangran, marty hiatt (@mooseyboots), @jsntn
 
 - 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
diff --git a/org-remark-nov.el b/org-remark-nov.el
index 8c28047d0b..8674f219fa 100644
--- a/org-remark-nov.el
+++ b/org-remark-nov.el
@@ -1,10 +1,48 @@
 ;;; org-remark-nov.el --- Compatibility with nov-mode -*- lexical-binding: t; 
-*-
 
+;; Copyright (C) 2021-2023 Free Software Foundation, Inc.
+
+;; Author: Noboru Ota <me@nobiot.com>
 ;; URL: https://github.com/nobiot/org-remark
 ;; Created: 9 January 2023
-;; Last modified: 21 July 2023
+;; Last modified: 29 July 2023
+;; Package-Requires: ((emacs "27.1") (org "9.4"))
+;; Keywords: org-mode, annotation, note-taking, marginal-notes, wp
+
+;; 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/>.
 
 ;;; Commentary:
+;;
+;;  This feature would not have been possible without the collaboration
+;;  with Tan Yin Hoe (GitHub user sati-bodhi).
+;;
+;;  This file is an Org-remark extension to add highlights and
+;;  annotation support for EPUB books rendered by nov.el [1]. Org-remark
+;;  does not automatically install nov.el. Users are expected to obtain
+;;  it separately, for example, via MELPA.
+;;
+;;  The extension can be enabled globally with `org-remark-nov-mode'.
+;;  You will need to use it in conjunction with
+;;  `org-remark-global-tracking-mode' and `org-remark-mode'. For more,
+;;  refer to the following Info node:
+;;
+;; - Info node `(org-remark) Installation'
+;; - Info node `(org-remark) Getting Started'
+;;
+;;  [1]: <https://depp.brause.cc/nov.el/>
 
 ;;; Code: