外部 LaTeX 包 | Aspose.TeX for .NET

外部 LaTeX 包

Aspose.TeX 库已经包含了许多 常用 LaTeX 包。因此您无需担心如何向库的 TeX 引擎提供这些包。但有时（甚至经常）您的 LaTeX 文件可能需要超出“原生”支持的“捆绑”包。如果出现这种情况，您可以尝试通过 TeXOptions 类实例的 RequiredInputDirectory 选项提供所需的输入，即所需包的源文件。下面我们将通过两个示例来演示其工作方式。

已解压的必需输入（fancybox 包）

假设我们有下面这个简单的 LaTeX 文件，它来自我们的 示例解决方案中的 required-input-fs.tex：

\documentclass{article}
\usepackage[a6paper,landscape]{geometry}
\usepackage{fancybox}
\begin{document}
Test: \fbox{
  \begin{Bitemize}[b]
  \item First item
  \item A second one\\ on two lines
  \item(2pt) A third with extra space
  \end{Bitemize}
}
\par\bigskip
Test: \fbox{
  \begin{Beqnarray}[t]
  y & = & x^2 \\
  a^2 + 2ab + b^2 & = & (a + b)^2 \\
  \int_0^\infty e^{-ax} dx & = & \frac{1}{a}
  \end{Beqnarray}
}
\end{document}

在第 3 行可以看到文件需要 fancybox 包，而该包并未被“原生”支持。假设我们已经拥有 fancybox 包的源文件。它是一个简单的包，仅包含单个文件。我们可以将此文件放在文件系统的任意位置，并按如下方式指定目录路径：

options.RequiredInputDirectory = new InputFileSystemDirectory("path-to-directory-where-fancybox.sty-located");

使用此选项运行 TeX 作业后（别忘了根据需要调整其他选项），我们得到输出文档（即 PNG 图像）。

以下是该示例的完整源代码：

// External LaTeX packages from file system

// Create conversion options for Object LaTeX format upon Object TeX engine extension.
TeXOptions options = TeXOptions.ConsoleAppOptions(TeXConfig.ObjectLaTeX);
// 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"));
// Initialize the options for saving in PNG format.
options.SaveOptions = new PngSaveOptions();
// Run LaTeX to PNG conversion.
new TeXJob(Path.Combine(DataDir, "required-input-fs.tex"), new ImageDevice(), options).Run();

已归档的必需输入（pgfplots 包）

现在假设我们还有下面这个同样相当简单的 LaTeX 文件，它来自示例解决方案中的 required-input-zip.tex：

\documentclass{article}
\usepackage[margin=0.25in]{geometry}
\usepackage{pgfplots}
\pgfplotsset{width=10cm,compat=1.18}
\begin{document}

第一个示例是并排绘制的二维和三维数学表达式。

%Here begins the 2D plot
\begin{tikzpicture}
\begin{axis}
\addplot[color=red]{exp(x)};
\end{axis}
\end{tikzpicture}
%Here ends the 2D plot
\hskip 5pt
%Here begins the 3D plot
\begin{tikzpicture}
\begin{axis}
\addplot3[
    surf,
]
{exp(-x^2-y^2)*x};
\end{axis}
\end{tikzpicture}
%Here ends the 3D plot

\end{document}

在第 3 行可以看到文件需要 pgfplots 包，同样未被“原生”支持。再次假设我们已经拥有 pgfplots 包的源文件。该包文件数量较多，分布在两个位置：\tex\generic 和 \tex\latex 文件夹中。必须将这两个文件夹的内容作为必需输入提供给 Aspose.TeX 库。我们希望将这些源文件打包成 ZIP 存档，存档的布局如下：

下面演示如何指定对这些源文件的访问方式：

using (Stream zipStream = File.Open("path-to-zip-with-pgfplots-sources", FileMode.Open))
{
    ...
    options.RequiredInputDirectory = new InputZipDirectory(zipStream);
    ...
}

使用此选项运行 TeX 作业后，我们得到输出文档：

以下是该示例的完整源代码：

// External LaTeX packages from ZIP archive

// Create conversion options for Object LaTeX format upon Object TeX engine extension.
TeXOptions options = TeXOptions.ConsoleAppOptions(TeXConfig.ObjectLaTeX);
// Specify a file system working directory for the output.
options.OutputWorkingDirectory = new OutputFileSystemDirectory(OutputDir);
// Initialize the options for saving in PNG format.
options.SaveOptions = new PngSaveOptions();
// Create a file stream for the ZIP archive containing the required package.
// The ZIP archive may be located anywhere.
using (Stream zipStream = File.Open(Path.Combine(DataDir, "packages\\pgfplots.zip"), FileMode.Open))
{
    // Specify a ZIP working directory for the required input.
    options.RequiredInputDirectory = new InputZipDirectory(zipStream, "");
    
    // Run LaTeX to PNG conversion.
    new TeXJob(Path.Combine(DataDir, "required-input-zip.tex"), new ImageDevice(), options).Run();
}

注意： 结果已使用 pgfplots 包版本 1.18.1 验证。Aspose.TeX 库中包含的 pfg 包版本为 3.1.9a。

使用外部字体包

通常，LaTeX 发行版会提供一套默认字体供排版使用。除这些字体外，Aspose.TeX 还包含若干非标准字体包，例如 amsfonts、eurosym 和 wasysym。正如前文所述，Aspose.TeX 也允许使用外部包，但大多数情况下我们讨论的是不包含字体的包。

Aspose.TeX 的 Object TeX 引擎扩展需要字体映射文件（即扩展名为 .map 的文本文件），以确定每个 TeX 内部字体名对应的实际字体。这些映射文件必须在初始化阶段加载到 TeX 的内存中，并且必须随您引入的包一起存在。由于引擎不知道所有字体映射的名称，它会搜索所有扩展名为 .map 的文件。因此，实现用于 RequiredInputDirectory 选项的 IInputWorkingDirectory 接口时，需要提供一种按扩展名访问文件名集合的方式。更具体地说，该实现还必须实现 IFileCollector 接口。标准实现—— InputFileSystemDirectory 和 InputZipDirectory——已经具备此功能。

下面提供一个自定义必需输入目录的示例，该示例同样实现了 IFileCollector 接口。示例侧重于按扩展名收集文件名，省略了文件存储和检索的细节。

// Custom implementation of IInputWorkingDirectory for external packages with fonts

// This is an implementation of IInputWorkingDirectory that is suitable for the TeX job's RequiredInputDirectory option
// in case required input contains fonts provided by external packages.
// The class additionally implements IFileCollector, which provides access to file collections by extension.
// This is necessary to load external font maps, which are files (outside TeX syntax) that map TeX's
// internal font names to file names of physical fonts.
public class RequiredInputDirectory : IInputWorkingDirectory, IFileCollector
{
    private Dictionary<string, Dictionary<string, string>> _fileNames =
        new Dictionary<string, Dictionary<string, string>>();

    public RequiredInputDirectory()
    {
    }

    // This method should preliminarily be called for each file entry that is supposed to be located inside
    // the required input directory. Inside is an example of how the dictionary of file names could be organized
    // for easy collection of file names by extension.
    // Here fileName is a full file name. This can be a file path on a file system, a URL, or whatever else (theoretically).
    public void StoreFileName(string fileName)
    {
        string extension = Path.GetExtension(fileName);
        string name = Path.GetFileNameWithoutExtension(fileName);
        
        Dictionary<string, string> files;
        if (!_fileNames.TryGetValue(extension, out files))
            _fileNames.Add(extension, files = new Dictionary<string, string>());

        files[name] = fileName;
    }

    // The IInputWorkingDirectory implementation.
    public NamedStream GetFile(string fileName, bool searchSubdirectories = false)
    {
        // Try to find the file in our stored files
        foreach (var extFiles in _fileNames.Values)
        {
            foreach (var file in extFiles.Values)
            {
                if (file.EndsWith(fileName) || Path.GetFileName(file) == fileName)
                {
                    return new NamedStream(File.OpenRead(file), fileName);
                }
            }
        }
        // If not found in stored files, return null (file not available)
        return new NamedStream(null, fileName);
    }

    // Here is how we gather file collections by extension.
    public string[] GetFileNamesByExtension(string extension, string path = null)
    {
        Dictionary<string, string> files;
        if (!_fileNames.TryGetValue(extension, out files))
            return new string[0];

        return new List<string>(files.Values).ToArray();
    }

    public void Dispose()
    {
        _fileNames.Clear();
    }
}

限制

如果您的 LaTeX 文件所需的包是基于 LaTeX3e 内核开发的，则该包很可能无法与 Aspose.TeX 库一起工作，因为后者基于 LaTeX2e 内核。

此外，如果您的 LaTeX 文件所需的包直接调用了 Aspose.TeX 的 Object TeX 引擎不支持的设备相关原语命令，则该包肯定无法工作。