Pandoc Lua 过滤器 - 模块 (Module)
Pandoc 模块
Pandoc Lua 模块被加载到过滤器的 Lua 环境中,并提供了一系列函数和常量来方便元素的创建和操作。全局变量 pandoc
绑定到该模块,通常不应为此原因而覆盖它。
该模块提供了两大功能:元素创建函数和访问 Pandoc 的一些主要功能。
元素创建
像 Str
、Para
和 Pandoc
这样的元素创建函数设计用于轻松创建新的元素,这些元素易于使用且可以从 Lua 环境中读取。内部地,Pandoc 使用这些函数来创建传递给元素过滤器函数的 Lua 对象。这意味着通过此模块创建的元素将与通过过滤器函数参数可访问的那些元素完全一样地表现。
曝露的 Pandoc 功能
一些 Pandoc 函数在 Lua 中可用:
- walk_block 和 walk_inline 允许过滤器应用于特定的块或内联元素内部;
- read 允许过滤器将字符串解析为 Pandoc 文档;
- pipe 运行外部命令,并从字符串中获取输入,向字符串输出;
- pandoc.mediabag 模块允许访问 “媒体包”,其中存储了诸如图像之类的二进制内容,这些内容可能会包含在最终文档中;
- pandoc.utils 模块包含了各种实用函数。