[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org-remark 36df818752 55/67: docs: Update user manaul
From: |
ELPA Syncer |
Subject: |
[elpa] externals/org-remark 36df818752 55/67: docs: Update user manaul |
Date: |
Sat, 22 Jul 2023 06:59:04 -0400 (EDT) |
branch: externals/org-remark
commit 36df818752545bb5416d8eecd2dec1c17559b90e
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>
docs: Update user manaul
---
docs/org-remark.org | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/docs/org-remark.org b/docs/org-remark.org
index d2396237e4..ca78fb527d 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 July 2023
+#+macro: version 1.1.x
+#+macro: modified 15 July 2023
#+language: en
#+export_file_name: org-remark.texi
#+texinfo_dir_category: Emacs
@@ -10,11 +10,11 @@
#+texinfo: @paragraphindent asis
#+options: toc:nil ':t
-This manual is for Org-remark version {{{version}}}.
+This manual is for Org-remark version {{{version}}}. Some new features are
mentioned in this manual that are currently in development; these are mentioned
clearly as such.
Last updated: {{{modified}}}.
-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 (EWW).
#+texinfo: @insertcopying
@@ -142,12 +142,19 @@ Org-remark lets you create your own custom pen functions
with ~org-remark-create
This is all you need to get started. For more detail, refer to the rest of
this user manual, especially [[#usage][Usage]] and
[[#customizing][Customizing]] sections. There is more to the commands
introduced in this section and more ways in which you can customize Org-remark.
-** Highlight and Annotate Websites (new in latest
[[https://elpa.gnu.org/devel/org-remark.html][GNU-devel ELPA]]; to be part of
v1.1.0)
+** Highlight and Annotate Websites
#+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][Installation]].
+~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)
+
+#+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 [...]
* Usage, Features, Concepts
:PROPERTIES:
@@ -250,8 +257,6 @@ 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
part of v1.1.0.
-
*** How to Change Where Marginal Notes File is Saved
:PROPERTIES:
:CUSTOM_ID: change-marginal-notes-filename
@@ -327,7 +332,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?
+** 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)
:PROPERTIES:
:CUSTOM_ID: auto-adjust
:END:
- [elpa] externals/org-remark 3216d951fc 09/67: feat: nov.el title and nov-file-name in H1 of the notes, (continued)
- [elpa] externals/org-remark 3216d951fc 09/67: feat: nov.el title and nov-file-name in H1 of the notes, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 81bc062482 10/67: refactor(nov): highlight-save-book-entry, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark eed28d7b8d 26/67: Merge branch 'main' into dev/nov.el, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark e5de684b67 33/67: fix: adjust location of highlight, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 5b76fa930a 49/67: refactor(load): make load process robust., ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark b50d0f7688 52/67: refactor: rename highlights-after-load-hook to -functions, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 07f5838c40 61/67: fix: Add headlines in the correct order and in the correct headline, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 6ebbce9239 37/67: fix(load): clear obsolete highlight overlays before loading, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 0ec9d2f1c2 41/67: refactor(headline-add): WIP, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 1c2f9ed822 46/67: feat: toggle icons, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 36df818752 55/67: docs: Update user manaul,
ELPA Syncer <=
- [elpa] externals/org-remark 642d4b489f 13/67: docs: updated NEWS, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 2a10b3d75a 17/67: refactor: adjust-positions, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 09d95e7519 20/67: Merge branch 'main' into dev/nov.el, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 52bc575bb9 28/67: docs: comments and docstring, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark e10a00b426 35/67: feat: add icon for highlights with annotation body text #64, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 41f90c53a8 59/67: refactor: Add 'org-remark-string=' for highlight-adjust-positions, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 2bd53de493 60/67: refactor: Set fn to hook org-remark-highlights-after-load-functions, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark e1b7a3a1ba 19/67: Merge remote-tracking branch 'sati-bodhi/main' into dev/nov.el, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark 090156bed2 21/67: feat: org-remark-nov-mode minor mode, ELPA Syncer, 2023/07/22
- [elpa] externals/org-remark ef7e02d542 34/67: fix: annotation body to be nil when no body text, ELPA Syncer, 2023/07/22