branch: elpa/hyperdrive commit 68668241f073dd3733c9fc42b73600432b39cf74 Author: Joseph Turner <jos...@ushin.org> Commit: Joseph Turner <jos...@ushin.org>
Docs: Document org-transclusion installation and usage --- doc/hyperdrive.org | 23 +++++++++++++++++++++++ doc/hyperdrive.texi | 26 ++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org index d29e2eab48..1e32421e19 100644 --- a/doc/hyperdrive.org +++ b/doc/hyperdrive.org @@ -743,6 +743,29 @@ only those files in ~~/blog/~ which are smaller than 5MB: (file-attributes file))))) #+end_src +** Org-transclusion integration + +The [[https://git.sr.ht/~ushin/hyperdrive-org-transclusion][hyperdrive-org-transclusion]] package adds support for transcluding +hyperdrive files and parts of hyperdrive files with [[https://nobiot.github.io/org-transclusion/][org-transclusion]]. + +To use this feature, please install ~hyperdrive-org-transclusion~ with +~M-x package-install RET hyperdrive-org-transclusion~ and then add the +following snippet to your configuration: + +#+begin_src emacs-lisp + (add-to-list 'org-transclusion-extensions 'hyperdrive-org-transclusion) + (with-eval-after-load 'org-transclusion + (require 'hyperdrive-org-transclusion)) +#+end_src + +You can then run ~M-x org-transclusion-add~ on the following link to +transclude the Org heading with the property ~CUSTOM_ID: emacs~ inside +the ~/software.org~ file inside the USHIN hyperdrive: + +#+begin_example +#+transclude: [[hyper://aaj45d88g4eenu76rpmwzjiabsof1w8u6fufq6oogyhjk1ubygxy/software.org#%3A%3A%23emacs]] +#+end_example + ** Miscellaneous features *** Find file at point integration diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi index 402f9e26ab..43109b4026 100644 --- a/doc/hyperdrive.texi +++ b/doc/hyperdrive.texi @@ -91,6 +91,7 @@ Usage * Upload files from your filesystem:: * Purge a hyperdrive:: * Non-interactive use:: +* Org-transclusion integration:: * Miscellaneous features:: Open a hyperdrive @@ -276,6 +277,7 @@ On the network it still may be there. * Upload files from your filesystem:: * Purge a hyperdrive:: * Non-interactive use:: +* Org-transclusion integration:: * Miscellaneous features:: @end menu @@ -1041,6 +1043,30 @@ only those files in @code{~/blog/} which are smaller than 5MB: (file-attributes file))))) @end lisp +@node Org-transclusion integration +@section Org-transclusion integration + +The @uref{https://git.sr.ht/~ushin/hyperdrive-org-transclusion, hyperdrive-org-transclusion} package adds support for transcluding +hyperdrive files and parts of hyperdrive files with @uref{https://nobiot.github.io/org-transclusion/, org-transclusion}. + +To use this feature, please install @code{hyperdrive-org-transclusion} with +@code{M-x package-install RET hyperdrive-org-transclusion} and then add the +following snippet to your configuration: + +@lisp +(add-to-list 'org-transclusion-extensions 'hyperdrive-org-transclusion) +(with-eval-after-load 'org-transclusion + (require 'hyperdrive-org-transclusion)) +@end lisp + +You can then run @code{M-x org-transclusion-add} on the following link to +transclude the Org heading with the property @code{CUSTOM_ID: emacs} inside +the @code{/software.org} file inside the USHIN hyperdrive: + +@example +#+transclude: [[hyper://aaj45d88g4eenu76rpmwzjiabsof1w8u6fufq6oogyhjk1ubygxy/software.org#%3A%3A%23emacs]] +@end example + @node Miscellaneous features @section Miscellaneous features