[elpa] externals/org-remark ee13c91ab9 4/4: docs: update user manual

[ELPA Syncer]

branch: externals/org-remark
commit ee13c91ab9b8e2c8a3632ad98b7dd676a80cf026
Author: Noboru Ota <me@nobiot.com>
Commit: Noboru Ota <me@nobiot.com>

    docs: update user manual
---
 docs/org-remark.org | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/docs/org-remark.org b/docs/org-remark.org
index 244561167b..1771703086 100644
--- a/docs/org-remark.org
+++ b/docs/org-remark.org
@@ -110,7 +110,7 @@ To make navigation easy, you can use define the same 
"prefix key" to Org-remark
 - ~C-c n ]~: ~org-remark-view-next~
 - ~C-c n [~: ~org-remark-view-prev~
 - ~C-c n r~: ~org-remark-remove~
-- ~C-c n d~: ~org-remark-delete~  
+- ~C-c n d~: ~org-remark-delete~
 
 The ~C-c n~ part is the prefix key common to all of them. If you set the 
keybindings like this, you can use ~C-c n ]~ once to view the next highlight 
and keep pressing a single key ~]~ or ~[~ to browse through the next/previous 
highlights. After you have reached the one you like to act on, press ~o~ to 
open it, or ~r~/~d~ to remove/delete it.
 
@@ -126,7 +126,7 @@ Org-remark has a default highlighter pen function, and 
comes with a set of two a
 
 Org-remark let lets you create your own custom pen functions with 
~org-remark-create~. Use the yellow and red line pens as examples, and create 
your own. For how to do it, [[#create-custom-pens][How to Create Custom 
Highlighter Pens]].
 
-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. 
+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.
 
 * Usage
 :PROPERTIES:
@@ -176,13 +176,13 @@ Don't use =category= (all lowercase, symbol) as a 
property -- it's a special one
 #+findex: org-remark-mode
 #+vindex: org-remark-tracking-file
 
-It is recommended that ~org-remark-global-tracking-mode~ be turned on as part 
of your Emacs initialization. This should be done before you start adding 
highlights in any file. 
+It is recommended that ~org-remark-global-tracking-mode~ be turned on as part 
of your Emacs initialization. This should be done before you start adding 
highlights in any file.
 
 Once you have added highlights to some files, quit Emacs, and re-start it, 
active ~org-remark-global-tracking-mode~ will automatically turn on 
~org-remark-mode~ and load the highlights from your previous sessions for the 
files being globally tracked.
 
 When activated, ~org-remark-global-tracking-mode~ will also start remembering 
and tracking the files to which you add highlights and annotations. When you 
quit Emacs, it will save the tracked files in a file in your Emacs config 
directory (~user-emacs-directory~). By default, this file is named 
~.org-remark-tracking~ ([[#customizing][Customizing]]).
 
-Without this global minor mode, you would need to remember to activate 
~org-remark-mode~ for each file where you add highlights and annotation. This 
is often unpractical. 
+Without this global minor mode, you would need to remember to activate 
~org-remark-mode~ for each file where you add highlights and annotation. This 
is often unpractical.
 
 ** Marginal Notes File
 
@@ -202,7 +202,7 @@ Essentially, the marginal notes file is a database in the 
plain text with using
 
 You can leave the marginal notes file as it is without writing any notes. In 
this case, the entries in marginal notes file simply save the locations of your 
highlighted text. After you quit Emacs,  re-start it, and visit the same main 
file, Org-remark uses this information to highlight the text again. You can 
also directly edit the marginal notes file as a normal Org file.
 
-In addition to the properties above that Org-remark reserves for itself, you 
can add your own custom properties and ~CATEGORY~ property. Use "org-remark-" 
as the prefix to the property names (or "CATEGORY", which is the only 
exception), and Org-remark put them to the property drawer of highlight's 
headline entry in the marginal notes buffer. Define the custom properties in 
your own custom pen functions (for how to create your own pens, 
[[#create-custom-pens][How to Create Custom Highligh [...]
+In addition to the properties above that Org-remark reserves for itself, you 
can add your own custom properties and ~CATEGORY~ property. Use "org-remark-" 
as the prefix to the property names (or "CATEGORY", which is the only 
exception), and Org-remark put them to the property drawer of highlight's 
headline entry in the marginal notes buffer. Define the custom properties in 
your own custom pen functions (for how to create your own pens, 
[[#create-custom-pens][How to Create Custom Highligh [...]
 
 ** =*marginal-notes*= Buffer
 
@@ -210,7 +210,7 @@ In addition to the properties above that Org-remark 
reserves for itself, you can
 
 When you display the marginal notes with ~org-remark-view~ or 
~org-remark-open~ for a given highlight, Org-remark creates a cloned indirect 
buffer visiting the marginal notes file. By default, it is a dedicated 
side-window opened to the left part of the current frame, and it is named 
=*marginal notes*=. You can change the behavior of ~display-buffer~ function 
and the name of the buffer ([[#customizing][Customizing]]).
 
-Org-remark displays the marginal notes buffer narrowed to the highlight the 
cursor is on. 
+Org-remark displays the marginal notes buffer narrowed to the highlight the 
cursor is on.
 
 ** Other Commands
 
@@ -268,7 +268,7 @@ Org-remark's user options are available in the 
customization group ~org-remark~.
 
 - Option: ~org-remark-create-default-pen-set~ ::
   When non-nil, Org-remark creates default pen set. Set to nil if you prefer 
for it not to.
-  
+
 - Option: ~org-remark-notes-file-path~ ::
   Define the file path to store the location of highlights and write 
annotations.
   The default is one file per directory. Ensure that it is an Org file.
@@ -294,9 +294,9 @@ Org-remark's user options are available in the 
customization group ~org-remark~.
 - No export together with the main file :: There is no out-of-the-box feature 
to export marginal notes together with the main file.  Nevertheless, the 
marginal notes is a normal Org file, thus if the main file is also an Org file, 
you could use the built-in =include= feature, for example, to include relevant 
parts of the marginal notes into the export output.
 
 - Copy & pasting loses highlights :: Overlays are not part of the kill; thus 
cannot be yanked.
-  
+
 - Undo highlight does not undo it :: Overlays are not part of the undo list; 
you cannot undo highlighting. Use ~org-remark-remove~ command instead.
-  
+
 - Moving source files and remark file :: Move your files and remark file to 
another directory does not update the source path recorded in the remark file. 
It will be confusing. Try not to do it.
 
 - Marginal notes file uses absolute path :: Related to the previous 
limitation. The marginal notes file serves as the database for the highlights' 
locations and notes. The linkage back to the main note files are via absolute 
paths.  This means moving files to a different path is likely to break the the 
links.
@@ -306,14 +306,14 @@ Org-remark's user options are available in the 
customization group ~org-remark~.
 To create this package, I was inspired by the following packages. I did not 
copy any part of them, but borrowed some ideas from them -- e.g. saving the 
margin notes in a separate file.
 
 - [[https://github.com/jkitchin/ov-highlight][Ov-highlight]] :: John Kitchin's 
(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.
-  
+
 - [[https://github.com/bastibe/annotate.el][Annotate.el]] :: Bastian 
Bechtold's (author of Org-journal). Unique display of annotations right next to 
(or on top of) the text. It seems to be designed for very short annotations, 
and perhaps for code review (programming practice); I have seen recent issues 
reported when used with variable-pitch fonts (prose).
-  
+
 - 
[[https://github.com/tkf/org-mode/blob/master/contrib/lisp/org-annotate-file.el][Org-annotate-file]]
 :: Part of Org's contrib library. It seems to be designed to annotate a whole 
file in a separate Org file, rather than specific text items.
-  
+
 - [[https://github.com/IdoMagal/ipa.el][InPlaceAnnotations (ipa-mode)]] :: It 
looks similar to Annotate.el above.
-  
-- Transient navigation feature :: To implement the transient navigation 
feature, I liberally copied the relevant code from a wonderful Emacs package, 
[[https://github.com/rnkn/binder/blob/24d55db236fea2b405d4bdc69b4c33d0f066059c/binder.el#L658-L665][Binder]]
 by Paul W. Rankin (GitHub user [[https://github.com/rnkn][rnkn]]). 
+
+- Transient navigation feature :: To implement the transient navigation 
feature, I liberally copied the relevant code from a wonderful Emacs package, 
[[https://github.com/rnkn/binder/blob/24d55db236fea2b405d4bdc69b4c33d0f066059c/binder.el#L658-L665][Binder]]
 by Paul W. Rankin (GitHub user [[https://github.com/rnkn][rnkn]]).
 
 * Contributing & Feedback