PaleALEのインストールは3つの手順を踏みます。
- ツール類のインストール
- LaTeX Workshopのインストールと設定
- LaTeXプロジェクト構造の設定
このうち、1と2はコンピュータ（あるいはユーザー・アカウント）に対して1度だけ行えば済みます。3はLaTeX文書プロジェクト（つまり論文や書籍）ごとに設定する必要があります。
PaleALEはVisual Studio Codeをインストールしません。Visual Studio Codeは手作業でインストールしてください。
以下にこれらの作業について説明します。なお、Ubuntu / WSL / Visual Studio Codeのインストール方法及び一般的な使い方については説明しません。これらについては各種資料を参考にしてください。
ツール類のインストールを行うには、最初にこのページの右にあるリリースからプロジェクトの全ファイルをダウンロードしてください。 次にPaleALEプロジェクトのルート・ディレクトリにあるinstallスクリプトを実行してください。引数は不要です。
sudo ./install
インストール・スクリプトは以下のツールと、その他必要なモジュールをインストールします。
- TeX Live
- DrawIO
- ImageMagick
また、ImageMagickについてはポリシー・ファイルを編集し、PDFデータを出力できるようにします。
インストールに使用した仮ファイルはすべて /tmp 下に置かれます。これらはUbuntuを再起動した際に消去されます。
LaTeX WorkshopはVisual Studio Codeの拡張機能であり、LaTeX文書作成時にユーザーを支援してくれるモジュールです。
LaTeX Workshop拡張機能のインストールに当たっては当然ながら事前にVisual Studio Codeをインストールしている必要があります。拡張機能のインストールについてはLaTeX Workshopの公式ページを参考にしてください。
LaTeX Workshopのインストール後、Visual Studio Codeのsetting.jsonを編集します。settings.jsonの開き方についてはネット上に多くの資料がありますのでそちらを参考にしてください。例えばVS Codeのsettings.jsonの開き方が参考になるでしょう。
Settings.jsonを開いたら、以下のコードを追加してください。なお、追加にあたってはJSON形式をある程度理解している必要があります。事前にならんかの資料を読んでおく事をお勧めします。
大雑把に言えば、一番外側の"{"と"}"の中に以下のコードを埋め込みます。
このコードはVSCode で最高の LaTeX 環境を作るで公開されている設定ファイルを変更して、LaTeXのビルド前に画像ファイルの変換を行うようにしたものです。
// ---------- Language ----------
"[tex]": {
// スニペット補完中にも補完を使えるようにする
"editor.suggest.snippetsPreventQuickSuggestions": false,
// インデント幅を2にする
"editor.tabSize": 2
},
"[latex]": {
// スニペット補完中にも補完を使えるようにする
"editor.suggest.snippetsPreventQuickSuggestions": false,
// インデント幅を2にする
"editor.tabSize": 2
},
"[bibtex]": {
// インデント幅を2にする
"editor.tabSize": 2
},
// ---------- LaTeX Workshop ----------
// 使用パッケージのコマンドや環境の補完を有効にする
"latex-workshop.intellisense.package.enabled": true,
// 生成ファイルを削除するときに対象とするファイル
// デフォルト値に "*.synctex.gz" を追加
"latex-workshop.latex.clean.fileTypes": [
"*.aux",
"*.bbl",
"*.blg",
"*.idx",
"*.ind",
"*.lof",
"*.lot",
"*.out",
"*.toc",
"*.acn",
"*.acr",
"*.alg",
"*.glg",
"*.glo",
"*.gls",
"*.ist",
"*.fls",
"*.log",
"*.fdb_latexmk",
"*.snm",
"*.nav",
"*.dvi",
"*.synctex.gz"
],
// 生成ファイルを "out" ディレクトリに吐き出す
"latex-workshop.latex.outDir": "out",
// LaTeX Workshopに表示されるビルドのレシピ
"latex-workshop.latex.recipes": [
{
"name": "latexmk",
"tools": [
"convert2pdf-process",
"latexmk-process"
]
},
],
// ビルドのレシピに使われるモジュール
"latex-workshop.latex.tools": [
{
"name": "latexmk-process",
"command": "latexmk",
"args": [
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"-outdir=%OUTDIR%",
"%DOC%"
],
"env": {}
},
{
"name": "convert2pdf-process",
"command": "script/convert2pdf",
"args": [
"%OUTDIR%"
]
},
], LaTeXプロジェクトの構造は、論文や書籍ごとに設定しなければなりません。 なお、以下の作業が面倒ならば、PaleALEのsample ディレクトリをコピーして修正するとよいでしょう。
必要な作業は以下の通りです。なお、この説明において「文書ルート」とはプロジェクトの最上位ディレクトリの事です。文書ルートにはLaTeXのソース・ファイルをおさめます。すなわち、*.texファイル起き場です。
- 文書ルートに.latexmkrcをコピーする
- 文書ルートにscriptディレクトリをコピーする
- 文書ルートにimage_srcディレクトリを作る
.latexmkrcは、PaleALEが使用するlatexmkコマンドの設定ファイルです。このファイルは、TeXビルドの各パスで何をするかを指定しています。なお、.latexmkrcファイルはVSCode で最高の LaTeX 環境を作るで公開されているものを修正して使用しています。
.latexmkrcは文書ルートディレクトリのほか、ホームディレクトリにおいても構いません。
scriptディレクトリにはファイル変換を行うスクリプトが納められています。手作業で変換する場合は、文書ルートからコマンドラインで以下のスクリプトを実行してください。
./scirpt/convert2pdf
image_srcディレクトリは名前の通り、LaTeX文書に挿入する画像のソースを置きます。ここには、GIF, PND, JPEG, PDF, draw.ioファイルを置くことが出来ます。PaleALEはビルド中に文書ルート直下にimageディレクトリを作り、image_srcの画像ファイルから生成したPDFファイルを置きます。
文書ディレクトリの構造についてはFILES.mdも参考にしてください。