注意:该中文文档为社区驱动的非官网文档,可能存在错译、漏译或过时等问题,请以官网文档 Documentation 为准,如发现错漏,也欢迎 您的贡献镜像)。Typst 非官方中文交流 QQ 群:793548390
Warning: the Chinese document is a community-driven non-official document, there may be mistranslation, omission or outdated problems, please refer to the official website documentation.
Typst 中文文档

toml

从 TOML 文件读取结构化数据。

文件必须包含有效的 TOML 表。 TOML 表将被转换为 Typst 字典,TOML 数组将被转换为 Typst 数组。 字符串、布尔值和日期时间将被转换为相应的 Typst 类型值。 数字将根据是否为整数转化为浮点值或整数值。

示例中的 TOML 文件为一个带有 titleversionauthors 键值的表。

举例

#let details = toml("details.toml")

Title: #details.title \
Version: #details.version \
Authors: #(details.authors
  .join(", ", last: " and "))
Preview

参数
参数是函数的输入,它们在函数名称后面的括号中传入。

toml() -> any

path
str
必需参数位置参数
位置参数按顺序传入,不带名称。

TOML 文件路径。

定义
函数和类型可以有与其关联的定义 (成员或方法)。可以使用 "." 操作符来访问调用它们。

decode

从 TOML 字符串/字节流读取结构化数据。

toml.decode() -> any

data
str bytes
必需参数位置参数
位置参数按顺序传入,不带名称。

TOML 数据。

encode

将结构化数据编码为 TOML 字符串。

toml.encode() -> str

value
any
必需参数位置参数
位置参数按顺序传入,不带名称。

被编码的值。

pretty

是否结构化输出编码后的 TOML 字符串

默认:true