Восстановление файлов LaTeX | Java

Как проверить и восстановить файл LaTeX

Если вы не уверены, является ли текстовый файл файлом LaTeX, и хотите, чтобы он был набран, вы можете использовать функцию проверки и восстановления LaTeX, предлагаемую API Aspose.TeX для Java. В приведенном ниже примере мы проверим и исправим образец файла invalid-latex.tex из примера проекта Aspose.TeX для Java.

Для начала важно отметить, что в примере файла используется синтаксис TeX, но ему не хватает структуры, требуемой LaTeX. Как вы, возможно, знаете, файл LaTeX должен включать преамбулу, которая начинается с команды \documentclass, а также тело, заключенное в среду документа, в частности, между \begin{document} и \end{document}.

Задайте в inputFile полный путь к invalid-latex.tex, в outputDirectory — существующую папку вывода, а в packagesDirectory — папку с fancyhdr.sty и его зависимостями. Сохраните приведённый ниже callback вместе с импортом как PackageGuesser.java и перед восстановлением создайте PackageGuesser packageGuesser = new PackageGuesser(). Импортируйте используемые классы Aspose.TeX и обработайте или объявите исключения. Примените лицензию согласно руководству по лицензированию. Входной и выходной каталоги остаются открытыми до завершения восстановления, затем закрываются.

// Repair the LaTeX structure and infer packages for undefined commands.
// inputFile is the full invalid LaTeX path; packagesDirectory contains fancyhdr.sty.
// outputDirectory is an existing output folder; packageGuesser is a PackageGuesser instance.
LaTeXRepairerOptions options = new LaTeXRepairerOptions();
OutputFileSystemDirectory output = new OutputFileSystemDirectory(outputDirectory);
InputFileSystemDirectory packages = new InputFileSystemDirectory(packagesDirectory);
options.setOutputWorkingDirectory(output);
options.setRequiredInputDirectory(packages);
options.setGuessPackageCallback(packageGuesser);
TeXJobResult result;
try {
    result = new LaTeXRepairer(inputFile, options).run();
} finally {
    output.close();
    packages.close();
}

Как и в обычном задании TeX, мы начинаем с создания объекта, содержащего параметры процесса, который мы собираемся запустить. Большинство этих опций такие же, как и для обычного задания TeX. Действительно, вызывая метод setInputWorkingDirectory(), мы указываем пространство, из которого должны читаться входные файлы. Однако в этом примере мы не используем его, поскольку мы указываем полный путь к основному входному файлу в файловой системе, и никакие пользовательские файлы не должны включаться в основной входной файл. Затем мы вызываем метод setOutputWorkingDirectory(), чтобы указать пространство, в которое должны быть записаны выходные файлы. При вызове метод setRequiredInputDirectory() указывает параметры на пространство, где вы можете хранить пакеты LaTeX, которые не встроены в библиотеку Aspose.TeX. Наконец, метод setGuessPackageCallback() будет обсуждаться позже.

После того, как параметры были назначены, мы можем приступить к запуску процесса.

Итак, каков же процесс проверки и ремонта? Все начинается с того, что API ищет вхождение \documentclass во входном файле. Если он не найден, API предполагает, что \documentclass{article} должен быть вставлен в начало файла. Эта информация записывается в файл отчета о ремонте (.log).

Далее процесс начинает сканирование скорректированного входного файла с самого начала. Движок TeX, оснащенный форматом LaTeX, может в какой-то момент выдать ошибку, указывающую, что \begin{document} еще не найден, хотя он уже должен был быть найден. Таким образом, позиция, в которой необходимо вставить \begin{document}, определяется и отражается в отчете.

При дальнейшем сканировании файла движок может встретить неопределенные команды или среды. В таких случаях API может делать предположения относительно встроенных необходимых пакетов (тех, которые определяют команды и среды, которые не определены до тех пор, пока эти пакеты не будут включены) для некоторых из наиболее распространенных команд и сред. Однако такие предположения можно сделать извне с помощью класса, реализующего интерфейс IGuessPackageCallback. После того как вы разработали такой класс, его экземпляр следует передать процессу, вызвав метод setGuessPackageCallback().

Этот пример сопоставляет команду \lhead с пакетом fancyhdr. Callback получает имя без начальной обратной косой черты и возвращает пустую строку для неизвестных команд и окружений:

import com.aspose.tex.features.IGuessPackageCallback;

// Save as PackageGuesser.java and assign an instance with setGuessPackageCallback().
public class PackageGuesser implements IGuessPackageCallback {
    @Override
    public String guessPackage(String commandName, boolean isEnvironment) {
        // The command name has no leading backslash.
        if (!isEnvironment && "lhead".equals(commandName)) {
            return "fancyhdr";
        }
        // Empty means that this callback cannot identify a package.
        return "";
    }
}

Что касается файла примера, движок сначала встречает команду \chapter, которая не определена в классе документа article, но определена в классе документа book. API корректирует класс документа так, чтобы окончательная версия восстановленного файла начиналась с \documentclass{book}. Затем движок находит вышеупомянутую команду \lhead и определяет, что \usepackage{fancyhdr} необходимо вставить в преамбулу. Команды \href и \includegraphics, которые встречаются позже в файле, заставляют Repairer вставлять \usepackage{hyperref} и \usepackage{graphicx} в преамбулу соответственно. Эти решения принимаются на основе внутренних сопоставлений API. Как и прежде, все эти ремонты фиксируются в файле отчета.

Наконец, механизм аварийно завершает работу, поскольку отсутствует правильное заключение документа LaTeX. В результате Repairer добавляет \end{document} в конец файла и включает эту информацию в отчет.

После восстановления Repairer запускает задание TeX для окончательной проверки. В этом примере итоговый отчёт не содержит критических ошибок. Значение, возвращаемое run(), может отражать исходный проход; проверяйте отчёт восстановления и исправленный файл .tex. Восстановление не предоставляет отсутствующие внешние ресурсы. Например, для полного набора нужно отдельно предоставить Figures/uet_logo.pdf, на который ссылается образец.

Вот полный отчет:

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.