LaTeX 文件修复 | Aspose.TeX for .NET

如何检查并修复 LaTeX 文件

如果您有一个文本文件，认为它是 LaTeX 文件并希望对其进行排版，但不确定它是否真的是 LaTeX 文件（也许您是 LaTeX 新手），可以尝试使用 Aspose.TeX API for .NET 提供的 LaTeX 检查和修复功能。在下面的示例中，我们将检查并修复 Aspose.TeX for .NET 示例项目中的示例文件 invalid-latex.tex。

首先，值得一提的是，尽管示例文件看起来使用了 TeX 语法，但它没有 LaTeX 所要求的结构。正如您所知，LaTeX 文件必须有以 \documentclass 命令开头的导言区，以及位于 document 环境中的正文，即介于 \begin{document} 和 \end{document} 之间。

现在让我们看看 C# 代码示例。

// Repair invalid LaTeX file and guess missing packages

// Create repair options.
LaTeXRepairerOptions options = new LaTeXRepairerOptions();
// Specify a file system working directory for the output.
options.OutputWorkingDirectory = new OutputFileSystemDirectory(OutputDir);
// Specify a file system working directory for the required input.
// The directory containing packages may be located anywhere.
options.RequiredInputDirectory = new InputFileSystemDirectory(Path.Combine(DataDir, "packages"));
// Specify the callback class to externally guess packages required for undefined commands or environments.
options.GuessPackageCallback = new PackageGuesser();
// Run the repair process.
new LaTeXRepairer(Path.Combine(DataDir, "invalid-latex.tex"), options).Run();

类似于普通的 TeX 作业，我们首先创建一个包含即将运行的进程选项的对象。大多数选项与普通 TeX 作业的选项相同。事实上， InputWorkingDirectory 是读取输入文件的目录。这里我们不使用它，因为我们在文件系统中提供了主输入文件的完整路径，并且主输入文件不应包含自定义文件。然后， OutputWorkingDirectory 是写入输出文件的目录。 RequiredInputDirectory，如果设置，则指向您可以存放未嵌入 Aspose.TeX 库的 LaTeX 包的目录。稍后将讨论 GuessPackageCallback 属性。

分配好选项后，我们只需运行该过程！

那么，检查和修复过程是怎样的呢？首先，API 在输入文件中搜索 \documentclass。如果未找到，它会假设需要在文件开头插入 \documentclass{article}。此事实会在修复报告文件（.log）中体现。

接着，它从文件开头开始扫描已调整的输入文件。负责 LaTeX 格式的 TeX 引擎可能在某处抛出错误，提示至今未找到 \begin{document}，尽管它本应已经出现。于是确定并在报告中记录需要插入 \begin{document} 的位置。

当引擎进一步扫描文件时，可能会发现未定义的命令或环境。API 可以对 嵌入的必需包（即那些在包含这些包之前未定义的命令和环境）做出假设，针对一些最常见的命令和环境提供映射。然而，也可以通过实现 IGuessPackageCallback 接口在外部进行此类假设。应将此类类的实例分配给 GuessPackageCallback 选项。

下面是一个非常简单的示例，仅将 \head 命令映射到 fancyhdr 包：

// The callback class to externally guess packages required for undefined commands or environments.
public class PackageGuesser : IGuessPackageCallback
{
    private Dictionary<string, string> _map = new Dictionary<string, string>();

    public PackageGuesser()
    {
        _map.Add("lhead", "fancyhdr"); // Defines the mapping between the \lhead command and the fancyhdr package.
    }

    public string GuessPackage(string commandName, bool isEnvironment)
    {
        string packageName;
        if (!isEnvironment)
        {
            _map.TryGetValue(commandName, out packageName);
            return packageName ?? ""; // It's better to return an empty string to avoid consequent calls for the same command name.
        }

        // Some code for environments
        // ...

        return "";
    }
}

对于示例文件，引擎首先遇到 \chapter 命令，该命令在 article 文档类中未定义，但在 book 文档类中定义。API 会调整文档类，使修复后的文件开头为 \documentclass{book}。随后，引擎发现前述的 \lhead 命令，并决定在导言区插入 \usepackage{fancyhdr}。随后出现的 \href 和 \includegraphics 命令分别导致 Repairer 在导言区插入 \usepackage{hyperref} 和 \usepackage{graphics}。这些决定基于 API 的内部映射。同样，所有此类修复都会记录在报告文件中。

最后，由于缺少 LaTeX 文档的正常结尾，引擎异常终止。这导致 Repairer 在文件末尾追加 \end{document} 并在报告中反映此情况。

构建出原文件的修复版本后，Repairer 对其运行 TeX 作业进行最终检查。在我们的示例中，此次运行未发现任何关键错误，因此修复后的版本基本可以按预期进行排版。

以下是完整的报告：

Trying to repair the original file...
--------------------------------------------------------------------------------
\documentclass is missing in the original file. Inserted at the beginning.
\begin{document} is missing in the original file. Inserted at line 3, pos. 0.
The command \chapter at line 3, pos. 0 is undefined. Consider using \usepackage{package_name} in the preamble,
    where 'package_name' is the name of the package which defines this command.
The command \lhead at line 5, pos. 0 is undefined. \usepackage{fancyhdr} is inserted in the preamble
    since the 'fancyhdr' package supposedly defines the command.
The command \href at line 8, pos. 0 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \href at line 17, pos. 0 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \href at line 20, pos. 0 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \href at line 27, pos. 0 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \href at line 32, pos. 0 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \includegraphics at line 54, pos. 2 is undefined. \usepackage{graphicx} is inserted in the preamble
    since the 'graphicx' package supposedly defines the command.
The command \href at line 67, pos. 0 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \href at line 95, pos. 57 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \href at line 96, pos. 0 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
The command \href at line 98, pos. 100 is undefined. \usepackage{hyperref} is inserted in the preamble
    since the 'hyperref' package supposedly defines the command.
\end{document} is missing in the original file. Inserted at the end.

Checking the repaired file...
--------------------------------------------------------------------------------
There are no critical errors in the fixed file.

您也可以查看我们的免费 AI LaTeX Repairer 网络应用程序，该应用基于在 Aspose.TeX for .NET API 中实现的功能，并涉及更高级的 IGuessPackageCallback 接口实现。