VSCode で LaTeX を書いている人は, 書き始める前に settings.json をどこかからコピペしてきたことと思います. 私もかつてそうでしたが, 最近 LaTeX エンジンを変えたタイミングで設定を見直したので, そのときのメモを書いておきます.
参考文献
そもそもの話
これから TeX を書き始める人に向けて, 最初に少しだけ補足説明をします.
- TeX とは, 数式を含む文書をきれいに書くためのソフト, またはそこで使われるプログラミング言語 だと思ってもらえれば基本的にはいいと思います.
- LaTeX とは, TeX を楽に書くためのマクロ1です. 「 TeX で書く」と言った場合は, 十中八九実際には LaTeX で書いています. まあ, TeX と LaTeX の違いなんて気にしなくてもいいです.
- VSCode とは, プログラミング言語を書くためのテキストエディタ です. 便利な拡張機能がそろっているのでプログラミングをする多くの人が使っています.
- LaTeX Workshop とは, LaTeX のための VSCode 拡張機能 です. この記事では, この拡張機能の設定について解説します.
-
settings.jsonとは, VSCode の設定のうちでデフォルトから変更した項目を記したファイル です. このファイルを修正することで, LaTeX Workshop のみならず, 設定を変更できます. ただし修正する際は, json ファイルの形式2に従って書く必要があります. 開くには,Ctrl + Shift + Pでコマンドパレットを開いてOpen User Settings (JSON)と入力します.
見直した結果
修正後の私の settings.json の LaTeX Workshop に関する部分を以下に記します.
{
"latex-workshop.latex.autoBuild.run": "onSave",
"latex-workshop.latex.recipes": [
{
"name": "ptex2pdf",
"tools": [
"ptex2pdf"
]
}
],
"latex-workshop.latex.tools": [
{
"name": "ptex2pdf",
"command": "ptex2pdf",
"args": [
"-l",
"-u",
"-halt-on-error",
"%DOC%"
]
}
]
}
latex.autoBuild.run について
自動ビルドするタイミングを never , onSave , onFileChange から選んで設定します.
| デフォルト | 見直し後 |
|---|---|
onFileChange |
onSave |
ここは onFileChange , onSave のどちらでも, 保存するタイミングで自動でビルドされます. onSave にしておくことで, ビルドせずに保存することができるようになります.3
latex.autoClean.run について
補助ファイルを自動削除するタイミングを never , onFailed , onBuilt から選んで設定します. デフォルトで never になっています.
※ settings.json 中の記述を削除しました（2023/05/03 変更）.
latex.clean.fileTypes について
自動削除する補助ファイルの拡張子を指定します.
| デフォルト | 見直し後 |
|---|---|
| （たくさん） | （なし） |
編集中に作成される主な補助ファイルは次の通りです. それぞれ以下の理由から自動削除の対象にはしませんでした.
-
.auxファイル : 削除すると必要なビルド回数が増える. -
.outファイル : 削除するとなぜかエディタの側でエラーが出ることがある. -
.tocファイル : 削除すると目次を出力できなくなる. -
.dviファイル : ビルドにptex2pdfを使えばそもそも残らない. -
.logファイル : エラー時に参照したい.
※ settings.json 中の記述を削除しました（2023/05/03 変更）.
latex.recipes について
ビルドに使用する 1 つまたは複数のツール（後述）を実行する順にひとまとまりにして名前を付けます（ツールをまとめたものを「レシピ」といいます）. レシピが複数ある場合は通常, 最初に記されたレシピが実行されます.
| デフォルト | 見直し後 |
|---|---|
| （たくさん） |
ptex2pdf 1 回のレシピのみ |
latex.tools について
実際に実行されるコマンドに名前を付けます. 名前を付けたものは「ツール」としてレシピを構成します.
"command"には使用するソフトを指定し, "args" には引数を指定します.
| デフォルト | 見直し後 |
|---|---|
| （たくさん） |
ptex2pdf のみ |