Quarto多文档图表引用指南：include短代码实用技巧

理解Quarto交叉引用机制

Quarto提供了强大的交叉引用功能，允许用户在文档中引用图表、表格、公式、章节等。通常，这些引用（例如@fig-label）要求被引用的对象（例如![Caption]{#fig-label}）存在于同一个.qmd文档中，或者在Quarto项目（如书籍或网站）的编译范围内。当Quarto处理一个.qmd文件时，它会解析该文件内的所有标签和引用。

跨文档引用挑战

在模块化写作中，我们经常会将文档内容拆分为多个.qmd文件，例如将正文与附件分开。此时，如果在一个主文档（如article.qmd）中尝试引用另一个独立文档（如annex.qmd）中定义的图表，标准的交叉引用机制会失败。这是因为在默认情况下，article.qmd在编译时并不知道annex.qmd中定义的标签。

考虑以下示例结构：

article.qmd

---
title: "我的文章"
format: html
---

## 引言

请参阅附件中的图表，了解详细信息：图 @fig-a。

annex.qmd

---
title: "附件"
format: html
---

## 附件 A

![这是附件中的一个示例图表。](path/to/figure.png){#fig-a}

直接编译article.qmd会导致@fig-a无法解析，因为fig-a的定义存在于一个独立的annex.qmd文件中。

解决方案：利用 {{< include >}} 短代码

Quarto提供了一个名为include的短代码，它允许我们将一个文件的内容直接嵌入到另一个文件中。通过这种方式，我们可以在主文档编译之前，将附件文档中的图表定义“拉入”主文档的上下文，从而解决跨文档引用问题。

工作原理： 当Quarto处理包含{{< include >}}短代码的文档时，它会在渲染过程的早期将指定文件的内容直接插入到当前位置。这意味着，一旦annex.qmd的内容被include到article.qmd中，fig-a的定义就变成了article.qmd的一部分，Quarto就可以像处理单个文件一样解析@fig-a。

实施步骤：

1. 准备附件文档（_annex.qmd）： 将包含您要引用的图表（或其他内容）的文档命名为_annex.qmd。通常，我们会在文件名中使用下划线前缀，以指示它是一个辅助文件，不应独立编译。

   # _annex.qmd
   
   ## 附件 A：示例图表
   
   ![这是附件中的一个示例图表。](path/to/figure.png){#fig-a}

   • 注意： 确保图表的标签（#fig-a）是唯一的。path/to/figure.png应替换为实际的图片路径。

2. 在主文档中引用并包含附件（article.qmd）： 在您的主文档中，您可以在需要引用图表的位置使用@fig-a，然后在文档的某个逻辑位置（例如，文章末尾或专门的附件部分）使用{{< include >}}短代码来引入_annex.qmd的内容。

   # article.qmd
   ---
   title: "我的文章"
   format: html
   ---
   
   ## 引言
   
   本文将探讨... 请参阅附件中的图表，了解详细信息：图 @fig-a。
   
   ## 结论
   
   总结本文要点...
   
   {{< include _annex.qmd >}}

3. 编译主文档： 现在，当您编译article.qmd时，Quarto会首先将_annex.qmd的内容合并进来，然后才进行交叉引用解析和最终渲染。

   quarto render article.qmd

   编译后生成的HTML、PDF或Word文档中，图 @fig-a将正确解析为图 1（或根据其在文档中的顺序编号），并链接到附件中对应的图表。

示例代码

文件结构：

.
├── article.qmd
├── _annex.qmd
└── path/to/figure.png

path/to/figure.png (一个示例图片文件)

_annex.qmd 内容：

---
# 此处可以省略YAML头，因为内容将被包含到另一个文档中
---

## 附件 A：详细图表

![这是附件中的一个示例图表，展示了数据分布。](path/to/figure.png){#fig-a}

article.qmd 内容：

---
title: "Quarto多文档交叉引用教程"
format: html
---

# 引言

在Quarto项目开发中，模块化管理文档内容是一种常见实践。例如，我们可能将主要内容与辅助性的附件（如大型图表、补充数据）分开存放。本教程旨在解决如何在主文档中无缝引用这些独立附件中的图表。

如图 @fig-a 所示，附件中提供了一个详细的示例图表，它有助于我们理解相关概念。

# 核心内容

[此处放置文章主要内容]

# 结论

通过上述方法，我们成功实现了跨文档的图表交叉引用。

# 附件
{{< include _annex.qmd >}}

注意事项

• 路径问题： {{< include >}} 中的文件路径可以是相对于当前.qmd文件的相对路径。
• YAML头： 被include的文件可以包含自己的YAML头，但通常情况下，如果它只是作为内容片段被包含，可以省略或简化其YAML头，因为主文档的YAML头将主导整体文档设置。
• 内容类型： include 不仅限于图表，可以包含任何Quarto支持的内容，如文本、代码块、表格等。
• 模块化与整合： include 短代码提供了一种在保持文档模块化的同时，又能在逻辑上将它们整合为单一输出的有效方法。
• 替代方案： 对于更复杂的项目结构，例如Quarto书籍或网站，Quarto提供了更高级的跨文档引用机制，这些机制通常在项目配置中定义，允许在整个项目范围内进行引用。然而，对于简单的两个或少数几个文档间的引用，{{< include >}} 是一个直接且高效的解决方案。

总结

在Quarto中实现跨文档图表交叉引用，关键在于利用{{< include >}}短代码将包含图表定义的附件文档内容合并到主文档中。这使得Quarto在渲染时能够将所有相关内容视为一个整体，从而正确解析交叉引用标签。这种方法简单、直接，非常适用于需要将辅助内容与主文档逻辑关联的场景，极大地提升了Quarto文档的组织性和可维护性。