[elpa] externals/org-remark 6abbb84733: docs: user manual org-remark-notes-file-name

[ELPA Syncer]

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

    docs: user manual org-remark-notes-file-name
---
 docs/org-remark.org | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/docs/org-remark.org b/docs/org-remark.org
index d6a24287d1..846a88f419 100644
--- a/docs/org-remark.org
+++ b/docs/org-remark.org
@@ -194,7 +194,7 @@ Without this global minor mode, you would need to remember 
to activate ~org-rema
 #+cindex: Marginal notes file
 #+cindex: Org-remark properties for highlights
 
-When you mark a part of text with a highlighter pen function, Org-remark will 
automatically create a *marginal notes file*. By default, it will be named 
~marginalia.org~ and created in the same directory as the file you are editing 
([[#customizing][Customizing]]).
+When you mark a part of text with a highlighter pen function, Org-remark will 
automatically create a *marginal notes file*. By default, it will be named 
~marginalia.org~ and created in the same directory as the file you are editing 
([[#customizing][Customizing]]; see ~org-remark-notes-file-name~).
 
 The important thing to note is that Org-remark uses following properties in 
the property drawer of the headline to remember the highlights:
 
@@ -231,6 +231,8 @@ Org-remark displays the marginal notes buffer narrowed to 
the highlight the curs
 
 *** How to Store Marginal Notes in the Source File
 
+#+vindex: org-remark-notes-file-name
+
 The location of the marginal notes file is specified by user option 
~org-remark-notes-file-name~ and its default is "marginalia.org". This means 
the marginal notes file will reside in the same directory as the source files 
as a separate file.
 
 ~org-remark-notes-file-name~ can also take a function as a value, so you have 
a wide range of customizability. In ~customize~, the default function to be 
used is ~org-remark-notes-file-name-function~. It adds =-notes.org= as a suffix 
to the source file's name without the extension. For example, for a file named 
=my-main-file.txt=,  Org-remark will store highlights in  
=my-main-file-notes.org=.
@@ -328,8 +330,7 @@ Org-remark's user options are available in the 
customization group ~org-remark~.
 
 - Option: ~org-remark-notes-file-name~ ::
   Name of the file where we store highlights and marginal notes. It can be 
either a string or function.
-  If it is a string, it should be a file name to the marginal notes
-file. The default is =marginalia.org=.  The default will result in one 
marginal notes file per directory.  Ensure that it is an Org file.
+  If it is a string, it should be a file name to the marginal notes file. The 
default is =marginalia.org=.  The default will result in one marginal notes 
file per directory.  Ensure that it is an Org file.
   If it is a function, the default function is 
~org-remark-notes-file-name-function~.  It returns a file name like this: 
=FILE-notes.org= by adding =-notes.org= as a suffix to the file name without 
the extension.
 
 - Option: ~org-remark-notes-display-buffer-action~ ::
@@ -354,7 +355,7 @@ file. The default is =marginalia.org=.  The default will 
result in one marginal
 
 - Undo highlight does not undo it :: Overlays are not part of the undo list; 
you cannot undo highlighting. Use ~org-remark-remove~ or ~org-remark-delete~ 
commands instead.
 
-- Moving source files and remark file :: Moving your files and remark file to 
another directory does not update the source paths and file names stored in the 
marginal notes file. One way to keep the links between the source files and 
marginal notes files is to use relative file names with 
~org-remark-source-file-name~ (default).
+- Moving source files and marginal notes files :: Moving your files and remark 
file to another directory does not update the source paths and file names 
stored in the marginal notes file. One way to keep the links between the source 
files and marginal notes files is to use relative file names with 
~org-remark-source-file-name~ (default).
 
 * Credits