[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Exporting elisp: and shell: links
From: |
Ihor Radchenko |
Subject: |
Re: Exporting elisp: and shell: links |
Date: |
Sun, 08 Oct 2023 09:48:07 +0000 |
Rudolf Adamkovič <salutis@me.com> writes:
>> Still, it would be nice to have _a_ variant compared to the current
>> state of affairs.
>
> Agreed. If the link has no description, we can do a great job on
> exporting it. Half of the victory, right there!
>
> Also, how about the following /simple/ idea for the description:
>
> [[elisp:(server-start)][Launch Server]]
> [[elisp:(server-start)][=M-x server-start RET=]]
>
> src_elisp[:exports code]{(server-start)} (Launch Server)
> src_elisp[:exports code]{(server-start)} (=M-x server-start RET=)
>
> TL;DR We export the description, if any, in parentheses after the code.
See the attached diff, implementing your suggestion.
I am not sure if I like it.
Consider the following example file:
----
#+options: toc:nil author:nil
[[elisp:(message "Hello")]]
[[elisp:(message "Hello")][Message Hello]]
----
Without the diff, exporting to ASCII yields
----
<elisp:(message "Hello")>
[Message Hello]
[Message Hello] <elisp:(message "Hello")>
----
with the diff:
----
`(message "Hello")'
`(message "Hello")' (Message Hello)
---
For markdown:
without diff:
---
<(message "Hello")>
[Message Hello]((message "Hello"))
---
with:
---
`(message "Hello")`
`(message "Hello")` (Message Hello)
---
For html:
without diff:
with:
diff --git a/lisp/ol.el b/lisp/ol.el
index 20aab6bb8..d537709ac 100644
--- a/lisp/ol.el
+++ b/lisp/ol.el
@@ -1377,7 +1377,29 @@ (defun org-link--open-elisp (path _)
(call-interactively (read path))))
(user-error "Abort")))
-(org-link-set-parameters "elisp" :follow #'org-link--open-elisp)
+(defun org-link--export-code (path description _ info &optional lang)
+ "Export executable link with PATH and DESCRIPTION.
+INFO is the current export info plist.
+LANG is the language name, as in #+begin_src lang. For example, \"elisp\"
+or \"shell\"."
+ (concat
+ (org-export-data
+ (org-element-create
+ 'inline-src-block
+ `( :language ,lang
+ :value ,path
+ :parameters ":exports code :noweb no :eval never"))
+ info)
+ (when description (format " (%s)" description))))
+
+(defun org-link--export-elisp (path description _ info)
+ "Export elisp: link with PATH and DESCRIPTION according to INFO channel."
+ (org-link--export-code path description nil info "emacs-lisp"))
+
+(org-link-set-parameters
+ "elisp"
+ :follow #'org-link--open-elisp
+ :export #'org-link--export-elisp)
;;;; "file" link type
(org-link-set-parameters "file" :complete #'org-link-complete-file)
@@ -1435,7 +1457,14 @@ (defun org-link--open-shell (path _)
clean-buffer-list-kill-buffer-names))))
(user-error "Abort")))
-(org-link-set-parameters "shell" :follow #'org-link--open-shell)
+(defun org-link--export-shell (path description _ info)
+ "Export shell: link with PATH and DESCRIPTION according to INFO channel."
+ (org-link--export-code path description nil info "shell"))
+
+(org-link-set-parameters
+ "shell"
+ :follow #'org-link--open-shell
+ :export #'org-link--export-shell)
;;; Interactive Functions
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
- Re: Exporting elisp: and shell: links,
Ihor Radchenko <=
Re: Exporting elisp: and shell: links, Rudolf Adamkovič, 2023/10/11