如何合理的导出help link 成HTML

最新推荐文章于 2025-03-05 16:28:06 发布

原创最新推荐文章于 2025-03-05 16:28:06 发布 · 108 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#main

main 专栏收录该内容

5 篇文章

订阅专栏

本文介绍了一种方法，通过org-link-set-parameters和自定义函数org-link--export-help，使得Org文件中的help链接在导出为HTML时，不再直接显示为无效链接，而是转换为带有title属性的label。当鼠标悬停在文本上时，会显示相关帮助信息，提供更好的用户体验。

原文地址:https://www.lujun9972.win/blog/2022/05/31/如何合理的导出help-link-成html/index.html

Org 文件在导出为 html 是会将 help link 导出为一个HTTP链接，例如一个

  这是一个 [[help:lazy-helm/describe-char][Help]] link

导出成HTML时会变成

  这是一个 <a href="lazy-helm/describe-char">Help</a> link

这个操作很迷，因为实际上并没有这个链接对应的页面。

一个比较合理的方法是导出时保留原文字，但当光标移动到这段文字上去时弹出相关说明。

通过 org-link-set-parameters 可以注册自己定义的链接导出函数，相关配置如下：

(defun org-link--export-help (path desc backend &optional _)
  "Export a \"help\" type link.
PATH is a symbol name, as a string."
  (let ((info (pcase (intern path)
                ((and (pred fboundp) function) (describe-function function))
                ((and (pred boundp) variable) (describe-variable variable))
                (name (user-error "Unknown function or variable: %s" name)))))
    (quit-window)                       ;关闭新开的 help window
    (pcase backend
      ('html (format "<label title='%s'>%s</label>" info desc))
      (_ desc))))
;; 注册 help 的导出函数
(org-link-set-parameters "help"
                         :export #'org-link--export-help)

就可以导出为

这是一个 <label title='lazy-helm/describe-char is an interactive Lisp function.

It is bound to SPC h d c, M-m h d c.

(lazy-helm/describe-char)

Wrapper to ensure that ‘helm’ is loaded before calling describe-char.

'>Help</label> link

效果如下所示：