# 文档分析

列出 LaTeX、Typst 或 Markdown 文档的标题、图片、表格、公式、标签、引用和待办事项，并复制它的投稿元数据。

投稿之前，看看文档里到底有什么会很有帮助。每张图片都有图注吗？每个被引用的键都在参考文献里吗？**文档分析**在一个对话框中列出这一切，每一项都链接回它在源码中的那一行。

用编辑器工具栏右端的**文档分析**按钮打开它，或在 ⌘K 面板中运行**文档分析**。它适用于 LaTeX、Typst 和 Markdown 项目，并从主文件开始读取文档，所以用 `\input` 引入的 LaTeX 章节或用 `#include` 引入的 Typst 文件也会被计入。

## 每个标签页列出什么

**概览**显示下面每个列表的数量。点击某个数量可以打开对应的标签页。

- **标题**，按层级缩进。
- **图片**和**表格**，每项带有图注（或**无图注**）、标签，没有编号时标为**无编号**。
- **公式**：只列行间公式，不含行内公式。
- **标签**：每个标签，以及它标记的对象：标题、图片、表格、公式或其他。
- **引用**：每个被引用的键以及被引用的次数。不在参考文献中的键会标为**不在参考文献中**，概览会显示有多少个。
- **待办**：源码中的 `TODO`、`FIXME` 和 `XXX` 备注。在 LaTeX 中，`\todo`、`\missingfigure` 以及 fixme 宏包的备注也会计入。

点击某一行会关闭对话框并跳转到那一行。灰色的行无法追溯到源码。

## 编号与页码

编号从哪里来，取决于引擎：

- **LaTeX**：图片、表格、公式和标题的编号及其页码来自上次编译，仅限带有标签的项目。页脚会告诉你它们是否是最新的。如果你在那之后编辑过，请再编译一次来更新它们。
- **Typst**：对话框打开时会让 Typst 读取文档，使用项目的 Typst 版本和所选的构建变体，所以编号和页码与现在的源码一致。如果 Typst 无法编译文档，概览会改为列出错误，每个错误都链接到它所在的行。只会列出前 5,000 个元素。页脚会写明所用的 Typst 版本。
- **Markdown**：条目按源码顺序列出，没有编号或页码。

**刷新**会在不关闭对话框的情况下重新读取文档。

## 投稿元数据

概览还会显示 Oleafly 找到的**标题**、**作者**、**关键词**、**日期**和**摘要**。缺失的项目显示为**未设置**。

- 在 LaTeX 中，它们来自 `\title`、`\author`、`\date`、`abstract` 环境，以及 `\keywords` 命令或 `keywords` 或 `IEEEkeywords` 环境。
- 在 Typst 中，它们来自文档所应用模板的参数，或来自 `#set document(...)`。摘要也可以来自名为“Abstract”的标题。
- 在 Markdown 中，它们来自 front matter：`title`、`author` 或 `authors`、`date`、`keywords` 和 `abstract`。

**复制投稿元数据**会把标题、作者、关键词和摘要以带标签的行放到剪贴板上，可直接粘贴到投稿表单中。这些项目都没有设置时，该按钮不可用。

## 相关页面

- [预检](/docs/preflight/)：投稿前对源码、日志和 PDF 的更深入检查
- [引用与参考文献](/docs/citations/)：添加文档分析报告缺失的键
- [文档设置](/docs/document-settings/)：编辑器工具栏上的另一个文档工具
