Latex как скомпилировать файл

Обновлено: 04.07.2024

Установка и сборка

Для включения режима черновика можно выполнить любое из следующих действий:

в файле usercfg.mk добавить строчку DRAFTON ?= 1
в файле setup.tex поменять значение параметра draft на 1
запустить команду make draft или make DRAFTON=1

При этом шаблон будет собираться с некими отклонениями от ГОСТ, но в несколько раз быстрее (в основном отличия касаются оформления списка литературы). Этот режим удобен при промежуточных сборках, например, во время набора формул. Обратите внимание: нумерация работ в списке литературы при использовании режима черновика может быть неверной. Кроме того, при использовании biblatex в режиме черновика не ведётся подсчёт количества пунктов в списке литературы.

Пользователи Linux могут применять команды make dissertation-preformat и make synopsis-preformat , чтобы использовать предварительное форматирование преамбулы диссертации и автореферата (может потребоваться установка пакета texlive-mylatexformat ). Это позволяет ускорить сборку ещё приблизительно в 1.5 раза (на повторную сборку черновика диссертации на компьютере с процессором Intel i5 требуется около двух секунд).

Если не собирается библиография, ссылки на литературу отображаются вопросами или жирными названиями:

Попробовать поменять параметр bibliosel в соответствующем файле setup.tex , подробнее читать «в случае проблем с библиографией».
Очистить папки проекта от прошлых временных файлов ( *.aux , *.toc , *.bbl , *.bcf , *.synctex.gz и прочие подобные).
Убедиться, что в вашей среде компиляции (например, в редакторе TeXStudio) правильно выбран движок библиографии (в соответствии с параметром bibliosel в каждом из файлов setup.tex ).
Провести несколько компиляций проекта.
Если ничего из предыдущих пунктов не помогло, запустить latexmk на главном файле автореферата или диссертации, или выполнить соответствующий make .

Если компилируется с ошибками, то изучение соответствующего *.log файла может помочь определить причину (как правило, ошибки вызваны отсутствием необходимых пакетов или их версий). Часто первая ошибка в *.log файле является первопричиной остальных.

В Ubuntu с TexLive внутри контейнера DockerTex

Протестировано в Ubuntu 16.04 LTS и Ubuntu 18.04 LTS

Для обеспечения максимальной воспроизводимости сборки проекта рекомендуется использовать специализиарованный Docker-контейнер от проекта dockertex, базирующийся на Debian Buster 10 и TexLive 2018, с минимальной модификацией (добавлением пакета шрифтов от Microsoft - ttf-mscorefonts-installer и набора шрифтов Liberation в виде пакета fonts-liberation ). Образ контейнера объемом около 2.5 Гб будет загружен из сети, при этом с учетом этапа распаковки в системе потребуется около 8 Гб свободного места в каталоге /var .

Установка контейнера в вашу систему выполняется путем запуска соответствующего скрипта, находящегося в корне этого шаблона:

Далее необходимо выйти из системы и зайти снова (либо перезагрузиться).

После этого станут доступны две новых команды - dockertex и dockertexstudio . Для TexStudio будет создан ярлык с названием Docker TexStudio (texlive2018) в категории Office.

Команда dockertex используется для сборки проекта - диссертации, автореферата и презентации (по сути это make без аргументов):

После выполнения команды будут созданы три PDF-файла: dissertation.pdf , presentation.pdf и synopsis.pdf .

При необходимости можно запустить make clean :

Остальные аргументы make могут быть вызваны аналогично.

Команда dockertexstudio используется для запуска TexStudio из контейнера:

После открытия файла dissertation.tex и нажатия будет создан PDF диссертации.

Протестировано на Ubuntu 19.04. Для LTS-версий рекомендуется использование DockerTex

Для установки XeTeX в Ubuntu и необходимых дополнительных пакетов можно использовать команду:

или для установки полного комплекта программ:

Для использования шрифтов Microsoft требуется их установка. Например, для Ubuntu это можно сделать так:

Установка аналогична Ubuntu.

Для установки шрифтов Microsoft должен быть подключен репозиторий contrib .

Для установки XeTeX необходимо установить следующие пакеты:

Далее можно установить шрифты из набора Microsoft's Core Fonts. Например, так:

В репозиториях Gentoo лежит относительно старая версия TeXLive и сопутствующих пакетов, однако особых проблем с ними возникнуть не должно. Следует учитывать лишь два момента:

Устаревший dev-tex/latexmk (на 31.05.2019). В репозитории лежит версия 456, которая не позволит собрать проект. Необходимо создать собственный репозиторий и скопировать в него ебилд от 456 версии, переименовав в соответствии с актуальной (на данный момент это 464a). (Если просто скопировать ебилд под новым именем в тот же самый главный репозиторий, то при очередном emerge --sync он будет перезатерт.)
Стилевой файл impnattypo.sty , необходимый для сборки проекта, отправлен мейнтейнерами в пакет dev-texlive/texlive-langfrench , поэтому кроме основных пакетов необходимо установить и его.

TeXLive на Linux в обход привязанных к конкретному линуксу пакетам

How to install «vanilla» TeXLive on Debian or Ubuntu? — инструкция на английском языке, как ставить TeXLive на Linux в обход привязанных к конкретному линуксу пакетам (на примере Debian и Ubuntu).

В MacOS 10.10 и выше

Для установки в среде MacOS достаточно установить пакет MacTeX отсюда. После установки необходимо добавить пути к установленным файлам в переменную окружения PATH , например, так:

Чтобы сделать эффект постоянным можно добавить эту строку в .bash_profile :

Теперь при следующем логине, вам будут доступны утилиты из пакета, необходимые для работы make -скриптов.

Установка шрифтов PSCyr

PSCyr — это пакет красивых русских шрифтов для LaTeX. К сожалению, его нужно устанавливать отдельно. Если он у вас не установлен, то ничего страшного — шаблон заработает и без него. Ну лучше бы его всё-таки поставить. Инструкции по установке PSCyr для различных конфигураций приведены в файле PSCyr/README.md внутри репозитория. Если вы не нашли подходящую вам инструкцию, но смогли выполнить установку самостоятельно, то большая просьба поделиться вашими наработками.

Рабочий способ установки в Ubuntu 15.10

(компиляция из инструкции на welinux и файлов, которые есть в шаблоне)

Нужно скачать шаблон, найти в папке PSCyr файл pscyr0.4d.zip и распаковать его содержимое куда угодно. Чтобы не переписывать пути, папка с содержимым должна называться PSCyr, а не pscyr, как в архиве. Затем надо зайти в терминал, перейти к тому каталогу, где лежит папка PSCyr с содержимым, и выполнить команды из вышеупомянутого руководства:

Дальше надо узнать, где у вас локальный каталог texmf. Для этого выполняем

С вероятностью около единицы результат будет /usr/local/share/texmf/ . Копируем всё туда:

Ну и подключаем:

Установка в MacOS 10.x

Рабочий способ установки в Debian 9

Сборка PDF из командной строки

Сборку можно производить следующими командами:

диссертация: latexmk -pdf -pdflatex="xelatex %O %S" dissertation
автореферат: latexmk -pdf -pdflatex="xelatex %O %S" synopsis

Либо можно использовать make-файлы (движок xelatex ): из корневого каталога выполнять

make для сборки всего
make dissertation для сборки диссертации,
make synopsis для сборки автореферата,
make presentation для сборки презентации для доклада,
make dissertation-draft для сборки диссертации в режиме черновика,
make synopsis-draft для сборки автореферата в режиме черновика,
make synopsis-booklet для сборки автореферата для печати,
make presentation-booklet для сборки презентации для печати,
make presentation-handout для сборки раздаточных материалов,
make draft для быстрой сборки диссертации и автореферата в режиме черновика,
make release для сборки всего и внесения финальных *.pdf файлов в систему контроля версий git
make clean очистка от временных файлов
make distclean очистка всех генерируемых файлов (включая .pdf)
make pdflatex сборка полной версии с движком pdflatex (несколько быстрее для автореферата, чем xelatex , движок для библиографии в соответствии с настройками setup.tex ).

Презентация может собираться собираться любым из трёх движков: pdflatex , xelatex , lualatex .

Пакеты и версии LaTeX

Шаблон по умолчанию включает ряд распространённых пакетов, чтобы вы могли сразу ими пользоваться. Однако, на вашей машине какие-то пакеты могут быть не установлены. Если вам они не нужны, то вы можете их просто удалить (команда \usepackage ).
Лучше всего использовать актуальные и полные версии LaTeX-дистрибутивов, это поможет избежать многих проблем. Например, MikTeX 2.9.6361+ для Windows или TeXLive 2017+ для множества ОС.

Если у вас ещё не сформировались предпочтения по LaTeX-редактору, то обратите внимание на TeXStudio, существующий для всех основных платформ.
Некоторые редакторы (в том числе TeXStudio) позволяют подключить проверку грамматики с помощью Language Tool (есть поддержка русского языка). Полностью от ошибок он не спасёт, но поиск простых случаев облегчает. Например, в предложении «Как правило слон больше черепахи.» он попросит поставить запятую, если одно и то же слово используется подряд (или с интервалом в несколько слов) — LT второе слово подчёркнет и при необходимости не сложно понять, есть смысл использовать синоним, может быть написать «этот, который» или так и оставить. Подобных простых проверок — сотни.

Форматирование исходного кода

Программа latexindent позволяет форматировать исходный код .tex файлов. Это делает код более читаемым и единообразным.

Для форматирования пользовательских документов можно использовать команду:

Можно указывать другой файл для форматирования. Например, для форматирования только файла MyFILE.tex :

По умолчанию настройки форматирования считываются из файла indent.yaml . Для использования другого файла настроек, наберите в командной строке:

Размер выходных .pdf файлов может быть большим. Особенно, если в тексте присутствует много рисунков с большим разрешением. Программа gs позволяет значительно уменьшить размер .pdf файлов за счёт снижения качества растровых изображений.

Для сжатия файла диссертации можно использовать команду:

Сжатый файл будет создан с суффиксом *_lowdpi.pdf

По умолчанию, разрешение изображений снижается до 144 DPI. Изменить разрешение и другие нюансы можно путём редактирования файла compress.mk

Сжать произвольный pdf файл somefile.pdf можно командой:

Пересборка pdf для типографии

Типографии могут выдвигать специальные требования к pdf файлам. Наиболее типичными являются:

отсутсвие прозрачности
задание всех цветов в CMYK
использование формата PDF версии 1.3

Для приведения pdf в соотвествие с данными требованиями можно использовать команду:

Принцип работы и возможные побочные эффекты описаны в compress.mk .

Отчёт о времени сборки

Для вывода на экран в конце сборки информации о затраченном времени можно использовать флаг TIMERON=1 . К примеру, запуск команды

выведет на экран в конце сборки информацию о времени, затраченном на каждый вызов используемого движка latex, а также суммарно затраченное время.

Сборка графики .tikz

В процессе создания графики с использованием библиотеки tikz требуется частая компиляция исходного файла. Производить её вместе с остальным текстом довольно затратно по времени.

Для ускоренной компиляции файлов .tikz отдельно от остального шаблона предусмотрен рецепт make tikz . Для запуска компиляции рисунка требуется задать путь к файлу .tikz при помощи переменной TIKZFILE .

сгенерирует файл tikz_plot.pdf в корневой папке.

Генерация раздаточного материала

Для защиты может потребоваться печать раздаточного материала презентации. В этих материалах содержатся слайды презентации и, возможно, комментарии к ним.

Если Вы читаете эту статью со смартфона, имейте в виду, что никаких переносов делать не надо. Пишите все команды слитно.

Таблицы и изображения имеют свойства появляться не там куда вы их хотите поместить, а там, куда их размещает LaTeX. Теоретически с этим можно бороться с помощью одного из параметров:

- который воспринимается LaTeXом как конец той области куда можно вставлять объекты, введенные в код выше.

такого действия не имеет.

Как вставить изображение LaTeX

Необходимый минимум знаний

Изображения нужно предварительно конвертировать в формат .eps.

Это означает, что .jpg, gif, .jpg и другие форматы работать не будут. Конвертировать в eps можно с помощью GIMP ,онлайн конвертеров, например, этого и другими способами

Дополнительная информация

Для удобства изображения можно хранить в отдельных каталогах. Например, по отдельному каталогу на каждую главу диплома. Все каталоги нужно перечислить, для того чтобы LaTeX смог их найти.

Два изображения в ряд

Как вставить таблицу LaTeX

Самое адекватное описание этой операции я нашёл в книге Роженко А.И. «Искусство верстки в LaTeXe»

Таблица, которая задана с помощью

Может занять слишком много места и не поместиться по ширине, для того, чтобы избежать этого, вместо простого выравнивания можно зафиксировать ширину столбцов

Теперь слишком широкий текст автоматически будет переноситься на следующую строку внутри столбца.

В WinEdt 6.0 есть кнопка, с помощью которой можно быстро вставлять таблицы нужного размера.

Однако, сперва нужно использовать теги

Чтобы объединить столбцы можно воспользоваться тегом

Работа с текстом

Подчёркивание

Подчёркивание текста делается командой

Курсив

Выделение текста курсивом

Жирный шрифт

Как выровнять текст в LaTeX

Если в титульном листе, или ещё где-то нужно как-то по-особому выровнять текст и вы не можете найти в книгах как это сделать можно попробовать теги

Внутри этих тегов текст будет выглядеть примерно так, как вы его напишете, т.е. пробелы не будут игнорироваться.

Набор формул в LaTeX

Есть два стандартных окружения для ввода формул: Первый и Второй

Такую простую формулу, можно было бы и без окружения написать, но уже для использования индексов окружение необходимо.

Если ваша формула очень будет занимать несколько строк окружение нужно заменить на:

Вместо слов "Ваша формула" нужно написать нужное уравнение.

Как правильно написать уравнение Вы можете узнать из параграфа: Основные математические операции и символы LaTeX

Как компилировать LaTeX

Получаем .dvi файл и если нам нужно конвертировать его в .pdf - нажимаем dvi - pdf

Как вариант можно сразу же компилировать в .pdf с помощью кнопки PDF LaTeX , но этот способ я не рассматриваю как основной.

Основные математические операции и символы LaTeX

Здесь представлены те операции и символы, которые я использовал при написании диплома.

Если непонятно как ставить пробел - изучите этот пример

Для того, чтобы создавать PDF файл нужно нажать кнопку dvi pdf. Перед этим желательно скомпилировать пару раз подряд, чтобы все ссылки расставились правильно.

Больше символов Вы можете найти в статье Символы LaTeX

Греческий алфавит в LaTeX

Написание греческих букв в LaTeX довольно логично. На английском языке оно вообще практически совпадает с обычным написанием. Но на всякий случай полезно иметь источник для самопроверки.

Комментировать код LaTeX

Метод, которым можно воспользоваться для комментирования кода в LaTeX зависит как от Ваших предпочтений, так и от установленных пакетов.

Этот текст не отобразится

Нумерация страниц в LaTeX

Если вас не устраивает нумерация, проставленная по умолчанию, можно задать номер cтраницы с помощью команды

где n - это номер станицы, который вы хотите установить.

Цветной текст в LaTeX

Чтобы иметь возможность менять цвет текста нужно импортировать пакет xcolor

После этого синего текста должна быть красная звёздочка *

Как конвертировать LaTeX в Word

Читал про большое количество способов. Многие попробовал. Расскажу, как обычно, про тот, который у меня заработал.

Сначала конвертируем .tex файл в .pdf

Конвертируем .pdf в .docx

У меня это получилось в Windows 7 и довольно кривом Office 10.

В Windows XP и кривом Office 2007 тоже получилось, но с формулами хуже. Нужно проверить в XP и 10м Office.

Примеры файлов LaTeX

Пример титульной страницы для диплома Посмотреть

Примеры набора формул приведены на странице LaTeX в HTML , чтобы не загружать эту.

Литература по LaTeX:

Книг по Латеху довольно много, в том числе и на русском языке. На последовательное освоение верстки в Латехе по учебнику нужно выделить достаточно много времени, также стоит иметь в виду, что различные темы освещены в учебниках с разной степенью доступности, а идеального учебника пока что не существует.

Я честно хотел его написать, но пока не осилил.

Пособия по LaTeX:

установка LaTeX из-под Linux

sudo apt-get install texlive-full

Устанавливаем редактор - texmaker - аналог winedt под windows.
Команда в консоли:

sudo apt-get install texmaker

Заходим в texmaker
Создаем новый файл, сохраняем его под произвольным именем.
Пишем LaTeX код
Компиляция - нажимаем кнопку F1.
Получаем готовый pdf документ.

LaTeX FAQ: возможные проблемы и способы их решения

LaTeX не распознаёт изображения .eps

Видеоуроки LaTeX

Для ускорения загрузки этой страницы все видеоуроки перенесены сюда

Преобразование LaTeX в HTML

О новом релизе утилиты для преобразования LaTeX документов в HTML код можно прочитать здесь

Make это изумительный инструмент, используемый программистами для создания программного обеспечения, но его можно использовать для гораздо большего. Я использую make всякий раз, когда у меня есть большой проект, включающий R-файлы и файлы LaTeX, что означает, что я использую его почти для всех статей, которые я пишу, и почти для консалтинговых отчетов, которые я создаю.

Если вы используете Mac или Linux, вы уже make установили. Если вы используете Windows и у вас установлен Rtools , то у вас также будет make . В противном случае пользователям Windows потребуется его установить. Одна реализация в GnuWin .

Мой типичный проект будет включать несколько R-файлов, содержащих код, который подходит для некоторых моделей, и генерировать таблицы и графики. Я пытаюсь все настроить, чтобы я мог заново создать все результаты, просто запустив R-файлы. Тогда у меня будет файл LaTeX, который содержит статью или отчет, который я пишу. Таблицы и графики, созданные R, помещаются в файл LaTeX. Следовательно, все, что мне нужно сделать, это запустить все R-файлы, а затем обработать текстовый файл, и документ / отчет будет сгенерирован.

Make полагается на то, Makefile чтобы определить, что он должен делать. По сути, a Makefile указывает, какие файлы должны быть сгенерированы в первую очередь, и как их генерировать. Поэтому мне нужно, Makefile что указывает, что все файлы R должны быть обработаны в первую очередь, а затем файл LaTeX.

Прелесть в Makefile том, что он будет обрабатывать только файлы, которые были обновлены. Он достаточно умен, чтобы не перезапускать код, если он уже был запущен. Так что, если ничего не изменилось, запуск make ничего не делает. Если изменяется только текстовый файл, при запуске make будет скомпилирован текстовый документ. Если код R изменился, при запуске make будет повторно запускаться код R для генерации новых таблиц и графиков, а затем повторная компиляция документа tex. Все, что я делаю, это печатаю, make и он выясняет, что требуется

Makefile для LaTeX

Легко сказать, нужно ли компилировать латексный документ — make просто нужно проверить, что PDF-версия документа старше, чем tex-версия документа. Вот простой, Makefile который будет обрабатывать документ LaTeX.

Первая строка указывает имя моего файла, в данном случае paper.tex . Вторая строка указывает, что файл pdf должен быть создан из файла tex, а последняя строка объясняет, как это сделать. Пользователи MikTeX могут предпочесть pdftexify вместо latexmk .

Чтобы использовать вышеизложенное Makefile , скопируйте код в простой текстовый файл Makefile и сохраните его в том же каталоге, что и ваш текстовый файл. Измените первую строку, чтобы использовать имя вашего текстового файла (без расширения). Затем введите make из командной строки в том же каталоге, что и текстовый файл, и он должен сделать все необходимое для преобразования вашего текста в pdf.

Конечно, вы обычно не будете беспокоиться, Makefile если это все, что он сделал. Но добавьте множество файлов R, и это станет очень полезным.

Makefile для R и LaTeX

Нам нужен способ, позволяющий make определить, был ли запущен R-файл. Если файлы R запускаются с использованием

LaTeX Workshop - этоVisual Studio Code Расширение, направлено на предоставление интегрированных функций и инструментов для набора текста LaTeX с использованием Visual Studio Code.

Если нет вклада от сообщества, этот проект не будет успешным, особенно нынешние и прошлые основные участники:

Jerome Lelong @jlelong
Takashi Tamura @tamuratak
Tecosaur @tecosaur
James Booth @jabooth

Обратите внимание, что начиная с версии 7.0.0 для LaTeX Workshop требуется как минимум VS Code 1.34.0.

1. Особенности

Это не полный список, а предварительный просмотр некоторых из самых крутых функций.

Создать LaTeX (включая BibTeX) PDF автоматически сохранить.
Мгновенно просматривайте PDF-файлы (в VS Code или браузере).
Прямой и обратный SyncTeX. Нажмите на .tex Источник и PDF Перепрыгивайте между позициями и наоборот.

Парсер журнала LaTeX автоматически сообщает об ошибках и предупреждениях в сборке LaTeX в VS Code.

Linting

Может использоваться с \ Первый фрагмент кода вводит множество команд LaTeX, а затем вводит некоторые команды, чтобы сузить поиск.
Используйте выделенный текст с командами LaTeX ctrl + l 、 ctrl + w . Появится новое меню для выбора команды. Это относится к множественному выбору. Использовать \ Первый метод устарел.

Мы также предоставляем некоторые другие механизмы фрагментов:

Греческий алфавит @ + letter . У некоторых букв есть варианты, доступны @v + letter Сказал. УвидетьВот。
Общая среда может пройти BXY Чтобы добраться, где XY Например, первые две буквы имени среды. BEQ Дает equation окружение. Если вам нужна звездная версия среды, используйте BSXX ,Например. BSEQ Дает equation* окружение. УвидетьВот。
Общие команды шрифтов могут быть FXY Получить, где XY Например, последние две буквы имени команды шрифта. FIT Дает \textit<>. . УвидетьВот。
Можно использовать многие другие математические символы @ Префикс для указания. УвидетьВот。

Помимо фрагментов кода, расширение также предоставляет несколько сочетаний клавиш, которые позволяют легко форматировать текст (и один или два другого содержимого).

2. Установка и основные настройки

2.1 Требования

LaTeX распространяется по системной PATH. Например,TeX Live。
Пожалуйста, обратите внимание,MikTeX Не поставляется с SyncTeX. пожалуйста, используйтеВстроенная функция synctex。
Рецепт по умолчанию для создания проектов LaTeX требует latexmk . Или вы можетеСоздайте свой собственный рецепт LaTeX。
Необязательный: УстановитьChkTeX Перейдите в проект lint LaTeX.
Необязательный: Если ваш дистрибутив LaTeX не поддерживает форматирование, вы можете установитьlatexindent.pl。

2.2 Установка

Установить LaTeX Workshop очень просто. Ты можешьVisual Studio Code Marketplace Найдите его в VS Code Quick Open ( ctrl/cmd + P ) Вбежать ext install latex-workshop 。

2.3 Установите переменную среды PATH

Обычно устанавливать переменную среды PATH не требуется. Дистрибутив TeX устанавливает переменные в вашей системе соответствующим образом. Более того, LaTeX Workshop никогда не касался этой переменной. Если VS Code не может найти исполняемый файл TeX, это означает, что настройки вашей системы повреждены. Чтобы узнать, как установить переменные среды в Windows, см.link Илиlink. В macOS и Linux обратитесь к команде разработчиков rbenvДокументация。

Если вы не можете восстановить системные настройки, вы также можете использоватьРецепт LaTeXиз env Атрибут переопределяет PATH.

2.4 Использование

Типичное использование - открыть .tex Файл и просмотрTeX Боковая панель для доступа ко всем расширенным функциям:

Если вы хотите получить доступ к некоторым из наиболее распространенных операций через контекстное меню, установите latex-workshop.showContextMenu Для true . Значение по умолчанию - false 。

2.5 Использование Docker

Начиная с 1.35.0, VS Code поддерживаетRemote - Containers из Docker . LaTeX Workshop хорошо работает с этим расширением. Пожалуйста, сначала попробуйте это расширение.

Начиная с версии 5.3.0 есть@Arxisos Экспериментальная реализация идеи поддержки Docker. Вы можете установить latex-workshop.docker.enabled Для true Использовать докер на базе LaTeX. Образ докера, который будет использоваться, определяется latex-workshop.docker.image.latex Определение, значение по умолчанию tianon/latex . Предлагаемое зеркало здесь 'pre-'pulled 。

@Arxisos Создано в докере для двоичного файла LaTeXсегмент кода, В то время как@lippertmarkus Как совместить докер с LaTeX WorkshopКраткое описание。

2.6 Использование WSL

Начиная с 1.35.0, VS Code прошелRemote - WSL Поддержка WSL. LaTeX Workshop хорошо работает с этим расширением.

3. Функция компиляции

3.1 Сборка документации

Файл LaTeX обычно передается из Command Palette Или Боковая панель TeX Вызов командыBuild LaTeX project Строить. Эта команда привязана к сочетанию клавиш ctrl+alt+b . Если его нельзя использовать в привязке клавиш ctrl+alt , УвидетьFAQ. Рецепт, вызываемый этой командой:latex-workshop.latex.recipe.default определение.

Если у вас многофайловый проект, см.Многофайловый проектЧтобы узнать больше о том, как найти корневой файл.

Вы можете определить несколько цепочек инструментов компиляции для использованияLaTeX recipes Чтобы собрать проект LaTeX, а затем вызвать командуBuild with recipe Чтобы выбрать подходящую цепочку инструментов для создания проекта. Или вы можете прямо изTeX Выберите соответствующий рецепт на боковой панели.

Следующие ниже настройки помогают настроить проект и устранять ошибки.

Индикатор выполнения показывает ход сборки. Его можно настроить с помощью следующих переменных конфигурации:

3.2 Завершить текущую компиляцию

Чтобы завершить текущую компиляцию, вы можете вызвать из командной панели Kill LaTeX compiler process , Или через боковую панель TeX в Build LaTeX Project Terminate current compilation 。

3.3 Автоматическая сборка LaTeX

"never" : Отключить автоматическое создание
"onFileChange" : Сборка проекта при обнаружении любых изменений файлов в зависимостях. Вы даже можете изменять файлы вне vscode. вВотВы можете увидеть объяснение того, что такое зависимости и как игнорировать некоторые из них.

3.3.2 latex-workshop.latex.autoBuild.interval

Минимальный интервал времени (в миллисекундах) между двумя последовательными автоматическими построениями.

Типы	По умолчанию
integer	1000

3.4 Очистить сгенерированные файлы

Компиляция LaTeX обычно генерирует несколько вспомогательных файлов. Может быть вызван из командной панели или боковой панели TeX Clean up auxiliary files Чтобы удалить их. Эта команда привязана к ctrl+alt+c . Если его нельзя использовать в привязке клавиш ctrl+alt , УвидетьFAQ。

«Никогда»: отключить автоматическую очистку.
«OnFailed»: очистить проект после сбоя компиляции.
«OnBuilt»: очистить проект после завершения компиляции, независимо от того, была ли компиляция успешной или нет.

3.5 LaTeX recipes

Рецепт LaTeX относится к серии команд, которые LaTeX Workshop последовательно выполняет при построении проекта LaTeX. это из latex-workshop.latex.recipes Определено. По умолчанию LaTeX Workshop содержит переменные latex-workshop.latex.recipes с участием latex-workshop.latex.tools Определены два основных рецепта:

Первый просто полагается на latexmk команда
Вторая команда выполняет следующую последовательность команд: pdflatex → bibtex → pdflatex → pdflatex 。

Каждый инструмент, который появляется в поле инструментов, определяется как latex-workshop.latex.tools . Значение по умолчанию равно:

Вы можете создать несколько рецептов, используя разные инструменты. Каждый рецепт является объектом в списке конфигурации и содержит один name Поля и одно, которое будет называться в рецепте tools Список.

в рецептах tools допустимый latex-workshop.latex.tools Определен в, где каждая команда представляет собой tool . Каждый инструмент - это объект, включая name , Тот, который будет сгенерирован command , параметр ( args ) И некоторые конкретные переменные среды ( env )。 env Запись - это словарь. Предположим, вы хотите использовать его в своем домашнем проекте. texmf Поддиректории, просто напишите:

Вы также можете переопределить переменную среды PATH.

Чтобы включить инструменты в рецепт, название инструмента должно быть включено в список инструментов в рецепте.

При сборке проекта будет использован магический комментарий в корневом файле, иначе будет использован первый рецепт. Вы можете составить другой рецепт командой latex-workshop.recipes. Latexmk используется по умолчанию. Этот инструмент входит в состав большинства дистрибутивов LaTeX и требует для выполнения perl. Пользователям, не использующим Perl, стоит попробовать следующую цепочку инструментов texify от MikTeX:

Заполнитель	Заменить
%DOC%	Путь и имя корневого файла LaTeX без расширения .tex
%DOCFILE%	Имя корневого файла LaTeX без расширения .tex
%DIR%	Путь к корневому файлу LaTeX
%TMPDIR%	Временная папка для хранения вспомогательных файлов
%OUTDIR%	Каталог вывода настроен в latex -shops.latex.outDir

Кроме того, вы также можете настраивать команды без использования заполнителей, как и те, что вы можете вводить в терминале. Поскольку большинство компиляторов LaTeX не принимают расширения,% DOC% и% DOCFILE% не включают расширение .tex. В то же время texify нужно расширять. Поэтому в приведенном выше инструменте для полноты свяжите% DOC% и .tex.

latex-workshop.latex.recipe.default
определяет рецепт, используемый командой проекта Build LaTeX.
type default value possible values
string “first” “first”,“lastUsed”
«Первый»: используйте первый рецепт, определенный в latex-workshop.latex.recipes.
"lastUsed": использовать последнюю использованную формулу, предоставленную студией LaTeX.
latex-workshop.latex.build.forceRecipeUsage
Принудительно использовать систему рецептов, даже если есть волшебный комментарий, определяющий команду TeX.
type default value
boolean false
Команда внешней сборки
Хотя описанный выше механизм рецептов универсален, когда сборка всего проекта LaTeX выполняется с помощью личного сценария или Makefile, он может не соответствовать вашим потребностям. Для этого особого случая мы предоставляем внешний механизм команд сборки, который полностью обходит механизм рецептов. Просто используйте следующие две переменные конфигурации, чтобы определить команду и ее параметры.

Это очень полезно, когда компиляция зависит от Makefile или пользовательских скриптов. Когда он определен, он полностью обходит механизм определения рецептов и корневых файлов.
type default value
string “”
latex-workshop.latex.external.build.args
При вызове latex-workshop.build параметры команды latex.external.build.
type default value
string[] []

Волшебный комментарий
Программа и параметры TeX
LaTeX Workshop поддерживает волшебный комментарий программы%! TEX для указания программы компилятора. Однако рекомендуется использовать систему рецептов вместо волшебной программы для определения процесса сборки, поскольку последняя используется только для обратной совместимости.

Для волшебного комментария программы%! TEX его параметры определены в latex -shops.latex.magic.args:

Или вы также можете использовать магическую аннотацию, чтобы напрямую определить параметр args!% TEX в файле .tex, который переопределяет latex -shops.latex.magic.args. Обратите внимание, что он должен содержать файл для обработки. Например, чтобы воспроизвести поведение по умолчанию, вы должны использовать

%! TEX option = -synctex = 1 -interactive = non-stop mode -file line error "% DOC%"
Предположим, что в корневом файле есть строка%! TEX program = xelatex. После сборки проекта LaTeX Workshop проанализирует корневой файл и определит, что следует использовать xelatex.

Процедуры и варианты BIB
При использовании программы%! TEX с библиографией компилятор bib должен быть определен с помощью комментария программы%! bib, например,%! bib program = bibtex. В противном случае расширение будет запускать только одну компиляцию с использованием указанного компилятора LaTeX. При необходимости вы можете использовать latex -shops.latex.magic.bib для передачи дополнительных параметров программе! BIB. Параметрические переменные:

В качестве альтернативы вы также можете использовать магическую аннотацию, чтобы напрямую определить параметр args!% BIB в файле .tex, который переопределяет latex -shops.latex.magic.bib.args. Обратите внимание, что он должен содержать файл для обработки. Например, чтобы воспроизвести поведение по умолчанию, вы должны использовать параметр!% BIB = "% DOCFILE%".

Отловить ошибки и предупреждения
Предупреждения и ошибки, выдаваемые цепочкой инструментов компиляции, отображаются на панели "Проблемы". Следующие параметры позволяют настроить то, что вы хотите получить на этой панели. Если информация, отображаемая на панели, кажется неправильной, обратитесь к FAQ.

К исходному журналу компилятора можно получить доступ на панели «Вывод», выберите «Компилятор LaTeX». По умолчанию журнал очищается перед вызовом каждого инструмента рецепта. Если вы хотите вести журналы всех инструментов в рецепте, установите latex -shops.latex.build.clearLog.everyRecipeStep. Сделайте это ложью.

Детали настройки
latex-workshop.message.log.show
Отобразить журнал отладки латексной мастерской на панели вывода.

Этот атрибут определяет, будет ли LaTeX Workshop выводить свой журнал отладки на панель журнала.

Тип по умолчанию
Boolean true
latex-workshop.message.badbox.show
отображает информацию о плохих ящиках на панели вопросов.

Тип по умолчанию
Boolean true
latex-workshop.message.update.show
Отображение новой версии обновленной информации латексной мастерской.

Тип по умолчанию
Boolean true
latex-workshop.latex.build.clearLog.everyRecipeStep.enabled
Очищайте журнал компилятора LaTeX перед каждым шагом рецепта.

Установите для этого свойства значение false, чтобы вести журналы всех инструментов в рецепте.

Читайте также: