[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org-remark 8d1c780363 1/2: docs: prep for v1.2.0 releas
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/org-remark 8d1c780363 1/2: docs: prep for v1.2.0 release |
|
Date: |
Sun, 20 Aug 2023 09:58:11 -0400 (EDT) |
branch: externals/org-remark
commit 8d1c7803634a446fb19aaa6240b6d8614709772c
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>
docs: prep for v1.2.0 release
---
NEWS | 18 ++++++----
README-elpa | 41 ++++++++++++-----------
README.org | 34 ++++++++-----------
docs/org-remark.org | 25 +++++++++-----
resources/images/2023-08-20-epub-prince-icon.png | Bin 0 -> 151369 bytes
5 files changed, 64 insertions(+), 54 deletions(-)
diff --git a/NEWS b/NEWS
index 613b051d8c..1dd79b04fd 100644
--- a/NEWS
+++ b/NEWS
@@ -1,13 +1,13 @@
-Current development version
+Version 1.2.0 - 2023-08-20
- feat(info): Org-remark supports Info
- Advice has been implemented. It is added and removed by
- `org-remark-info-mode`.
+ + Advice has been implemented. It is added and removed by
+ `org-remark-info-mode`.
- No suitable hook is avaialble to trigger a function after the Info
node
- is rendered. This is necessary as Info renders a new node in the same
- buffer (in the same way as Nov.el does).
+ + No suitable hook is avaialble to trigger a function after the Info
node
+ is rendered. This is necessary as Info renders a new node in the
same
+ buffer (in the same way as Nov.el does).
- feat: icons for additional information for highlights
@@ -48,6 +48,10 @@ Current development version
- feat: org-remark-highlights-after-load-functions
Abnormal hook
+ Fixes:
+
+ - fix: org 9.6.7 breaks org-remark-highlights-get (#70)
+
- fix: Make load process robust
+ When error occurs during the load process, instead of
@@ -76,7 +80,7 @@ Current development version
No functional change. Changed the default color of the
highlighter to be more visible in the dark theme.
-Version 1.1.0
+Version 1.1.0 - 2023-05-20
Features:
diff --git a/README-elpa b/README-elpa
index 385e5d8853..0e1b7099a2 100644
--- a/README-elpa
+++ b/README-elpa
@@ -21,8 +21,8 @@ _________________
1 Introduction
==============
- Org-remark lets you highlight and annotate text files, websites, and
- EPUB books with using Org mode [1].
+ Org-remark lets you highlight and annotate text files, websites, EPUB
+ books and Info documentation with using Org mode.
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).
@@ -47,7 +47,7 @@ _________________
[online] <https://nobiot.github.io/org-remark/#Installation>
-[online] <https://nobiot.github.io/org-remark/#getting-started>
+[online] <https://nobiot.github.io/org-remark/#Getting-Started>
[online] <https://nobiot.github.io/org-remark/#Customizing>
@@ -72,13 +72,12 @@ _________________
+ Websites when you use EWW to browse them
- + EPUB books with [nov.el] (latest [GNU-devel ELPA] and is planned
- to be part of v1.2.0.)
+ + EPUB books with [nov.el]
+ + Info documentation
-[nov.el] <https://depp.brause.cc/nov.el/>
-[GNU-devel ELPA] <https://elpa.gnu.org/devel/org-remark.html>
+[nov.el] <https://depp.brause.cc/nov.el/>
3 Installation
@@ -108,6 +107,14 @@ _________________
| ;; 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))
+ |
+ | ;; Optional if you would like to highlight Info documentation via Info-mode
+ | (with-eval-after-load 'info
+ | (org-remark-info-mode +1))
`----
Unless you explicitly load `org' during Emacs initialization, I
@@ -130,7 +137,8 @@ _________________
| (define-key org-remark-mode-map (kbd "C-c n o") #'org-remark-open)
| (define-key org-remark-mode-map (kbd "C-c n ]") #'org-remark-view-next)
| (define-key org-remark-mode-map (kbd "C-c n [") #'org-remark-view-prev)
- | (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove))
+ | (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove)
+ | (define-key org-remark-mode-map (kbd "C-c n d") #'org-remark-delete))
`----
@@ -165,6 +173,10 @@ _________________
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)
@@ -172,10 +184,10 @@ _________________
(@vedang)
Bug fixes
- Nan Jun Jie (@nanjj), @sgati-bodhi
+ @alan-w-255, 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,
@@ -192,12 +204,3 @@ _________________
[LICENSE] <./LICENSE>
-
-
-
-Footnotes
-_________
-
-[1] : Feature to highlight and annotate EPUB books is new in the
-latest [GNU-devel ELPA] (<https://elpa.gnu.org/devel/org-remark.html>)
-and is planned to be part of v1.2.0.
diff --git a/README.org b/README.org
index 3ce4db6892..79ac957668 100644
--- a/README.org
+++ b/README.org
@@ -10,20 +10,18 @@
* Introduction
-Org-remark lets you highlight and annotate text files, websites, and EPUB
books with using Org mode [fn:1].
+Org-remark lets you highlight and annotate text files, websites, EPUB books
and Info documentation with using Org mode.
A user manual is available [[https://nobiot.github.io/org-remark/][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][Installation]] below or the user manual:
[[https://nobiot.github.io/org-remark/#Installation][online]] or Info node
`(org-remark) Installation'
-Getting Started in the user manual will get you started in 5 minutes:
[[https://nobiot.github.io/org-remark/#getting-started][online]] or or Info
node `(org-remark) Getting Started'.
+Getting Started in the user manual will get you started in 5 minutes:
[[https://nobiot.github.io/org-remark/#Getting-Started][online]] or or Info
node `(org-remark) Getting Started'.
For customization, refer to the customization group `org-remark' or user
manual: [[https://nobiot.github.io/org-remark/#Customizing][online]] or Info
node `(org-remark) Customizing'.
An [[https://youtu.be/c8DHrAsFiLc][introductory video]] (8 minutes) and
[[https://youtu.be/BTFuS21N00k][V1.1.0 release introduction]] (12 minutes) are
available on YouTube.
-[fn:1]: Feature to highlight and annotate EPUB books is new in the latest
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned
to be part of v1.2.0.
-
* Features
- Highlight and annotate any text file. The highlights and notes are kept in
an Org file as the plain text database. This lets you easily manage your
marginal notes and use the built-in Org facilities on them -- e.g. create a
sparse tree based on the category of the notes
@@ -34,7 +32,9 @@ An [[https://youtu.be/c8DHrAsFiLc][introductory video]] (8
minutes) and [[https:
+ Websites when you use EWW to browse them
- + EPUB books with [[https://depp.brause.cc/nov.el/][nov.el]] (latest
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] and is planned
to be part of v1.2.0.)
+ + EPUB books with [[https://depp.brause.cc/nov.el/][nov.el]]
+
+ + Info documentation
* Screenshots and Videos :noexport:
@@ -44,8 +44,8 @@ An [[https://youtu.be/c8DHrAsFiLc][introductory video]] (8
minutes) and [[https:
[[./resources/images/2022-01-22-Context-menu.png]]
*Figure 2*. Mouse context menu with built-in ~context-menu-mode~ available
with Emacs version 28 onward
-[[./resources/images/2022-01-22-code.png]]
-*Figure 3*. Main notes can be any text files. Left: marginal notes file;
Right: an ~org-remark.el~ file with a highlight.
+[[./resources/images/2023-08-20-epub-prince-icon.png]]
+*Figure 3*. EPUB book ("Prince" by Niccolò Machiavelli via
https://www.gutenberg.org/) with icon indicating there are annotations to the
highlight: new features with v1.2.0 (2023-08-20). Left: marginal notes file
with annotations; Right: an EPUB book file with a highlight and simple ASCII
icon.
* Installation
:PROPERTIES:
@@ -76,6 +76,10 @@ After installation, we suggest you put the setup below in
your configuration.
;; Optional if you would like to highlight EPUB books via nov.el
(with-eval-after-load 'nov
(org-remark-nov-mode +1))
+
+ ;; Optional if you would like to highlight Info documentation via Info-mode
+ (with-eval-after-load 'info
+ (org-remark-info-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.
@@ -93,7 +97,8 @@ Below are example keybindings you might like to consider:
(define-key org-remark-mode-map (kbd "C-c n o") #'org-remark-open)
(define-key org-remark-mode-map (kbd "C-c n ]") #'org-remark-view-next)
(define-key org-remark-mode-map (kbd "C-c n [") #'org-remark-view-prev)
- (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove))
+ (define-key org-remark-mode-map (kbd "C-c n r") #'org-remark-remove)
+ (define-key org-remark-mode-map (kbd "C-c n d") #'org-remark-delete))
#+end_src
* Contributing and Feedback
@@ -113,7 +118,7 @@ Thank you.
- Support for websites with ~eww-mode~ by Vedang Manerikar (@vedang)
- Bug fixes ::
-Nan Jun Jie (@nanjj), @sgati-bodhi
+@alan-w-255, Nan Jun Jie (@nanjj), @sgati-bodhi
- Documentation (including README, NEWS, CHANGELOG) ::
@randomwangran, marty hiatt (@mooseyboots), @jsntn
@@ -124,14 +129,3 @@ Nan Jun Jie (@nanjj), @sgati-bodhi
* License
This work is licensed under a GPLv3 license. For a full copy of the license,
refer to [[./LICENSE][LICENSE]].
-
-* Marginal Notes :noexport:
-:PROPERTIES:
-:org-remark-file: ~/src/org-remark/org-remark.el
-:END:
-
-This section is created by Org-remark for the source file. It serves as an
example to illustrate what Org-remark can do.
-
-** defmacro org-remark-create
-
-This macro was inspired by
[[https://github.com/jkitchin/ov-highlight][Ov-highlight]]. It's by John
Kitchin (author of Org-ref). Great UX for markers with hydra. Saves the marker
info and comments directly within the Org file as Base64 encoded string. It
uses overlays with using ~ov~ package.
diff --git a/docs/org-remark.org b/docs/org-remark.org
index 7882dd60ce..956bc0a494 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.1.x
-#+macro: modified 15 July 2023
+#+macro: version 1.2.x
+#+macro: modified 20 August 2023
#+language: en
#+export_file_name: org-remark.texi
#+texinfo_dir_category: Emacs
@@ -67,9 +67,13 @@ After installation, we suggest you put the setup below in
your configuration.
;; Optional if you would like to highlight EPUB books via nov.el
(with-eval-after-load 'nov
(org-remark-nov-mode +1))
+
+ ;; Optional if you would like to highlight Info documentation via Info-mode
+ (with-eval-after-load 'info
+ (org-remark-info-mode +1))
#+end_src
-~org-remark-global-tracking-mode~ automatically turns on ~org-remark-mode~
when you open a file, website via EWW, EPUB book via nov.el [fn:1], or other
supported buffer that has a marginal notes file associated with it. This is
useful to keep the location of your highlights correct across Emacs sessions
after you shutdown Emacs.
+~org-remark-global-tracking-mode~ automatically turns on ~org-remark-mode~
when you open a file, website via EWW, EPUB book via nov.el, or other supported
buffer that has a marginal notes file associated with it. This is useful to
keep the location of your highlights correct across Emacs sessions after you
shutdown Emacs.
Unless you explicitly load ~org~ during Emacs initialization, we 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.
@@ -89,8 +93,6 @@ 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 EPUB books will be new in the latest
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]] (when the
dev/nov branch is merged with main) and is planned to be part of v1.2.0.
-
* Getting Started
:PROPERTIES:
:CUSTOM_ID: getting-started
@@ -149,13 +151,20 @@ This is all you need to get started. For more detail,
refer to the rest of this
~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]]. Org-remark can attempt to automatically
adjust the position of highlights when a websites get edited. Lear more about
the feature in [[#auto-adjust][Wha [...]
-** Highlight and Annotate EPUB Books (new feature being developed as of
2023-07-15 and available only when the branch dev/nov is merged with the main)
+** Highlight and Annotate EPUB Books
#+cindex: Highlighting EPUB Books with nov.el
#+findex: org-remark-nov-mode
~org-remark-nov-mode~ lets you highlight and annotate EPUB books 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, open a EPUB book with ~nov-mode~,
and select text and highlight it. Refer to the example of a basic setup given
in [[#installation][Installation]]. If you read books with tables, it is useful
to learn about the feature that automatically adjust the highlight positions:
[[#auto-adjust][What is Aut [...]
+** Highlight and Annotate Info documentation in ~Info-mode~
+
+#+cindex: Highlighting Info documentation with Info-mode
+#+findex: org-remark-info-mode
+
+~org-remark-info-mode~ lets you highlight and annotate Info documentation 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, open an Info node with
~Info-mode~, and select text and highlight it. Refer to the example of a basic
setup given in [[#installation][Installation]].
+
* Usage, Features, Concepts
:PROPERTIES:
:CUSTOM_ID: usage
@@ -173,7 +182,7 @@ This is all you need to get started. For more detail, refer
to the rest of this
#+findex: org-remark-mark-red-line
#+findex: org-remark-create
-~org-remark-create~ is a macro that lets create your own custom pen functions.
Org-remark comes with two additional pens that are created by default. Use them
as examples to learn how to create your own.
+~org-remark-create~ is a macro that lets you create your own custom pen
functions. Org-remark comes with two additional pens that are created by
default. Use them as examples to learn how to create your own.
#+begin_src elisp
(org-remark-create "red-line"
@@ -332,7 +341,7 @@ The delete function will prompt for confirmation if it
detects any notes present
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'.
-** What is Automatic Adjustment of Highlight Positions? (new feature being
developed as of 2023-07-15 and available only when the branch dev/nov is merged
with the main)
+** What is Automatic Adjustment of Highlight Positions?
:PROPERTIES:
:CUSTOM_ID: auto-adjust
:END:
diff --git a/resources/images/2023-08-20-epub-prince-icon.png
b/resources/images/2023-08-20-epub-prince-icon.png
new file mode 100644
index 0000000000..0f0ab8a84d
Binary files /dev/null and b/resources/images/2023-08-20-epub-prince-icon.png
differ