ドキュメントへのアクセス方法とヘルプの求め方
このレッスンでは LaTeX 関連のソフトウェアやパッケージのドキュメントにアクセスする主要な方法を紹介します.さらに問題が発生した場合に,どのようにヘルプを求めればいいかも見ていきます.
パッケージや文書クラスのドキュメントにアクセスする方法はいくつかあります.
texdoc
TeX ディストリビューション(TeX Live や MiKTeX)をドキュメント込みでインストールしている場合,texdoc
というコマンドラインツールを使用してローカルに保存されたドキュメントにアクセスすることができます.
texdoc 〈パッケージ名〉
を実行すると 〈パッケージ名〉
に対応するドキュメントが開きます.このツールは利用可能なドキュメントを検索し,検索ワードに最も関連性が高いと判断したものを開きます.また次のようにすることで,見つかった利用可能なドキュメントを一覧表示させることもできます:
texdoc -l 〈パッケージ名〉
texdoc.org
texdoc
コマンドと同様の機能を提供するウェブサイトもあります.このサイトでは,ちょうど texdoc -l
のようにドキュメントを検索して選択肢の中から好みのものを選んで閲覧することができます.
CTAN
CTAN (Comprehensive TeX Archive Network) は TeX 関連の成果物を集積するネットワークです.ほとんどの LaTeX パッケージはここに登録されています.このサイトでパッケージを検索してドキュメントを閲覧することも可能です.一般にパッケージは ctan.org/pkg/〈パッケージ名〉
という位置に保存されているので,そこにアクセスすると README をはじめ CTAN にアップロードされているドキュメントを見ることができます.
LaTeX に関する書籍(英語)
LaTeX についてもっと詳しく学ぶのに役立つ本は数多く出版されています.LaTeX 初心者の場合は,初心者向けに構成された入門書を読むのがよいでしょう.そうした本には,このチュートリアルよりもさらに詳しい解説が載っているはずです.以下では,具体的に文献を紹介していきます.
LaTeX 開発チームは書籍のリストを公開しています.このリストに載っている本の多くは,LaTeX チームのメンバーによって執筆されたものです.最も重要なものは Lamport の公式ガイドと網羅的な解説書である『LaTeX コンパニオン』です.
その他の LaTeX 学習本には次のようなものがあります:
- Helmut Kopka, Patrick Daly 著 Guide to LaTeX: 電子書籍
- Nicola Talbot 著 LaTeX for Complete Novices: 無償の電子書籍,廉価の紙書籍
- Nicola Talbot 著 Using LaTeX to write a PhD thesis: 無償の電子書籍,廉価の紙書籍
- Stefan Kottwitz 著 LaTeX Beginner’s Guide: 電子書籍,紙書籍
- Marc van Dongen 著 LaTeX and Friends: 電子書籍,紙書籍
ヘルプを求める
LaTeX に関する質問をすることができるオンラインフォーラムはたくさんあります.現在最も人気の高い QA サイトはおそらく以下の通りです.
- 英語圏:TeX - LaTeX StackExchange
- 日本語圏:TeX フォーラム
こうした場所で質問をする場合は常に,再現手順を明確にすることが最重要です.つまり,いわゆる最小再現コード例 (Minimal Working Example; MWE) を作ることが大事です.これは問題を自己解決する必要はありませんが(それができるなら質問しないですよね),できる限り明確で,自己完結していて,最小のコード例を作りましょう.言い換えると,問題を再現するのに最低限必要なもののみに絞り込むということです.
MWE の作り方
ではどうすれば MWE を作ることができるのでしょうか? 基本的には,まず次のような文書を作成します.
\documentclass{article}
\begin{document}
Text
\end{document}
そして,困っている問題が発生するまで一行ずつコードを追加していきます.もちろん実際に作成しているファイルから「切り落とす」ことで MWE を作成することもできますが,手順が長くなるかもしれません.
改ページやその他の影響を与えるために,より長いテキストが必要になる場合もあります.そのような場合は lipsum
パッケージ(日本語のテキストが必要な場合は bxjalipsum
パッケージ)を使用すると,無意味な段落を生成することができるのでテストファイルを簡潔に保つのに役立つでしょう.
ログファイル
またログファイルを見ることも重要です.これは LaTeX を実行する度に作成されるもので,作成している文書ソースのファイル名と同一の名前で拡張子 .log
を持っています.
デスクトップ環境によっては「拡張子を表示する」のようなオプションを使用しないとどのファイルかわからないかもしれません.
ログファイルの中には,常にフルのエラーメッセージが書かれています.LaTeX のエラーメッセージはなるべくわかりやすくなるようにと努力がなされていますが,一般のワープロのようにはいきません.
エディタによってはエラーの「フル」テキストの閲覧を難しくするものもあります.そのような場合,重要な情報が隠されてしまっている可能性があります.
何か問題が発生した場合,経験豊富な LaTeX ユーザはしばしばログファイルを添付して欲しいとお願いをします.
さらに学ぶ
これで本チュートリアルのメインレッスンは終わりです.付録レッスンではメインレッスンでは扱わなかったテーマやパッケージに関する小さなコード例をいくつか紹介しているので,興味のある方は確認してみてください.