脚注・傍注・コードの組版

脚注は本文を中断せず補足を加え、傍注は短い注意に使います。コードは長さに応じて等幅文字・そのまま表示する環境・ハイライト付きブロックを選びます。いずれも使いすぎないようにします。

EasyLaTeX のコンパイラー設定：LuaLaTeX + ltjsarticle。傍注には marginnote、コードには listings を使います。listings は日本語コメントの扱いに制約があるため、日本語を含む場合は verbatim など、和文に対応した方法を選びます。

脚注を付ける#

補足したい箇所で \footnote{...} を使います。

この用語は業界で一般的な定義を使います\footnote{規格によって表現が多少異なります。}。

番号とページ下部への配置は自動です。出典・例外・短い説明に使い、新しい長い議論は本文に置きます。

脚注の印と本文を分ける#

表や見出しなど、普通の脚注を直接使えない場所では印と本文を分けます。

表のキャプション\footnotemark
...
\footnotetext{数値は四捨五入しています。}

同じページの近い位置に置き、出現順に対応させます。複雑な表の注記はテンプレートや表専用の方法を使います。

傍注を付ける#

LaTeX 標準の \marginpar に加え、現在位置の短い注には \marginnote が使えます。

\usepackage{marginnote}

この結論は再確認が必要です。\marginnote{出典を追加}

余白を使うため、両面文書では左右の配置にも注意します。長い注は柱・脚注・他の傍注と重なるので、短いキーワードに留めます。

行内コード#

短いコマンド・ファイル名・変数には \texttt を使います。

主ファイルの名前は通常 \texttt{main.tex}。

区切り文字を含まない内容をそのまま表示するには \verb|...| を使えます。

\verb|\section{見出し}|

\verb は節見出し・キャプション・通常の脚注などのコマンド引数では使えません。その場合は特殊文字を処理した \texttt や専用のコマンドを使ってください。

コードブロック#

少量のそのまま表示する文字列には verbatim を使います。

\begin{verbatim}
main.tex
figures/result.pdf
\end{verbatim}

番号・折り返し・構文ハイライトには listings を使います。

\usepackage{listings}
\usepackage{xcolor}
\lstset{
  basicstyle=\ttfamily\small,
  frame=single,
  breaklines=true
}

\begin{lstlisting}[language=Python]
total = sum(values)
print(total)
\end{lstlisting}

インデントを保ち、入力・出力・役割を本文で説明します。説明のない断片だけを置かないでください。

よくある問題#

脚注が次のページに移動する#

ページ下部の空きが足りないと起こります。短くする、本文の構造を変える、関連する文を次のページに送るなどで調整し、大きな負の空きで引き戻さないでください。

傍注が重なる#

注を短くし、同じページの数を減らすか脚注に変えます。密集した注や重要な本文情報には向きません。

listings の日本語が文字化けする#

Unicode の扱いに制約があります。対応範囲の欧文コードに使い、日本語を含む場合は LuaLaTeX と verbatim、またはテンプレートで設定済みの和文対応ハイライト環境を使います。

完全な例#

\documentclass[a4paper,12pt]{ltjsarticle}
\usepackage{marginnote}
\usepackage{listings}
\usepackage{xcolor}
\lstset{basicstyle=\ttfamily\small, frame=single, breaklines=true}

\begin{document}

使用するのは \texttt{main.tex} を主ファイルとして使います\footnote{プロジェクト唯一のコンパイル入口です。}。
\marginnote{コンパイル前にエンジンを確認}

\begin{lstlisting}[language=Python]
total = sum(values)
print(total)
\end{lstlisting}

\end{document}