[nongnu] elpa/hyperdrive 626b8bd3a5 12/15: Docs: Improve documentation for links

[ELPA Syncer]

branch: elpa/hyperdrive
commit 626b8bd3a5cf98acad98304ddf3bf0fa046a177a
Author: Joseph Turner <joseph@ushin.org>
Commit: Joseph Turner <joseph@ushin.org>

    Docs: Improve documentation for links
---
 doc/hyperdrive.org  | 31 ++++++++++++++++++++++---------
 doc/hyperdrive.texi | 31 ++++++++++++++++++++++---------
 2 files changed, 44 insertions(+), 18 deletions(-)

diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 5c9ae8bd44..7be735822b 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -402,15 +402,22 @@ new content.
   where you want to store the file.
 
 ** Link to a hyperdrive
-#+findex: hyperdrive-copy-url
-#+findex: hyperdrive-dir-copy-url
 
-In the directory view, you can copy the URL at point with
-~hyperdrive-dir-copy-url~ (see [[*Directory view]]). Additionally, you can
-run ~hyperdrive-copy-url~ to copy the URL of the current hyperdrive
-file or directory.
+You can share a hyperdrive file with someone by copying and sending
+its link.  Anyone who has the link to a hyperdrive file or directory
+can load it and view its contents.
+
+- Command: hyperdrive-copy-url ::
+
+  Copy the URL of the current hyperdrive file or directory.
+
+In the directory view, you can copy the URL of the file or directory
+at point by pressing ~w~ (see [[*Directory view]]).
 
 *** Org mode links
+#findex: org-store-link
+#findex: org-insert-link
+#vindex: org-link-file-path-type
 
 If the current file is an org-mode file, ~org-store-link~ will store a
 link to the hyperdrive file, and if point is inside a heading, its
@@ -432,11 +439,17 @@ in org-mode), then typing ~hyper:~ and ~RET~.  To change 
how
 ~org-insert-link~ inserts links to files within the same hyperdrive,
 adjust ~hyperdrive-org-link-full-url~ and ~org-link-file-path-type~.
 
+- User Option: hyperdrive-org-link-full-url ::
+
+  This option controls whether relative links to hyperdrives are ever
+  inserted with ~org-insert-link~.  Set it to ~t~ if you always want to
+  insert full ~hyper://~ links.
+
 *** Markdown links
 
 Relative links are supported; within ~hyper://PUBLIC-KEY/foo.md~, the
-links ~[bar](<bar.md>)~, ~[bar](<./bar.md>)~, and ~[bar](</bar.md>)~ will
-all point to ~hyper://PUBLIC-KEY/bar.md~.
+links ~[bar](<bar.md>)~, ~[bar](<./bar.md>)~, and ~[bar](</bar.md>)~ all
+point to ~hyper://PUBLIC-KEY/bar.md~.
 
 ** Delete a hyperdrive file
 #+findex: hyperdrive-delete
@@ -931,7 +944,7 @@ customize-group RET hyperdrive RET~:
 
 - User Option: hyperdrive-honor-auto-mode-alist ::
 
-  If non-nil, use file extension of hyperdrive file to set ~major-mode~.
+  If non-~nil~, use file extension of hyperdrive file to set ~major-mode~.
   Defaults to ~t~.
 
 - User Option: hyperdrive-persist-location ::
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 43544314bc..1aac07ec54 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -655,13 +655,16 @@ where you want to store the file.
 @node Link to a hyperdrive
 @section Link to a hyperdrive
 
-@findex hyperdrive-copy-url
-@findex hyperdrive-dir-copy-url
+You can share a hyperdrive file with someone by copying and sending
+its link.  Anyone who has the link to a hyperdrive file or directory
+can load it and view its contents.
+
+@deffn Command hyperdrive-copy-url
+Copy the URL of the current hyperdrive file or directory.
+@end deffn
 
-In the directory view, you can copy the URL at point with
-@code{hyperdrive-dir-copy-url} (see @ref{Directory view}). Additionally, you 
can
-run @code{hyperdrive-copy-url} to copy the URL of the current hyperdrive
-file or directory.
+In the directory view, you can copy the URL of the file or directory
+at point by pressing @code{w} (see @ref{Directory view}).
 
 @menu
 * Org mode links::
@@ -671,6 +674,10 @@ file or directory.
 @node Org mode links
 @subsection Org mode links
 
+#findex: org-store-link
+#findex: org-insert-link
+#vindex: org-link-file-path-type
+
 If the current file is an org-mode file, @code{org-store-link} will store a
 link to the hyperdrive file, and if point is inside a heading, its
 @code{CUSTOM_ID}, @code{ID}, or heading text will be appended to the stored 
URL@.
@@ -691,12 +698,18 @@ in org-mode), then typing @code{hyper:} and @code{RET}.  
To change how
 @code{org-insert-link} inserts links to files within the same hyperdrive,
 adjust @code{hyperdrive-org-link-full-url} and @code{org-link-file-path-type}.
 
+@defopt hyperdrive-org-link-full-url
+This option controls whether relative links to hyperdrives are ever
+inserted with @code{org-insert-link}.  Set it to @code{t} if you always want to
+insert full @code{hyper://} links.
+@end defopt
+
 @node Markdown links
 @subsection Markdown links
 
 Relative links are supported; within @code{hyper://PUBLIC-KEY/foo.md}, the
-links @code{[bar](<bar.md>)}, @code{[bar](<./bar.md>)}, and 
@code{[bar](</bar.md>)} will
-all point to @code{hyper://PUBLIC-KEY/bar.md}.
+links @code{[bar](<bar.md>)}, @code{[bar](<./bar.md>)}, and 
@code{[bar](</bar.md>)} all
+point to @code{hyper://PUBLIC-KEY/bar.md}.
 
 @node Delete a hyperdrive file
 @section Delete a hyperdrive file
@@ -1328,7 +1341,7 @@ Port on which to run the hyper-gateway server.  Defaults 
to @code{4973}.
 @end defopt
 
 @defopt hyperdrive-honor-auto-mode-alist
-If non-nil, use file extension of hyperdrive file to set @code{major-mode}.
+If non-@code{nil}, use file extension of hyperdrive file to set 
@code{major-mode}.
 Defaults to @code{t}.
 @end defopt