From 19f6da95e36dcd555159c98cf6f26f5ea0d1d548 Mon Sep 17 00:00:00 2001 From: Joseph Turner Date: Sat, 24 Feb 2024 01:01:12 -0800 Subject: [PATCH] docs: Note missing asynchronous functionality --- docs/org-transclusion-manual.org | 4 ++-- org-transclusion.el | 13 ++++++++++--- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/org-transclusion-manual.org b/docs/org-transclusion-manual.org index bca7e04..1319593 100644 --- a/docs/org-transclusion-manual.org +++ b/docs/org-transclusion-manual.org @@ -1,7 +1,7 @@ #+title: Org-transclusion User Manual #+author: Noboru Ota #+macro: version 1.3.x -#+macro: modified 22 February 2024 +#+macro: modified 05 April 2024 #+language: en #+export_file_name: org-transclusion.texi @@ -195,7 +195,7 @@ It is generally assumed that the =paragraph-id= is placed after its content, but For the =:only-contents= property, refer to sub-section [[#filtering-org-elements-per-transclusion][Filtering Org elements per transclusion]]. -** Links with hyper://, http://, and other protocols +** Links with ~hyper://~, ~http://~, and other protocols :PROPERTIES: :CUSTOM_ID: other-protocols :END: diff --git a/org-transclusion.el b/org-transclusion.el index ccd3996..1fd402c 100644 --- a/org-transclusion.el +++ b/org-transclusion.el @@ -609,7 +609,9 @@ the rest of the buffer unchanged." list))) (defun org-transclusion-refresh (&optional detach) - "Refresh the transcluded text at point." + "Refresh the transcluded text at point. + +TODO: Support asynchronous transclusions (set point correctly)." (interactive "P") (when (org-transclusion-within-transclusion-p) (let ((pos (point))) @@ -631,7 +633,10 @@ the rest of the buffer unchanged." (defun org-transclusion-open-source (&optional arg) "Open the source buffer of transclusion at point. When ARG is non-nil (e.g. \\[universal-argument]), the point will -remain in the source buffer for further editing." +remain in the source buffer for further editing. + +TODO: Support asynchronous transclusions when source buffer +doesn't exist." (interactive "P") (unless (overlay-buffer (get-text-property (point) 'org-transclusion-pair)) (org-transclusion-refresh)) @@ -687,7 +692,9 @@ a couple of org-transclusion specific keybindings; namely: - `org-transclusion-live-sync-paste' - `org-transclusion-live-sync-exit' -\\{org-transclusion-live-sync-map}" +\\{org-transclusion-live-sync-map} + +TODO: Support asynchronous transclusions." (interactive) (if (not (org-transclusion-within-transclusion-p)) (progn (message (format "Nothing done. Not a translusion at %d" (point)))