branch: elpa/hyperdrive
commit 59a70f9127b77fe3997652af58779dbd97af8193
Author: Joseph Turner <jos...@ushin.org>
Commit: Joseph Turner <jos...@ushin.org>
Docs: Update documentation about file:-prefixed links
---
doc/hyperdrive.org | 15 ++++++---------
doc/hyperdrive.texi | 15 ++++++---------
2 files changed, 12 insertions(+), 18 deletions(-)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index d1808c8366..1647c6750e 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -420,15 +420,12 @@ link to the hyperdrive file. If point is inside a
heading, a
URL-encoded search option containing its ~CUSTOM_ID~, ~ID~, or heading
text will be appended as the stored URL's link fragment.
-Relative links are supported; within ~hyper://PUBLIC-KEY/foo.org~, links
-to ~bar.org~, ~./bar.org~, and ~/bar.org~ will all point to
-~hyper://PUBLIC-KEY/bar.org~. A version number can also be specified;
-~/$/version/42/bar.org~ will point to
-~hyper://PUBLIC-KEY/$/version/42/bar.org~.
-
-To link from a hyperdrive-mode org buffer to a file on the local
-filesystem, explicitly add the ~file:~ link type prefix:
-~file:~/.emacs.d/init.el~.
+Linking by path alone to other files within the same hyperdrive are
+supported; within ~hyper://PUBLIC-KEY/foo.org~, links to ~bar.org~,
+~./bar.org~, and ~/bar.org~ will all point to ~hyper://PUBLIC-KEY/bar.org~.
+Links within a hyperdrive may also begin with the explicit ~file:~
+prefix. A version number can also be specified; ~/$/version/42/bar.org~
+will point to ~hyper://PUBLIC-KEY/$/version/42/bar.org~.
Org-mode hyperdrive link completion allows you to interactively link
to a hyperdrive file/folder by running ~M-x org-insert-link~ (or ~C-c C-l~
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 6aada00a40..ea20dfc44d 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -689,15 +689,12 @@ link to the hyperdrive file. If point is inside a
heading, a
URL-encoded search option containing its @code{CUSTOM_ID}, @code{ID}, or
heading
text will be appended as the stored URL's link fragment.
-Relative links are supported; within @code{hyper://PUBLIC-KEY/foo.org}, links
-to @code{bar.org}, @code{./bar.org}, and @code{/bar.org} will all point to
-@code{hyper://PUBLIC-KEY/bar.org}. A version number can also be specified;
-@code{/$/version/42/bar.org} will point to
-@code{hyper://PUBLIC-KEY/$/version/42/bar.org}.
-
-To link from a hyperdrive-mode org buffer to a file on the local
-filesystem, explicitly add the @code{file:} link type prefix:
-@code{file:~/.emacs.d/init.el}.
+Linking by path alone to other files within the same hyperdrive are
+supported; within @code{hyper://PUBLIC-KEY/foo.org}, links to @code{bar.org},
+@code{./bar.org}, and @code{/bar.org} will all point to
@code{hyper://PUBLIC-KEY/bar.org}.
+Links within a hyperdrive may also begin with the explicit @code{file:}
+prefix. A version number can also be specified; @code{/$/version/42/bar.org}
+will point to @code{hyper://PUBLIC-KEY/$/version/42/bar.org}.
Org-mode hyperdrive link completion allows you to interactively link
to a hyperdrive file/folder by running @code{M-x org-insert-link} (or
@code{C-c C-l}
