日記

日本語の勉強のためのブログ

トップ > VSCode > (※修正版あり)【Windows】VSCode+pLaTeX環境を構築した(2022)

(※修正版あり)【Windows】VSCode+pLaTeX環境を構築した(2022)

VSCode LaTeX

より簡単にplatex環境を構築できるように手順を修正したので，そちらをご覧ください．↓

everykalax.hateblo.jp

一応以下の手順でもpLaTeXは使えるようになるので，記事は残しておきます．

pLaTeXが必要になったのでメモ。
※追記ばかりで読みづらいのでまとめ直すかも

環境

  • Windows 11 Pro (version: 22H2)
  • Visual Stusio Code (version: 1.74.1)
  • LaTeX Workshop (v9.1.1)
  • TeXLive 2022

手順

まず次の記事を読んで基本的なLaTeX環境を構築した。
https://qiita.com/passive-radio/items/623c9a35e86b6666b89e

しかしこのままではpLaTeX文書をコンパイルすることができない。
※ビルドレシピにpLaTeXの記述があるため可能のように思われるが、このレシピでビルドしたところ、自分の環境では無限ループに陥ってしまった。

そのため、この記事を読み、pLaTeX用のビルドレシピを追加した。
具体的には、settings.jsonのlatex-workshop.latex.toolsに

{
  "name": "pLaTeX",
  "command": "platex",
  "args": [
    "%DOC%"
  ],
  "env": {}
},
{
  "name": "dvipdfmx",
  "command": "dvipdfmx",
  "args": [
    "-V 4",
    "%DOC%"
  ]
}

を追加し、
latex-workshop.latex.recipesに

{
  "name": "pLaTeX + dvipdfmx",
  "tools": [
    "pLaTeX", // 相互参照のために2回コンパイルする
    "pLaTeX",
    "dvipdfmx"
  ]
}

を追加した。

2023/01/29 追記

pdf形式の図を追加してコンパイルすると、dvipdfmx:warning: Trying to include PDF file with version (1.7), which is newer than current output PDF setting (1.4).という警告が出た。
これは上記コードでdvipdfmxについて記載している部分が問題である。argsにPDFファイルのバージョンとして-V 4が指定されているが、これを-V 7などに変更すれば警告は消える。修正後のコードを以下に示す。

{
  "name": "dvipdfmx",
  "command": "dvipdfmx",
  "args": [
    "-V 7", // 変更部分
    "%DOC%"
  ]
}

参考: LaTeXのPDFバージョン · Issue #62 · kaityo256/lab_startup · GitHub

pdfをoutディレクトリに出力したい(2023/04/27追記)

"latex-workshop.latex.outDir": "out"と設定した上で，以下のように設定を変更する．

{
  "name": "pLaTeX",
  "command": "platex",
  "args": [
    "-output-directory=%OUTDIR%",  // 修正箇所
    "%DOCFILE%", 
  ],
},
{
  "name": "dvipdfmx",
  "command": "dvipdfmx",
  "args": [
    "-V 7",
    "-o%OUTDIR%/%DOCFILE%.pdf",  // 修正箇所
    "%OUTDIR%/%DOCFILE%"  // 修正箇所
  ]
},

付録: BibLaTeXを使えるようにする

まずTexLiveでbiberとbiblatex、そして使いたいスタイル(例: biblatex-ieee)をインストールする。

その後setting.jsonの"latex-workshop.latex.tools"に以下を追記し、

{
  "name": "Biber",
  "command": "biber",
  "args": [
    "%DOCFILE%"
  ]
}

"latex-workshop.latex.recipes"に以下を追記する。

{
  "name": "pLaTeX + Biber + dvipdfmx",
  "tools": [
    "pLaTeX",
    "Biber",
    "pLaTeX",
    "pLaTeX",
    "dvipdfmx"
  ]
}

これで使えるようになるはず。

基本の使い方

ファイルの先頭などに↓を書いておき、

\usepackage[backend=biber, bibstyle=ieee]{biblatex} % bibstyleは使いたいスタイルによって変える
\addbibresource{ref.bib} % ここに使用するbibファイルを渡す

参考文献を表示する部分で↓を書く。

\printbibliography[title=参考文献]

なお、上記の\usepackage[]{biblatex}にはbibstyle以外にもパラメータを渡すことができ、例えばURLを表示したくないならurl=false、doi情報を非表示にするならdoi=falseなどと柔軟に変更することが可能である。
参考: https://qiita.com/shiro_takeda/items/fac1351495f32c224a28

その他わかりやすかったサイトを載せておく。

付録2: コンパイル中止ショートカットを追加する

(2023/02/12追記)

コンパイル開始は右上の▷ボタンを押せばいいので簡単だが，エラー等でコンパイルに失敗した際，コンパイルを中止するためには

  1. 右側のバーからLaTeX Workshop拡張を開く
  2. CommandsからTerminate current compilationをクリック

という操作を行う必要があり面倒である．

この手間はショートカットキーを追加することによって解消することができる． ユーザ設定→キーボードショートカットでLaTeX Workshop: Kill LaTeX compiler processをクリックし，キーバインドを追加する． するとそのショートカットキーを押すことでコンパイルを中止することができる．

付録3: platex+dvips+ps2pdfでコンパイルする

(2023/03/16追記)

setting.jsonの"latex-workshop.latex.tools"に以下を追記し、

{
  "name": "dvips",
  "command": "dvips",
  "args": [
    "-z",
    "-f",
    "%DOC%"
  ]
},
{
  "name": "ps2pdf",
  "command": "ps2pdf.exe",
  "args": [
    "%DOCFILE%.ps" // %DOC%だとエラー出るので変更
  ]
}

"latex-workshop.latex.recipes"に以下を追記する。

{
  "name": "pLaTeX + dvips + ps2pdf",
  "tools": [
    "pLaTeX", // cite相互参照のために2回コンパイルする
    "pLaTeX",
    "dvips",
    "ps2pdf"
  ]
}

ちなみに%DOC%と%DOCFILE%の違いについては以下リンク参照．
QA: VSCode + WSLの環境におけるlatexmkによるコンパイルについて

付録4: TeX Live 2022から2023へのアップグレードについて

(2023/03/25追記)

TeX Live Managerを開いてパッケージをアップデートしようとしたところ，図1のように表示され失敗した．

図1. アップデートに失敗した画面

tlmgr update --self --allでアップデートできると聞いたので試してみたが，またも失敗した．以下の出力によると，どうやらTeX Live 2023が公開されたらしい．

tlmgr.pl: Local TeX Live (2022) is older than remote repository (2023).
Cross release updates are only supported with
  update-tlmgr-latest(.sh/.exe) --update
See https://tug.org/texlive/upgrade.html for details.

勘違いしていたのだが，上記リンク(https://tug.org/texlive/upgrade.html)によると，TeX Liveはアップグレード(2022版から2023版への更新)という概念がないらしく，2023年バージョンのインストーラーを用いて再インストールする必要があるとのこと．
そのため面倒だがインストールし直した．インストール方法については先の記事と同様．
今までにインストールしたパッケージもインストールし直す必要があるが，面倒なのでエラーが出たときにインストールすることにした．

なおTeX Live 2022のアンインストールは，スタートメニューのアプリ一覧にある「Uninstall TeX Live」から行える．