実際のプロジェクトに含まれるファイル

.tex、.bib、.cls、.sty、そしてコミットすべきでない生成物。

実際のプロジェクトに含まれるファイル

実際の LaTeX プロジェクトのフォルダーをコンパイル後に開くと、自分で書いたよりはるかに多くのファイルがあります。初心者はたいてい驚きますし、間違ったものを消してしまう不安から、フォルダーがいつまでも散らかったままになります。これを解消する区別は次のとおりです。ファイルには、自分で編集するソース、テンプレートやパッケージが提供するスタイル、そしてコンパイラが実行のたびに作り直す生成物の作業領域があります。

自分で書くファイル

.tex ファイルには、文章、セクション、図、数式といった、ドキュメントの実体が入ります。.bib ファイルは参考文献のデータベースで、引用する可能性のある論文や書籍ごとに 1 つの項目があります。手で管理することも、Zotero のような文献管理ソフトからエクスポートすることもできます。これらは、バックアップを取りバージョン管理に入れる価値のあるファイルです。それ以外のすべては、これらから再構築できるからです。

テンプレートが提供するファイル

.cls ファイルは、\documentclass{...} で指定するドキュメントクラスを定義します。ジャーナルや学会は、すべての投稿が同じ見た目になるように独自のクラスを配布しており、これを編集することはほとんどありません。.sty ファイルはパッケージで、\usepackage で読み込む再利用可能なマクロと設定です。自分で書くのは、複数のドキュメントでカスタムコマンドを共有したくなったときだけです。.bst ファイルは BibTeX の引用スタイルを記述するもので、これも通常は、投稿先が用意したものをそのまま置くだけです。

コンパイラが作るファイル

.aux ファイルには、コンパイルの各パスの間で受け渡す相互参照と引用のデータが保存されます。編集してはいけませんが、削除してもかまいません。次のコンパイルで書き直されるためです。.log ファイルには、コンパイラが行ったすべてが記録されており、何か問題が起きたときにだけ開く価値があります。.pdf は、実際に欲しかった出力です。

拡張子役割手で編集するか
.texソースのドキュメントと章する
.bib参考文献データベースする (または Zotero からエクスポート)
.clsドキュメントクラスまれに。ベンダーのテンプレート
.styパッケージ / スタイルファイル自分でマクロを書くとき
.bstBibTeX スタイルまれに
.aux相互参照のデータしない (生成物)
.logコンパイラのログデバッグ時に読む
.pdf出力閲覧 / 提出

規模が大きくなっても通用するプロジェクト構成

paper/
main.tex
chapters/
figures/
refs.bib

最上位の main.tex が入口の役割を果たします。章は専用のフォルダーに置いて \input や \include で取り込み、画像は figures/ に入れ、参考文献は 1 つの refs.bib にまとめます。この構成は、4 ページの論文でも学位論文でも、扱いやすさを保てます。各部分のつながりは、章ファイルの分割で説明しています。

Git を使うなら、*.aux、*.log などの生成ファイルを .gitignore に追加し、履歴が本当のソースだけを追跡するようにします。Oleafly のプロジェクトはディスク上の普通のフォルダーなので、この助言はそのまま当てはまります。最もよくある間違いは、その逆です。原因の分からないコンパイルエラーを調べているとき、.aux ファイルを削除すると直ることがよくあります。失敗した実行で残った古いファイルが、その後のすべてのコンパイルを狂わせることがあるからです。

ループを開く に戻る