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 コマンドに対しては、プレアンブルにそれぞれ \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 インターフェイスの高度な実装を取り入れています。