交叉引用选项

概述

有许多选项可用于自定义标题标签和引用。这些选项都在文档元数据的 crossref 键中指定。

本页我们重点介绍了一些最有用的选项,但你可以在 交叉引用选项 参考页面上找到所有可用的 crossref 选项。

请注意,由于 LaTeX 自行格式化和布局图表,因此在渲染为 PDF 时,并非所有这些选项都适用。具体来说,像 title-delim 这样的分隔符选项和像 labels 这样的编号选项不适用于 PDF 输出。此外,格式指令不会应用于 LaTeX 标题(例如,不会将图表标题设为斜体)。

标题

你可以使用 *-title 选项指定用于标题的前缀。你还可以使用 title-delim 选项指定前缀和标题之间的分隔符。例如:

---
title: "我的文档"
crossref:
  fig-title:     # (默认是 "Figure")
  tbl-title:     # (默认是 "Table")
  title-delim: "—"   # (默认是 ":")
---

引用

你可以使用 *-prefix 选项指定用于内联引用的前缀。你还可以使用 ref-hyperlink 选项指定引用是否应为超链接。例如:

---
title: "我的文档"
crossref:
  fig-prefix:   # (默认是 "Figure")
  tbl-prefix:    # (默认是 "Table")
  ref-hyperlink: false # (默认是 true)
---

编号

交叉引用有多种编号方案可供选择,包括:

  • arabic (1, 2, 3)

  • roman (I, II, III, IV)

  • roman i (i, ii, iii, iv)

  • alpha x (从字母 ‘x’ 开始)

  • alpha X (从字母 ‘X’ 开始)

你可以使用 labels 选项指定所有类型(子引用除外)的编号方案。对于子引用(例如子图),你可以使用 subref-labels 选项指定编号方案。例如:

---
title: "我的文档"
crossref:
  labels: alpha a        # (默认是 arabic)
  subref-labels: roman i # (默认是 alpha a)
---

如果你愿意,可以使用 *-labels 选项为特定类型指定编号方案。例如:

---
title: "我的文档"
crossref:
  fig-labels: alpha a    # (默认是 arabic)
  tbl-labels: alpha a    # (默认是 arabic)
  subref-labels: roman i # (默认是 alpha a)
---

如果同时提供了 labels 和特定类型的标签选项,特定类型的选项将覆盖 labels 选项。

章节编号

你可以使用 crossref: chapters 选项来指示文档中的顶级标题(H1)对应章节,并且交叉引用应按章节编号。例如:

---
title: "我的文档"
author: "Jane Doe"
number-sections: true
crossref:
  chapters: true
---

# 引言

![大象](elephant.png){#fig-elephant}

参见 @fig-elephant 以获取插图。

一只大象的线条画。上方是大号粗体的文本 '1 引言'。标签 '图 1.1:大象' 在其下方居中。文本 '参见图 1.1 以获取插图' 在下方左对齐。