Hyperbole 隐式按钮：构建你的 Hyperverse

# Hyperbole 隐式按钮：构建你的超宇宙 来源：https://www.chiply.dev/post-hyperbole-implicit-buttons Hyperbole 隐式按钮：构建你的超宇宙 ## 目录 - 1\. 太长不看 (https://www.chiply.dev/post-hyperbole-implicit-buttons#tldr) - 2\. 关于 Emacs Hyperbole 隐式按钮 (https://www.chiply.dev/post-hyperbole-implicit-buttons#about) - 3\. 推销 Hyperbole 隐式按钮 (https://www.chiply.dev/post-hyperbole-implicit-buttons#the-pitch) - 4\. 识别器与动作 (https://www.chiply.dev/post-hyperbole-implicit-buttons#recognizers-and-actions) - 5\. 内置类型巡览 (https://www.chiply.dev/post-hyperbole-implicit-buttons#tour) - 6\. 这次按键会做什么？ (https://www.chiply.dev/post-hyperbole-implicit-buttons#action-key-help) - 7\. 级联机制 (https://www.chiply.dev/post-hyperbole-implicit-buttons#cascade) - 8\. 手动创建按钮 (https://www.chiply.dev/post-hyperbole-implicit-buttons#buttons-by-hand) - 9\. 创建自己的按钮类型 (https://www.chiply.dev/post-hyperbole-implicit-buttons#roll-your-own) - 9\.1\. `defal`：定义动作链接 (https://www.chiply.dev/post-hyperbole-implicit-buttons#org930f376) - 9\.2\. `defil`：定义隐式链接 (https://www.chiply.dev/post-hyperbole-implicit-buttons#orged70b6c) - 9\.3\. `defib`：定义隐式按钮 (https://www.chiply.dev/post-hyperbole-implicit-buttons#org4018cee) - 9\.4\. 关于按钮制作的结语 (https://www.chiply.dev/post-hyperbole-implicit-buttons#org84f89dd) - 10\. 尝试使用 (https://www.chiply.dev/post-hyperbole-implicit-buttons#try-it) - 11\. 延伸阅读 (https://www.chiply.dev/post-hyperbole-implicit-buttons#further-reading) ## 1\. 太长不看 hyperbole-implicit-buttons-banner.webp 你的 Emacs 文本里已经充满了无需标记的超链接，但你却缺少利用它们的方式。想想 README 中的文件路径、邮件中的 URL、git 日志里的 `commit 55a1f0`、或者函数调用。所有这些都有逻辑上的指向对象（一个位置或一个动作），而且你很可能清楚它们应该指向哪里。 GNU Hyperbole (https://www.gnu.org/software/hyperbole/) 的**隐式按钮**是一种模式识别器，能在多种 Emacs 上下文中识别出不同的超链接按钮。Hyperbole 的动作键（一个单独的按键绑定）按下后即可激活这些按钮。本文将介绍内置的识别器，展示如何询问 Emacs "如果在这里按下动作键会发生什么？"（`C-h A`），解释 Hyperbole 模式识别器的级联机制如何选出最终执行的动作，并演示如何用一行代码（`defal`）、一个正则表达式（`defil`）或 Lisp 的全部能力（`defib`）来打造自己的按钮类型。 ## 2\. 关于 Emacs Hyperbole 隐式按钮 这是我关于 Hyperbole 系列文章的第二篇。第一篇 (https://www.chiply.dev/post-hyperbole-hywiki) 介绍了无需标记的个人维基 HyWiki，并且展示了 Hyperbole 几乎零入门负担。那篇文章顺带提到了隐式按钮 (https://www.chiply.dev/post-hyperbole-hywiki#implicit-buttons)，因为 HyWiki 词条本身就是一种隐式按钮。本篇文章中，我想更深入地关注这个概念、能力和扩展 API，因为隐式按钮正是将你的信息转化为可导航、可操作的**超宇宙**（hyperverse）的机制。 ## 3\. 推销 Hyperbole 隐式按钮 Emacs 显示和编辑的文本中已经充满了超链接，只待被激活。而识别并作用于这些超链接的机制正是 GNU Hyperbole 所提供的。没有 Hyperbole 时，这些超链接毫无生气。你可能对这些链接的样子和指向什么已经有了不错的心智模型，但却缺乏一致的一键操作反射。Hyperbole 的隐式按钮内置了大量识别器，能够识别文本中已经存在的各种超链接，并允许你在原地操作它们，无需添加任何标记或重排缓冲区。这种免标记的自由扩展了隐式按钮的适用范围，使其在只读缓冲区中也同样有效。在设计上，即使你要将数千个文件集成到已有的文件系统中，Hyperbole 也易于采用。只需几行 Elisp 安装和配置 Hyperbole，几乎所有能用 Emacs 打开的内容都会自动超链接化；超过 40 种内置隐式按钮类型（以及无限的自定义类型）会透明地传播到整个系统中。换句话说，Hyperbole 让你的文本活了起来！ ## 4\. 识别器与动作 一个**显式**超链接需要标记和花费时间才能将其链接到指向对象。例如，`<a href="...">` 或 `[[Org Link]]` 需要用**分隔符**包裹起来，以便某些软件知道它可以点击。相比之下，**隐式**按钮仅通过作者提供的文本本身（如 URL、路径名、按键绑定等自然模式）来识别。隐式按钮是**已经**承载了自身含义的普通文本片段。Hyperbole 的作者 Bob Weiner 将其总结为“跨大型文本语料库的模式识别器”。（快速提一下术语：Hyperbole 也有自己的**显式按钮**，这将在未来文章中介绍，但本文完全专注于**隐式**按钮，它们不需要这种创建步骤。） 每种隐式按钮类型（*ibtype*）将两个元素配对：一个**识别器**和一个**动作类型**，按下**动作键**时触发： 1. **识别器**是一个谓词，检查光标周围的文本，判断是否匹配该模式。 2. 识别后，**动作类型**与参数（包括识别器匹配的文本）结合，形成要执行的**动作**。 长期维护 GNU Emacs 的 John Wiegley 这样描述这种分工¹ (https://www.chiply.dev/post-hyperbole-implicit-buttons#fn.wiegley)： > Hyperbole 通过定义一组可扩展的、庞大的“识别器”来处理各种类型的信息引用，并定义“动作”来对这些信息进行处理（例如访问引用的文档、网页或字典定义），从而减轻了 Emacs 用户的认知负担。 > > —— John Wiegley 我喜欢将隐式按钮视为一种导航工具，它遍历了 Emacs 所统辖的所有内容之间天然存在的有机连接组织。对我而言，关键在于这些跨任意大小信息空间的连接**已经存在**——通过文本本身表达，无需标记。这就是我所说的**有机**。Hyperbole 是沿着这个自然隐式网络的边缘进行导航的工具。换句话说：我的邮件、shell 输出、代码、笔记和 Org 议程经常相互引用。隐式按钮使这些潜在的引用变得**可遍历**。 这里有一个更深层的观点，我想强调。大多数超文本系统要求**你**来创建信息之间的关系：用分隔符包裹文本、维护链接的两端、管理连接的数据库。Hyperbole 反其道而行之。因为识别发生在你按下动作键时，而不是在书写文本时，因此 Emacs 中的关系是你按照自然方式书写内容时的**涌现属性**。你不需要编写某种形式化的结构链接，只需提到某个东西（文件名、WikiWord 等），或者让其他进程提到它（git commit 哈希、Python 栈跟踪等），它与其指向对象的连接就已经存在。Hyperbole **推断**出这种关系，而不是要求你硬编码它。对我来说，这是隐式按钮原语最强大的成果。 ## 5\. 内置类型巡览 Hyperbole 内置了超过 40 种 ibtype。以下是我认为最有用的一些，它们都由同一个动作键（默认 `M-RET`）激活。 注意：此表格可滚动！点击后即可滚动。 | 如果光标位于... | 动作键将... | | --- | --- | | `WikiWord` | 跳转到（或创建）其 HyWiki 页面 | | `~/.emacs.d/init.el` | 打开该文件 | | `hbut.el:L2035:C10` | 打开文件并跳转到第 2035 行第 10 列 | | `github@rswgnu` 或 `gh@rswgnu` | 浏览 Hyperbole 创建者的 GitHub 主页 | | `https://gnu.org` | 浏览该 URL | | [[email protected]](mailto:[email protected]) | 给我发邮件！ | | `hibtypes.el` | 在 load-path 中编辑 Elisp 文件 | | `(hkey-either)`（在 `emacs-lisp-mode` 中） | 跳转到定义 | | `rm(1)` | 显示 `rm` 的手册页 | | `"(hyperbole)Implicit Button Types"` | 打开 Info 手册的那个节点或交叉引用 | | Python 回溯行 | 跳转到引发错误的源代码行 | | ERT（Emacs 回归测试）名称 | 运行该测试 | | 任何模式下的 Org 链接 | 像 Org 一样跟踪它 | | `git log` 输出中的 `commit 55a1f0` | 显示该 commit 的 diff | | `"FAST-DEMO#Implicit Buttons"` | 跳转到 Hyperbole 快速演示的那个章节 | | `RFC-822` | 下载并显示该 RFC | | `{C-x C-f}` | 执行按键序列（就像你亲自按下一样） | | `(message "hello")` | 运行 Elisp 表达式（动作按钮） | 此外，还有针对 grep 和 ripgrep 匹配结果、函数调用、编译器错误消息、调试器栈帧、补丁块、ctags/etags 标识符、Markdown 内部链接等的隐式按钮。注意其中有多少存在于**程序输出**中，而非文档中。这样，充满构建错误的 shell 缓冲区变成了一个可点击的代码库索引，git 日志变成了可浏览的历史记录等。通过识别输出中已经存在的模式，Hyperbole 将原本枯燥的文本变得生动、可交互。 公平地说，Emacs 已经内置了一些命令可以处理上表中的许多引用：`org-open-at-point` 处理 Org 链接，`find-file-at-point` 处理路径名，`browse-url` 处理 URL，`xref-find-definitions` 处理标识符，`man` 处理手册页。Hyperbole 提供的不是原始能力，而是**统一性**。没有它，你必须实时识别光标下是什么类型的引用，然后回忆起特定模式下的按键组合。有了它，分类的负担从你的头脑转移到了 Hyperbole 的识别器中。一个按键反射就能覆盖所有内置的引用类型，如果有缺失的引用类型，你可以通过 Hyperbole 的扩展系统轻松添加。这消除了大量的认知负担。你不再需要先识别类型再记住按键的“两步走”思维过程。只需按下动作键即可。 **HyWiki 词条**（前一篇 (https://www.chiply.dev/post-hyperbole-hywiki) 文章的主题）本身也是一种 ibtype（`hywiki-word`），使用了相同的隐式按钮机制。我想强调这一点，因为这正是为什么 HyWiki 能够**在任何地方**零标记地工作。HyWiki 继承了隐式按钮系统的广泛性，因为它建立在这个强大的原语之上。 ## 6\. 这次按键会做什么？ 大多数超文本和知识管理系统要么只提供基本链接，要么无法在激活之前显示超按钮将执行什么操作。Hyperbole 则不同。你可以随时查看在特定上下文中按下动作键会做什么。那么我们如何知道一个隐式按钮在按下**之前**会做什么呢？幸运的是，Hyperbole 的设计与 Emacs 本身一脉相承，可以通过自省回答这个问题。 - `C-h A`（即带有通用前缀参数的 `hkey-help`）显示在光标处动作键会做什么：按钮的类型、解析出的属性和即将执行的动作文档。 ibut-fig2-help.webp 图 1：在路径名上按 `C-h A`：帮助缓冲区显示 ibtype 名称、解析出的标签和属性，以及 `M-RET` 将执行的动作的文档 这使得学习 Hyperbole 变成了自我引导的练习。每当我发现某个看起来像隐式按钮的东西，就按下 `C-h A`，该按钮就会自我解释。不需要手册（不过手册 (https://www.gnu.org/software/hyperbole/man/hyperbole.html#Implicit-Buttons) 也很出色）。这个功能对我非常重要。Emacs 本身也是如此（参见我关于 Emacs 如何自学的文章 (https://www.chiply.dev/post-ask-emacs)）。Hyperbole 中指导性的帮助不止于此：其许多功能都可以通过上下文菜单发现（运行 `M-x hyperbole` 会显示一个直观菜单，帮助你探索 Hyperbole 的所有功能）。 ## 7\. 级联机制 为了预判另一个常见问题：一个按键如何能处理四十多种模式？毕竟我告诉人们，当你用动作键按下隐式按钮时，Hyperbole 会做“正确的事”。它是如何决定那个“正确的事”的呢？ 这是通过一个有序的上下文级联来实现的，**第一个匹配的获胜**。当你按下 `M-RET` 时，Hyperbole 首先查询一个有序的*上下文*列表（存储在 `hkey-alist` 中）。在检查按钮之前，会先检查一些特殊情况，比如补全弹出框和 minibuffer 提示符；在检查按钮之后，会检查针对 Dired、Info 等特定模式的处理程序。然后进入第二阶段，检查 Hyperbole 按钮及其相关上下文。每个 ibtype 的识别器谓词会按照优先级顺序（定义顺序的逆序）逐一针对光标处的文本运行，直到其中一个匹配。匹配的类型会标记按钮的标签并执行其动作。 hkey-alist.webp 图 2：`hkey-alist` 的帮助缓冲区，该变量决定了隐式按钮的类型和动作 优先级顺序用来解决歧义，保持重叠模式的合理性。规则是：**后定义的先检查**。`hbut.el:L2035:C10` 既是有效的路径名，也是有效的带位置的路径名，但更具体的 `pathname-line-and-column` 类型在纯 `pathname` 之后定义，因此它优先，你会跳转到精确的行和列。这个优先级规则可能看起来反直觉，但实际上促进了可扩展性：任何**你**定义的 ibtype 都比所有内置类型更新，所以你的识别器将优先于内置的。 ## 8\. 手动创建按钮 级联中的识别器完成了大部分工作，但你也可以有意识地放置隐式按钮。只需键入任何会被识别为隐式按钮类型的文本即可。随着你对 Hyperbole 的熟悉，你会越来越频繁地这样做。 我特别喜欢的一种方法：每当恰好有两个窗口打开时，按下 `C-h h i l` 会立即在当前选中窗口中放置一个未命名的隐式**链接**按钮，指向另一个窗口中光标所在的位置。我在浏览文件系统时经常使用这个命令。它让我可以在正在编写的文档中留下一个嵌入式书签、一个实时交叉引用。 ibut-fig4-create.webp 图 3：在叙事文档中放置一个隐式链接按钮，指向 `other-window` 中光标的位置 ## 9\. 创建自己的按钮类型 内置的隐式按钮类型和动作已经能带来大量便利。如果你是高级用户，并希望通过 Hyperbole 的扩展系统定义自己的类型，本节就是为你准备的。 Hyperbole 将按钮类型创建暴露为三个宏的阶梯，能力依次增强。前两个 `defal` 和 `defil` 帮助你定义包含分隔符的隐式按钮。第三个（我最常用的）帮助你为任意文本定义隐式按钮。 那些分隔符值得注意，因为我已经提到隐式按钮不需要标记。`defal` 和 `defil` 会用到它们。