branch: externals/org-remark
commit c8bbe514119bacfcbaf5ccec594437b034e6084e
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
doc: Fix some documentation errors
---
README.org | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index b74bd7bfd1..f46f8beebf 100644
--- a/README.org
+++ b/README.org
@@ -6,12 +6,12 @@
# Note: I use the readme template that alphapapa shares on his GitHub repo
<https://github.com/alphapapa/emacs-package-dev-handbook#template>. It works
with the org-make-toc <https://github.com/alphapapa/org-make-toc> package,
which automatically updates the table of contents.
-Org-marginalia lets you write margin notes (marginalia) for any text files in
a separate Org file.
+Org-marginalia lets you highlight text, and write margin notes (marginalia)
for any text file in a separate Org file.
* Screenshots
[[./resources/images/2020-12-22T141331-OM-screen-shot-01.png]]
-*Figure 1*. Left: main note; Right: margin notes in its marginalia file
+*Figure 1*. Left: main note; Right: margin notes in a marginalia file
[[./resources/images/2020-12-22T141331-OM-screen-shot-02.png]]
*Figure 2*. It automatically adds the standard Org Mode link to margin notes,
so it works well with Org-roam's backlinks
@@ -40,8 +40,7 @@ Org-marginalia lets you write margin notes (marginalia) for
any text files in a
:END:
** Manual
-This package is not available on MELPA. Manual installation is required.
-Ensure to have Org Mode 9.4 or later (tested on 9.4.2). This package uses
~org-collect-keywords~, which does not exist in an earlier version.
+This package is not available on MELPA. Manual installation is required.
Ensure to have Org Mode 9.4 or later (tested on 9.4.2). This package uses
~org-collect-keywords~, which does not exist in an earlier version.
Then store =org-marginalia.el= in your load-path, and put this in your init
file:
@@ -64,19 +63,19 @@ For example, I use this in my init file. Org-marginalia is
a local minor mode. A
:END:
- =org-marginalia-mode= ::
-Org-marginalia is a local minor mode. Toggle it on/off with using
=org-marginalia-mode=. On activating, it loads your saved highlights from the
marginalia file, and enables automatic saving of highlights. The automatic
saving is achieved via function =om/save= added to =after-save-hook=.
+Org-marginalia is a local minor mode. Toggle it on/off with using
=org-marginalia-mode=. On activating, it loads your saved highlights from the
marginalia file (defined by =om/notes-file-path=), and enables automatic saving
of highlights. The automatic saving is achieved via function =om/save= added to
=after-save-hook=.
- =om/mark= (=C-c m= by default) ::
-Select a region of text, and call =om/mark= to highlight the region. It will
generate a new ID, and start tracking the location -- so you can edit text
around the marked text. Do not copy and paste as it will disappear and it is a
bit tricky to recover the highlights. To create a new margin note entry in the
marginalia file, save the buffer.
+Select a region of text, and call =om/mark= to highlight the region. It will
generate a new ID, and start tracking the location -- so you can edit text
around the highlighted text. Do not cut, copy and paste as the highlight will
disappear and it is a bit tricky to recover it. To create a new margin note
entry in the marginalia file, save the buffer.
- =om/save= ::
By default, Org-marginalia automatically creates or updates corresponding
entries in the marginalia file with location and text of highlights on saving
the buffer. Nevertheless, you can manually call =om/save= to do so (automatic
process also call this command).
- =om/open= (=C-c n o= by default) ::
-Move your cursor on the highlighted text, and call =om/open= to open the
relevant margin notes in a separate window. Your cursor will move to the
marginalia buffer narrowed to the relevant margin notes entry. You can edit the
margin notes as a normal Org file. Once you have done editing, you may simply
save and close the buffer (kill or close the window) as per your normal
workflow. Technically, the marginalia buffer is a cloned indirect buffer of the
marginalia file.
+Move your cursor on the highlighted text, and call =om/open= to open the
relevant margin notes in a separate window. Your cursor will move to the
marginalia buffer narrowed to the relevant margin notes entry. You can edit the
marginalia buffer as a normal Org buffer. Once you have done editing, you may
simply save and close the it (kill it or close the window) as per your normal
workflow. Technically, the marginalia buffer is a cloned indirect buffer of the
marginalia file.
- =om/load= ::
-This command visits the marginalia file and load the saved highlights onto the
current buffer. If there is no margin notes for it, it will output a message in
the echo. Highlights tracked locally by Org-marginalia cannot persist when you
kill the buffer, or quit Emacs. When you re-launch Emacs, ensure to turn on
=org-marginalia-mode= to load the highlights. Load is automatically done when
you activate the minor mode.
+This command visits the marginalia file and loads the saved highlights onto
the current buffer. If there is no margin notes for it, it will output a
message in the echo. Highlights tracked locally by Org-marginalia cannot
persist when you kill the buffer, or quit Emacs. When you re-launch Emacs,
ensure to turn on =org-marginalia-mode= to load the highlights. Loading is
automatically done when you activate the minor mode.
- =om/remove= ::
This command removes the highlight at point. It will remove the highlight, and
remove the properties from the marginalia, but will keep the headline and notes
in tact.
@@ -90,8 +89,8 @@ Move to the previous highlight if any. If there is none above
the cursor, and th
* Customizing
- You can customize settings in the =org-marginalia= group.
-- Highlight face can be changed via =om/highlight=
-- Marginalia file is defined with =om/notes-file-path=
+- Highlight's face can be changed via =om/highlighter=
+- Marginalia file is defined by =om/notes-file-path=
* Known Limitations
