branch: elpa/hyperdrive
commit 4b89ff6a04faf925b91f9e5496b192414eb2ebed
Author: Joseph Turner <[email protected]>
Commit: Joseph Turner <[email protected]>
Docs: Clarify storing org links
---
doc/hyperdrive.org | 5 +++--
doc/hyperdrive.texi | 5 +++--
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 9e32b13844..83de76a4cb 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -449,8 +449,9 @@ at point by pressing ~w~ (see [[*Directory view]]).
#+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
-~CUSTOM_ID~, ~ID~, or heading text will be appended to the stored URL.
+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
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index 15bebee3cd..877ee12582 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -667,8 +667,9 @@ at point by pressing @code{w} (see @ref{Directory view}).
@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@.
+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
