NonGNU-devel ELPA - org-transclusion-http

org-transclusion-http Atom Feed

Description
Transclude over HTTP
Latest
org-transclusion-http-0.5pre0.20240630.140904.tar (.sig), 2024-Jul-01, 30.0 KiB
Maintainer
Joseph Turner <~ushin/ushin@lists.sr.ht>
Website
https://git.sr.ht/~ushin/org-transclusion-http
Browse ELPA's repository
CGit or Gitweb
Badge

To install this package from Emacs, use package-install or list-packages.

Full description

org-transclusion-http

Transclude content over HTTP in Org mode with org-transclusion!

Dependencies

org-transclusion-http uses Pandoc to render HTML content as Org mode, so to make full use of this package please ensure that the pandoc command is installed and in your PATH.

Installation

Install org-transclusion-http with M-x package-install RET org-transclusion-http and then add the following snippet to your configuration: 

(with-eval-after-load 'org-transclusion
  (add-to-list 'org-transclusion-extensions 'org-transclusion-http)
  (require 'org-transclusion-http))

Usage

Add an org-transclusion link to an Org mode buffer: 

#+transclude: [[https://ushin.org/software.html]]

Then move point onto the link, and run M-x org-transclusion-add. Emacs will download the webpage and convert its HTML content to Org mode with Pandoc before displaying as an Org subtree in the same buffer.

org-transclusion-http also handles non-HTML content, which will be rendered as-is.

For more information on org-transclusion, please see the org-transclusion manual.

Transclude only content at HTML link fragment

When the #+transclude: link contains a link fragment, also known as an anchor or target, org-transclusion-http attempts to guess which HTML element(s) to transclude: 

#+transclude: [[https://ushin.org/needs-list.html#care]] # Just "Care" subtree
#+transclude: [[https://ushin.org/needs-list.html]]      # Whole file

To improve org-transclusion's ability to determine which HTML elements to transclude based on the element its link fragment points to, please patch the org-transclusion-html.el file in org-transclusion itself.

For more usage examples, please see the tests.

Limitations

Certain features of org-transclusion, such as live-syncing and opening source buffers, are not supported.

:lines are not yet supported. Patches welcome!

Bugs and Patches

Bugs can be submitted to the ushin issue tracker. Patches, comments or questions can be submitted to the ushin public inbox.

Acknowledgments

Changelog

0.5-pre

Nothing yet…

0.4
  • Fix
    • Fix byte compilation error. Thanks to Chris Rayner for reporting!
0.3
  • Internal
    • Prepare for NonGNU ELPA submission.
0.2
  • Change
    • Better error message when pandoc is not available.
  • Fix
    • Don't prompt to stop HTTP transclusion process when killing Emacs.
  • Internal
    • Better recognition of Org and HTML documents.
    • Update to match upstream org-transclusion API.
    • More tests.
0.1

Initial release.

Old versions

org-transclusion-http-0.5pre0.20240619.143021.tar.lz2024-Jun-204.75 KiB
org-transclusion-http-0.4pre0.20240616.230836.tar.lz2024-Jun-174.69 KiB
org-transclusion-http-0.4pre0.20240615.114548.tar.lz2024-Jun-154.67 KiB