mthesis-style

(NAIST非公式) 修論・博論のTeXテンプレート

Visual Studio Codeを使ったコンパイル方法

MacでもWindowsでも使える設定だが、TeX LiveなどのTeXディストリビューションはインストール済みの前提とする。

LaTeX Workshopをインストール・設定

VSCodeのLaTeXファイル用プラグインであるLaTeX Workshopをインストールする。

• Win: ファイル > 基本設定 > 設定
• Mac: Code > 基本設定 > 設定

で setting.json を開く。 Ctrl + ,でも開く。 以下のように書く。

"latex-workshop.latex.tools": [
    {
      "command": "ptex2pdf",
      "args": ["-l", "-ot", "-kanji=utf8 -synctex=1", "%DOC%"],
      "name": "ptex2pdf"
    },
    {
      "command": "pbibtex",
      "args": ["%DOCFILE%", "-kanji=utf8"],
      "name": "pbibtex"
    }
  ],
  "latex-workshop.latex.recipes": [
    {
      "name": "toolchain",
      "tools": [
        "ptex2pdf",
        "pbibtex",
        "ptex2pdf",
        "ptex2pdf"
      ]
    }
  ],
  "latex-workshop.view.pdf.viewer": "tab",
  "latex-workshop.chktex.enabled": false

• latex-workshop.latex.tools: 昔はlatex-workshop.latex.toolchainという名前だったらしい。 参考文献をbibtexで書く場合、

  • texファイルのコンパイル
  • bibtexファイルのコンパイル
  • texファイルのコンパイル
  • texファイルのコンパイル

  と4段階の操作が必要らしい。毎度4段階も操作をしないといけないのはめんどくさいのでこれらの一連の操作を一発でやってくれる君を作る。ここのtoolsでは一発でやってくれる君に渡す操作の名前とコマンドを登録する。ちなみにTeXで目次を出すのは2回コンパイルが必要だが、それもこの一連の操作でカバーできる。

• latex-workshop.latex.recipes こいつが一発でやってくれる君。nameはなんでもいい。toolsに4段階の操作を登録する。

• latex-workshop.view.pdf.viewer できたpdfを表示する方法。tabを指定するとVSCodeのタブで表示される。ブラウザに出すこともできる。個人的に好きなのは、タブで表示するとエディタが右側に分割されてpdfが表示されるので、できたタブを左側に移動させるやり方。

• latex-workshop.chktex.enabled chktexっていうのがTeXの構文チェックをやってくれる君なのだが、日本語にやたら警告を出してきてウザいので無効化した。

ビルド

基本的にtexファイルを保存したらrecipesの通りにビルドしてくれる。保存時以外にビルドしたい場合は Ctrl + Alt + B、pdf表示は Ctrl + Alt + V。できない場合はショートカット設定が必要かも。F1で Build Latex Project とか View PDF File in new tab とか呼び出すのでもできる。

Latexmkを使ったコンパイル方法

Latexmkはソースコードの変更を検出し，LaTeXやBibTeXを自動的に必要な回数だけ 実行してくれるツールである． このリポジトリにはLatexmkの設定ファイルである.latexmkrcを既に準備してある．

コンパイル

下記のコマンドを実行する．

$ latexmk

プレビュー

下記のコマンドを実行すると，ソースコードをコンパイルした後，生成された PDFファイルをPDFビューアで開く．

$ latexmk -pv

.latexmkrcにおいて$pdf_previewerという変数を設定すると，使用するPDFビューア を指定できる．PDFファイルを排他ロックせず，かつ，変更があった際に自動再読み込み するPDFビューアを使用すると便利である．macOSでは例えばSkimがこれらの条件を満たす．

変更の監視

下記のコマンドを実行すると，ソースコードへに変更があった際に 自動的にコンパイルを実行し，生成されたPDFファイルをPDFビューアで開く．

$ latexmk -pvc

(おまけ) bibtexのTips

LaTeX Workshopにbibtexのリンターは入ってないっぽいのでほしいなら別途入れる。

自分で書くのダルいよね

参考文献をbibtexで書く場合、Google Scholarで出てくるようなものであれば、検索結果の''のマークをクリックしたらbibtexフォーマットで予め情報が書かれているものが手に入る。

英語タイトルで大文字が小文字になる

タイトルを{{Some Title}}とか””Some Title””とか2重で囲むとちゃんと大文字が反映される。

著者が複数いる場合

jsonとかに慣れてるとハマりやすいのが著者の区切り方。,ではなくandで区切る。,は氏と名の区切りで使う。