# jlreq

## これは何？
[日本語組版処理の要件](https://www.w3.org/TR/jlreq/?lang=ja)の実装を試みる[LuaTeX-ja](https://osdn.jp/projects/luatex-ja/wiki/FrontPage) / pLaTeX / upLaTeX用のクラスファイルと，それに必要なJFMの組み合わせです．

## 提供されるもの
クラスファイルjlreq.clsと，横書きLuaTeX-ja用のJFMであるjfm-jlreq.luaが用意されています．また，縦書きのJFMやpLaTeX / upLaTeX用のJFMを生成するいくつかのスクリプトがあります．

## インストール
`make`で必要なJFMを生成してください．その後，

* *.tfm -> $TEXMF/fonts/tfm/public/jlreq
* *.vf -> $TEXMF/fonts/vf/public/jlreq
* jfm-jlreq.lua, jfm-jlreqv.lua, jfm-jlreq-jidori.lua jfm-jlreqv-jidori.lua -> $TEXMF/tex/luatex/jlreq
* jlreq.cls, jlreq-helpers.sty  -> $TEXMF/tex/latex/jlreq

と配置します．`make install`とすると，$TEXMF=$TEXMFHOMEとしてこのコピーを行います．

## 動作環境
pLaTeX / upLaTeX / LuaLaTeX上で動きます．以下のパッケージを内部で読み込みます．

* （常時）：lmodern
* （LuaLaTeX非利用時）：everyhook
* （LuaLaTeX利用時）：luatexja,luatexja-adjust

リリース時点での最新版での動作を確認しています．


## 使い方
通常通り
```latex
\documentclass{jlreq}
```
とします．これで横書きのarticle相当の文書クラスとなります．エンジンは自動判定されますが，指定する場合はクラスオプションに`platex/uplatex/lualatex`のいずれかを渡してください．縦書きにするには`tate`オプションを渡します．また，reportやbook相当の文書クラスとするには，それぞれ`report`や`book`オプションを渡します．たとえば，縦書きの本を作成するには
```latex
\documentclass[tate,book]{jlreq}
```
とします．

その他，`oneside` / `twoside` / `onecolumn` / `twocolumn` / `titlepage` / `notitlepage` / `draft` / `final` / `landscape` / `openright` / `openany` / `leqno` / `fleqn`というよくあるオプションを受け付けます．また`disablejfam`オプションを渡すと，和文フォントを数式用に登録しません．

標準的な文書クラスと同じように中身を書くことができますが，次のような命令が追加 / 拡張されています．なお，本ドキュメントでは[日本語組版処理の要件](https://www.w3.org/TR/jlreq/?lang=ja)における用語を断りなく使います．

### `\jlreqsetup`
設定用命令です．プリアンブルでしか使えません．文書に対する設定は，クラスオプションとして行うか`\jlreqsetup`を通じて行うかします．どちらで設定するかは設定項目によります．

### `\section`
`\section*[running head]{見出し文字列}[副題]`というように，通常の書式に加えて副題を受け付けられるように拡張されています．その他，`\part`（articleのみ），`\chapter`（book/reportのみ），`\subsection`，`\subsubsection`も副題を受け付けます．

### `abstract`環境
プリアンブルにもかけ，そのときは`\maketitle`とともに出力されます．二段組の場合は，段組にならず概要を出力することができます．ただし今では非推奨の方法です．`\jlreqsetup`で`abstract_with_maketitle=true`を指定して`\maketitle`よりも前に書くことで同様のことができます．

### `\sidenote`
この命令は傍注の幅が正の時にのみ定義されます．デフォルトの基本版面ではこの幅は0に設定されています．従って`\sidenote`は定義されません．後の基本版面の設定を参考にしてください．

`\sidenote`は傍注（縦組みの場合は脚注）を出力します．内部では`\marginpar`を使っています．デフォルトでは`\footnote`と同様の書式となりますが，`\jlreqsetup`で`sidenote_type=symbol`が指定されている場合，その書式は`\sidenote{該当項目}{注}`となります．たとえば
```latex
刊行できる\sidenote{原稿}{印刷などの方法により……}を入手する仕事である．
```
とします．後の説明も参照してください．


### `\endnote`
後注を指定します．`\footnote`と同様の書式です．デフォルトでは，注自身の出力は見出し直前に行われます．この動作は`\jlreqsetup`に`endnote_position`を渡すことで制御できます．詳しくは後の注関係の説明をご覧ください．また`\theendnotes`を実行するとその場に出力をします．

### `\warichu`
割注を出力します．行分割位置などは自動で計算されます．（複数回のコンパイルが必要．）`\warichu*`ではこれらの位置を手動で指定できます．書式は
```
\warichu*{(一行目前) & (一行目後)\\ (二行目前) & (二行目後)...}
```
です．`&`が省略されている場合は自動で調整されます．

### `\tatechuyoko`
縦中横を出力します．`\tatechuyoko{<中身>}`とします．`\tatechuyoko`は縦書きでない場所で使うとエラーになりますが，`\tatechuyoko*`は縦書きでない場所ではそのまま出力されます．

### `\jidori`
`\jidori{<寸法>}{<中身>}`により，中身を寸法の長さに字取りしたものを出力することができます．

### `\akigumi`
`\akigumi{<寸法>}{<中身>}`により，中身の文字間を寸法の長さとして空き組した結果を出力することができます．ただしLuaLaTeX利用時以外は正しい出力結果とはなりません．

### `\jafontsize`
和文フォントサイズを指定する`\fontsize`です．クラスオプションで`jafontscale=0.9`とされている場合，`\fontsize{9pt}{15pt}`とすると和文フォントのサイズは`8.1pt`となりますが，`\jafontsize{9pt}{15pt}`とすると`9pt`となります．（欧文フォントサイズは`10pt`となる．）なお，第二引数は`\fontsize`の第二引数と全く同じです．

### `\　`
全角空白（U+3000）一文字からなるマクロです．和字間隔を挿入します．LuaLaTeXでは`　`のみでも和字間隔を入力できます．

### その他
* ルビや圏点は提供されません．[PXrubrica](https://github.com/zr-tex8r/PXrubrica)または`luatexja-ruby`（LuaLaTeX，LuaTeX-jaパッケージに付属）を使うと良いかと思います．
* pLaTeX / upLaTeX利用時はそれぞれ`zw`および`zh`に展開されるマクロ`\zw`と`\zh`が定義されます．LuaLaTeX利用時はLuaTeX-ja内で同名のマクロが定義されます．
* 日本語組版処理の要件2.3.2.dによれば，横組みにおける二段組の最後のページの各段の行数は揃えることが望ましいとされていますが，この処理は行われません．`nidanfloat`パッケージを使い，

    ```latex
    \usepackage[balance]{nidanfloat}
    ```

    とするとこの処理が行われます．ただし，最終ページでの`\newpage`や`\clearpage`が正しく動作しません．詳しくは`nidanfloat`パッケージのマニュアルをご覧ください．
* フォントを設定する機能は有していません．和文フォントは，LuaLaTeX利用時は`luatexja-fontspec`や`luatexja-preset`（いずれもLuaTeX-jaパッケージに付属）により設定することができます．dvipdfmxを使う場合は，[PXchfon](https://github.com/zr-tex8r/PXchfon)での設定が可能です．
* 和文間の空白（(u)pTeXでは`\kanjiskip`に，LuateX-jaでは`kanjiskip`パラメータに格納されているもの）は，デフォルトでは1/4文字分までの空きを許容した設定になっています．これは日本語組版処理の要件に従ったものですが，TeXでの機能の制限などもあり，場合によってはあまり適切ではない結果を生じることがあります．この値を変更する場合は，`\jlreqkanjiskip`を再定義してください．例えば，

    ```latex
    \documentclass{jlreq}
    \renewcommand{\jlreqkanjiskip}{0pt plus .1\zw minus .01\zw}
    \begin{document}
    （本文）
    \begin{document}
    ```

    のようにします．和文と欧文の間の空白（(u)pTeXでは`\xkanjiskip`に，LuateX-jaでは`xkanjiskip`パラメータに格納されているもの）も同様に`\jlreqxkanjiskip`を再定義することで変更することができます．
* `book`指定時に，クラスオプションとして`openany`を指定していても，`\mainmatter`の後に白ページが挿入されることがあります．これは標準のクラスファイルと挙動を合わせたものです．`\jlreqsetup{mainmatter_pagebreak=clearpage}`とすることで白ページが入らなくなりますが，デフォルトでは`\mainmatter`でページ数をリセットしますので，ページ数の偶奇の整合性がとれなくなる可能性があります．`\jlreqsetup{frontmatter_pagination={arabic,continuous}}`のようにして通しノンブルに変更することを検討してみてください．詳しくは下記の「前付きなど」を参照してください．


## 各種設計
設計はクラスオプションまたは`\jlreqsetup`によりkeyval形式で行います．ただし，クラスオプションではLaTeXの実装により，本来可能な入力が受け付けられないケースがあります．多くの場合は空白を除くことにより解決します．

以下では次の用法を使います．

* `[A/B]`：AまたはBです．`[A/B/C]`等も同様．
* `<寸法>`：TeXが認識する寸法です．簡単な式（`10pt+10pt`のような）を使うこともできます．また，クラスオプションでは，場合によっては次のような特殊な値を使うこともできます．（これらはpLaTeX / upLaTeXではもとから利用可能ですが，LuaLaTeXでも利用可能なように処理されています．）`\jlreqsetup`内のような場所では，常に`\zw`や`\zh`により全角幅が記述できます．以下，たとえば`Q`，`H`が利用可能な場合は`<寸法;Q,H>`のように記述します．
    - `Q`，`H`：0.25mmと解釈されます．
    - `zw`, `zh`：全角幅として解釈されます．
* `<コード>`：LaTeXのコードです．
* `<フォント設定コード>`：`\Large`や`\bfseries`のようなフォント設定の命令です．`\Large\bfseries`のように複数指定することもできます．
* `<カウンタ名>`: LaTeXのカウンタの名前です．


### 基本版面
クラスオプションです．

* `paper=[<紙サイズ名>/{<寸法>,<寸法>}]`：紙サイズです．紙サイズ名は`a0paper`から`a10paper`，`b0paper`から`b10paper`，`c2paper`から`c8paper`を指定できます．B列はISO B列です．JIS B列を指定する場合は，`b0j`から`b10j`の対応するものを指定してください．また，`letterpaper`，`legalpaper`，`executivepaper`が指定できます．さらに，`{<横>,<縦>}`と直接寸法を指定することもできます．
* `fontsize=<寸法;Q,H>`：欧文フォントサイズ．デフォルトは10pt．
* `jafontsize=<寸法;Q,H>`：和文フォントサイズ．
* `jafontscale=<実数値>`：欧文フォントと和文フォントの比（和文 / 欧文）．`fontsize`と`jafontsize`が両方指定されている場合は無視される．デフォルトは1．
* `line_length=<寸法;zw,zh>`：一行の長さ．デフォルトは字送り方向の紙幅の0.75倍．実際の値は一文字の長さの整数倍になるように補正されます．
* `number_of_lines=<自然数値>`：一ページの行数．デフォルトは行送り方向の紙幅の0.75倍になるような値．
* `gutter=<寸法;zw,zh>`：のどの余白の大きさ．
    - `tate`無指定時は奇数ページ左，偶数ページ右の余白
    - `tate`指定時は奇数ページ右，偶数ページ左の余白
    - `twoside`が指定されていない時は，常に奇数ページ扱いで余白が設定される
* `fore-edge=<寸法;zw,zh>`：小口（のどでない方）の余白の大きさ．「日本語組版処理の要件」にある方法で余白を指定する限り使われることはありませんが，便利なこともあるので実装されています．
* `head_space=<寸法;zw,zh>`：天の空き量．デフォルトは中央寄せになるような値．
* `foot_space=<寸法;zw,zh>`：地の空き量．デフォルトは中央寄せになるような値．
* `baselineskip=<寸法;Q,H,zw,zh>`：行送り．デフォルトは`jafontsize`の1.7倍．
* `linegap=<寸法;Q,H,zw,zh>`：行間．
* `headfoot_sidemargin=<寸法;zw,zh>`：柱やノンブルの左右の空き．
* `column_gap=<寸法;zw,zh>`：段間（`twocolumn`指定時のみ）．
* `sidenote_length=<寸法;zw,zh>`：傍注の幅を指定します．

### 組み方
クラスオプションです．
* `open_bracket_pos=[zenkaku_tentsuki/zenkakunibu_nibu/nibu_tentsuki]`：始め括弧が行頭に来た際の配置方法を指定します．それぞれ段落開始全角折り返し行頭天付き（デフォルト），段落開始全角二分折り返し行頭二分，段落開始二分折り返し行頭天付きを意味します．
* `hanging_punctuation`：ぶら下げ組をします．

### 逆ノンブル
クラスオプションです．
* `use_reverse_pagination`：逆ノンブルの機能を利用可能にします．`jlreqreversepage`という「読み取り専用のカウンタ」が定義されます．（本物のカウンタではありません．）`\arabic`などの命令や`\value`が適用可能です．また`\thejlreqreversepage`が`\arabic{jlreqreversepage}`として定義されます．

### 注関係
`\jlreqsetup`で指定します．

* `reference_mark=[inline/interlinear]`：合印の配置方法を指定します．`inline`にすると該当項目の後ろの行中に配置します．`interlinear`を指定すると該当項目の上（横組）または右（縦組）に配置します．
* `footnote_second_indent=<寸法>`: 脚注（横書き時）または傍注（縦書き時）の二行目以降の字下げ量を指定します．一行目からの相対字下げ量です．
* `sidenote_type=[number/symbol]`：傍注と本文との対応の方法を指定します．`number`が規定で，注の位置に通し番号が入り，それにより対応が示されます．`symbol`とすると，注の位置に特定の記号が入り，また注がついている単語が強調されます．
* `sidenote_symbol=<コード>`：`sidenote_symbol=symbol`の時に，注の位置に入る記号．デフォルト＊
* `sidenote_keyword_font=<フォント設定コード>`：`sidenote_symbol=symbol`の時に，注のついている単語のフォント指定．デフォルトは無し（強調しない）
* `endnote_counter=<カウンタ名>`: 後注に使うカウンタ名です．デフォルトは`endnote_counter=footnote`．
* `endnote_second_indent=<寸法>`: 後柱の二行目以降の字下げ量を指定します．一行目からの相対字下げ量です．
* `endnote_position=[headings/paragraph/{_<見出し名1>,_<見出し名2>,...}]`：後注の出力場所を指定します．`headings`は各見出しの直前（デフォルト），`paragraph`は改段落の際に出力します．また，`endnote_position={_chapter,_section}`とすると，`\chapter`と`\section`の直前に出力します．`<_見出し名>`を指定するためには，対象の見出しが本クラスファイルの機能を使って作られていなければいけません．
* `warichu_opening=<コード>`, `warichu_closing=<コード>`：それぞれ，割注の前と後ろに挿入されます．デフォルトは`（`と`）`です．

### キャプション
図表のキャプションを`\jlreqsetup`で変更できます．全ての設定で，各環境ごとの設定をすることができます．例えば`caption_font=\normalsize,table=\Large`とすると，table環境内では`\Large`が適用され，そのほかの環境内では`\normalsize`が適用されます．他の設定も同様です．
* `caption_font=<フォント設定コード>`：キャプション自身のフォントを指定します．
* `caption_label_font=<フォント設定コード>`：キャプションのラベルのフォントを指定します．
* `caption_after_label_space=<寸法>`：ラベルとキャプションの間の空きを指定します．
* `caption_label_format=<コード>`：ラベルの書式を指定します．`caption_label_format={#1：}`のようにします．`#1`が「図1」のような番号に置換されます．
* `caption_align=[left/right/center/bottom/top]`：キャプションの場所を指定します．{center,*left}のようにすると，通常は中央配置だがキャプションが大きいときには左に配置されます．

### 引用
`quote / quotation / verse`環境の挙動を`\jlreqsetup`で指定できます．
* `quote_indent=<寸法>`：字下げを指定します．デフォルトは2\zwです．一行の長さが文字サイズの整数倍になるように調整されます．
* `quote_end_indent=<寸法>`：字上げを指定します．デフォルトは0\zwです．
* `quote_beforeafter_space=<寸法>`：前後の空きを指定します．`quote_beforeafter_space=1\baselineskip`とすると一行あきます．
* `quote_fontsize=[normalsize/small/footnotesize/scriptsize/tiny]`：フォントサイズを指定します．

### 箇条書き
`\jlreqsetup`で指定します．
* `itemization_beforeafter_space=<寸法>`：箇条書きの前後の空きを指定します．`itemization_beforeafter_space={i=<寸法>}`とするとトップレベルのみに設定を行います．`itemization_beforeafter_space={0pt,i=10pt,ii=5pt}`とすれば，レベル1の箇条書きに10ptを，レベル2のそれに5ptを，それ以外には0ptを設定します．レベルは上記のように小文字ローマ数字で指定します．
* `itemization_itemsep=<寸法>`：項目同士の空きを指定します．

### 前付きなど
`\frontmatter` / `\mainmatter` / `\backmatter` / `\appendix`での処理を`\jlreqsetup`で指定できます．
* `frontmatter_pagebreak=[cleardoublepage/clearpage/]`：`\frontmatter`実行時の改ページを実行する命令名を指定します．空にすると何もしません．
* `frontmatter_counter={<カウンタ名>={value=<値>, the=<コード>, restore=[true/false]},...}`：`\frontmatter`時でのカウンタの操作を指定します．例えば`chapter={value=0,the={[\arabic{chapter]}}`とすると，`chapter`カウンタの値が`0`になり，`\thechapter`が`[\arabic{chapter}]`となります．デフォルトでは`\mainmatter`時に値と`\the<カウンタ名>`の定義を戻しますが，`restore=false`とするとこの動きが抑制されます．
* `frontmatter_heading={<見出し命令名>={<設定>},...}`：見出し命令の動きを変更します．`\Delare***Heading`で指定できる項目の他以下を受け付けます．
    - `heading_type=[Tobira/Block/Runin/Cutin/Modify]`：見出しの種類です．`Modify`が指定された場合は`\ModifyHeading`での変更となります．
    - `heading_level=<数値>`：見出し命令のレベルを設定します．指定されなかった場合は，`\frontmatter`実行時の値が使われます．`heading_type=Modify`の時は無視されます．
    - `restore=[true/false]`：`true`が指定されると，`\mainmatter`で元の定義を復帰します．デフォルトは`true`です．
* `frontmatter_pagestyle={<ページスタイル名>[,restore=[true/false]]}`：`\frontmatter`実行時にここで指定されたページスタイルへと切り替えます．デフォルトでは`\mainmatter`時にもとのページスタイルに戻しますが，`restore=false`を指定すると戻しません．
* `frontmatter_pagination={<ページ番号指定>[,continuous,independent]}`：ページ番号の出力形式を，`frontmatter_pagination=roman`のようにLaTeXの命令名で指定します．更に`continuous`が指定されると通しノンブルとなります．`independent`で別ノンブルです．
* `frontmatter_precode=<コード>`：`\frontmatter`時に最初に実行されるコードです．
* `frontmatter_postcode=<コード>`：`\frontmatter`時に最後に実行されるコードです．

`frontmatter`を`mainmatter`や`backmatter`，`appendix`へと変えた設定も存在します．ただし，以下のような違いがあります．
* `restore=[true/false]`は無効な設定です．
* `mainmatter_pagination`に`continuous`と`independent`は指定できません．
* `appendix_pagebreak`，`appendix_pagestyle`，`appendix_pagination`はありません．

クラスオプションに`book`をしているときには，デフォルトでは`frontmatter_heading`に`chapter={number=false, restore = true}`および`backmatter_heading = {chapter = {number = false}}`を指定しています．したがって，`\chapter`を窓見出しに変更している場合はエラーが発生しますので，必要に応じて設定をし直してください．

### 概要
* `abstract_with_maketitle=[true/false]`：abstract環境が`\maketitle`に先行して書かれた場合，その中身を`\maketitle`とともに遅延します．二段組みの場合でも一段で出力されます．デフォルトは`false`です．`article`および`report`時のみ．

## 見出し
新しい見出しを`\New***Heading`という命令で作ることができます（***には見出しの種類に応じた文字列が入る）．書式はすべて

```
\New***Heading{<命令名>}{<レベル>}{<設定>}
```

となっています．また，`\Renew***Heading`，`\Provide***Heading`，`\Declare***Heading`も同時に用意されます．それぞれ

* `\Renew***Heading`：指定した名前の命令が定義されていなければエラー．
* `\Provide***Heading`：指定した名前の命令が定義されていない場合に限り見出し命令の定義が行われる．
* `\Declare***Heading`：指定した名前の命令が定義されているか否かによらず新しく見出し命令を定義する．

となっています．

### 扉見出し
`\NewTobiraHeading`で作成します．通常のクラスファイルにおける`\section`等と同じ書式の命令ができます．設定は以下の通り．

* `type=[han/naka]`：`han`だと半扉見出しを，`naka`だと中扉見出しを作ります．
* `pagestyle=<ページスタイル名>`：見出し箇所のページスタイルを指定します．
* `label_format=<コード>`：ラベルを出力する命令を指定します．たとえば`label_format={第\thechapter 章}`のように指定します．
* `format=<コード>`：実際に出力する書式を指定します．`format={\null\vfil {\Huge\bfseries #1#2}}`のようにします．`#1`はラベルに，`#2`は見出し文字列に置き換えられます．この中では`\jlreqHeadingLabel`，`\jlreqHeadingText`という命令が利用可能です．いずれも引数を一つとる命令で，それぞれラベル，見出し文字列が空ならば空に，そうでなければ与えられた引数自身を出力します．例えば`format={[\jlreqHeadingLabel{Label=#1}]}`と指定されていれば，ラベルが空でない時には`[Label=<ラベル>]`を，そうでなければ`[]`を出力します．
* `number=[true/false]`：採番を行うかを指定します．ただし，`number=false`の場合でも対応するカウンタは定義されます．また`\the<カウンタ名>`の変更もされないので，必要ならば再定義が必要になります．

### 別行見出し
`\NewBlockHeading`で作成します．`\<命令名>*[running head]{見出し文字列}[副題]`という書式の命令を作成します．設定は以下の通り．

#### 書式関連
* `font=<フォント設定コード>`：見出しのフォントを指定します．
* `subtitle_font=<フォント設定コード>`：副題のフォントを指定します．
* `label_format=<コード>`：ラベルのフォーマットを指定します．`label_format={第\thechapter 章}`などのようにします．
* `subtitle_format=<コード>`：副題のフォーマットを指定します．`subtitle_format={「#1」}`のようにします．`#1`は副題自身に置き換えられます．
* `format=<コード>`：見出し全体のフォーマットを指定します．`#1`がラベル，`#2`が見出し文字列，`#3`が副題に置き換えられます．内部では`\jlreqHeadingLabel`，`\jlreqHeadingText`，`\jlreqHeadingSubtitle`という命令が利用可能です．いずれも引数を一つとる命令で，それぞれラベル，見出し文字列，副題が空ならば空に，そうでなければ与えられた引数自身を出力します．例えば`format={[\jlreqHeadingLabel{Label=#1}]}`と指定されていれば，ラベルが空でない時には`[Label=<ラベル>]`を，そうでなければ`[]`を出力します．なお，実際に`#1`が置き換えられるのはラベル自身ではなく，それに空きの調整などが入ったコードです．従って，予期しない結果を得ることもあり得ます．`#2`，`#3`も同様です．

#### インデント関連
* `align=[left/center/right]`：見出し位置の横方向の配置場所を指定します．
* `indent=<寸法>`：見出し全体の字下げ量を指定します．
* `end_indent=<寸法>`：見出し全体の字上げ量を指定します．
* `after_label_space=<寸法>`：ラベル後，見出し文字列までの空きを指定します．
* `second_heading_text_indent=[<寸法>/{<寸法>,<寸法>}]`：見出し文字列の二行目以降のインデントを指定します．見出し文字列一行目の頭を起点として指定しますが，`second_heading_text_indent=*1\zw`のように先頭に`*`をつけるとラベルの頭を起点としての指定になります．また，`second_heading_text_indent={<ラベルがある時>,<ラベルがない時>}`という指定をすると，ラベルの有無に応じて値を変更することができます．`<ラベルがある時>`の指定ではやはり`*`を使うことができます．
* `subtitle_indent=<寸法>`：副題のインデント量を指定します．見出し文字列の一行目を起点として指定します．ただし，`subtitle_indent=*1\zw`のように先頭に`*`をつけるとラベルの頭を起点としての指定になります．`subtitle_break=true`の時のみ有効です．

#### その他
* `subtitle_break=[true/false]`：見出し文字列と副題の間を改行するか指定します．
* `allowbreak_if_evenpage=[true/false]`：見出しが偶数ページにあった場合，その直後の改ページを許可します．
* `pagebreak=[clearpage/cleardoublepage/clearcolumn/nariyuki/begin_with_odd_page/begin_with_even_page]`：見出し直前の改ページを指定します．それぞれ，改ページ，`\cleardoublepage`実行，改段，なりゆき，奇数ページ開始，偶数ページ開始，です．
* `pagestyle=<ページスタイル名>`：見出し箇所のページスタイルを指定します．
* `afterindent=[true/false]`：見出し直後の段落の字下げを行うかを指定します．
* `column_spanning=[true/false]`： 段抜きの見出しにします．`pagebreak=nariyuki`または`pagebreak=clearcolumn`の時には無視されます．
* `number=[true/false]`：採番を行うかを指定します．`\NewTobiraHeading`と同様の注意が必要です．

#### 行取り
行取りの指定は以下のいずれかの方法で行うことができます．

* 行数を指定し，その中央に配置します．`lines=<自然数値>`により行数を指定します．`before_lines=<自然数値>`や`after_lines=<自然数値>`により，さらに前後に追加する行数を指定します．たとえば`lines=3,after_lines=1`とすれば，四行の中に配置され，前の空きよりも後ろの空きの方が一行分大きくなります．`before_lines`により指定された空きはページ頭には入りませんが，`before_lines=*1`というように`*`を先頭につけると常に入るようになります．
* 行数と，前後いずれかの空きを指定します．`lines=<自然数値>`により行数を，`before_space=<寸法>`または`after_space=<寸法>`のいずれかの指定によりそれぞれ前または後ろの空きを指定します．
* 前後の空きを指定します．`before_space=<寸法>`および`after_space=<寸法>`を指定します．

#### 連続して掲げる見出しの行取り
``\SetBlockHeadingSpaces``により，見出しが連続して掲げられたときの行取りを設定することができます．``\SetBlockHeadingSpaces``は

```latex
\SetBlockHeadingSpaces{
  {_part{lines=3,before_lines=1},_section{lines=2},_subsection{lines=2}}
  [lines=5]{_section,23pt,_subsection,16pt}
}
```

のように使います．この意味は次の通りです．

* `\part`，`\section`，`\subsection`という順番で見出しが掲げられていて，その前後が見出しでない場合は，`\part`は三行取り＋前に一行空き，`\section`と`\subsection`は二行取りとなります．
* `\section`，`\subsection`という順番で見出しが掲げられていて，その前後が見出しでない場合は，全体で五行取りとし，`\section`と`\subsection`との間に`23pt`の空き，`\subsection`の後に`16pt`の空きを入れます．

個々の設定は以下のようになります．

* 各々の``{}``内には``_<見出し命令名>``か``<寸法>``をカンマ区切りで並べます．
* 先頭に``[]``で囲まれた設定を追加できます．これは連続して掲げられた見出し全体への設定となります．``lines / before_lines / after_lines / before_space / after_space``が利用可能です．各々の意味は上述の行取り指定と同じです．
* 寸法はそのまま空き量を表します．
* ``_<見出し命令名>``の後に``{}``で囲まれた設定を追加することで，その見出しの空き量を設定します．設定しない場合は前後に空きが入りません．
* 見出しに対する``{}``で囲まれた設定内では，``lines / before_lines / after_lines / before_space / after_space``が利用可能です．各々の意味は上述の行取り指定と同じです．
* ``{}``で囲まれた部分を``*``のみにすると（例えば``_section{*}``とすると）単独で掲げた場合と同じ設定を使います．

なお，見出しが連続しているかは単純に別行見出しの命令が並んで書かれているかのみで判断します．従ってそれらの命令間に出力には関係しないような命令が挟まっていたとしても，見出しが連続して掲げられているとは判断されません．ただし，見出し命令の間に空白，改行または`\label[<オプション>]{<引数>}…{<引数>}`という形のもののみが挟まれている場合は，見出しが連続していると判断されます．

### 同行見出し
`\NewRuninHeading`で作成します．通常の文書クラスにおける`\section`と同様の，`\<命令名>*[running head]{見出し文字列}`という書式の命令が作成されます．設定は以下の通り．

* `font=<フォント設定コード>`：見出しのフォントを指定します．
* `indent=<寸法>` 見出し文字列全体の字下げ量を指定します．
* `after_label_space=<寸法>`：ラベル後，見出し文字列までの空きを指定します．
* `label_format=<コード>`：ラベルのフォーマットを指定します．`label_format={\theparagraph}`などのようにします．
* `after_space=<寸法>`：見出しと本文との間の空きを指定します．
* `number=[true/false]`：採番を行うかを指定します．`\NewTobiraHeading`と同様の注意が必要です．

### 窓見出し
`\NewCutinHeading`で作成します．`\<命令名>{見出し文字列}`という書式の命令を作成します．設定は以下の通り．

* `font=<フォント設定コード>`：見出しのフォントを指定します．
* `indent=<寸法>`：見出し全体の字下げ量を指定します．
* `after_space=<寸法>`：見出しと本文との間の空きを指定します．
* `onelinemax=<寸法>`, `twolinemax=<寸法>`：見出し文字列の長さが`onelinemax`以下ならば一行で，`twolinemax`以下ならば二行で窓見出しを出力します．それ以上の場合は三行です．デフォルトはそれぞれ6文字，20文字の長さ．

### `\ModifyHeading`
既に（上のどれかを使い）定義された見出し命令の設定を変更します．たとえば
```latex
\ModifyHeading{section}{lines=10}
```
とすると，`\section`のフォントなどの設定はそのままに，行取りのみが10行に変更されます．見出しの種類を変更することはできません．

### `\SaveHeading`
見出し命令の定義を待避します．
```latex
\SaveHeading{section}{\restoresection} % \sectionの中身を\restoresectionに待避．
\RenewBlockHeading{section}{1}{font=……} % \sectionを新しく定義する．
……
\restoresection % \sectionの中身を元に戻す．
```
のように使います．

## ページスタイル
```
\NewPageStyle{<ページスタイル名>}{<設定>}
```
によりページスタイルを定義することができます．`<設定>`はkeyval形式です．定義したページスタイルは`\pagestyle`で適用できます．設定は以下の通り．

* `yoko`：横書きで上下に出力します．デフォルト．
* `tate`：縦書きで小口側に出力します．
* `running_head_font=<フォント設定命令>`：柱のフォントを指定します．
* `nombre_font=<フォント設定命令>`：ノンブルのフォントを指定します．
* `running_head_position`, `nombre_position`：柱とノンブルの位置を指定します．`yoko`か`tate`のどちらが指定されているかで指定方法が変わります．
    - `yoko`指定時：`top-left`のように指定できます．`top / bottom / center / left / right / gutter / fore-edge`が使えます．`gutter`はのど，`fore-edge`は小口です．`left`，`right`の指定は奇数ページに対するものです．`twoside`が指定されている場合，偶数ページはその逆になります．
    - `tate`指定時：`<寸法>`が指定できます．`running_head_position`は柱の天からの下げ量を，`nombre_position`はノンブルの地からの上げ量を指定します．
* `nombre=<書式>`：出力するノンブルを指定します．デフォルトは`\thepage`．
* `odd_running_head=<書式>`，`even_running_head=<書式>`：それぞれ奇数ページ，偶数ページの柱を指定します．`_section`のように`_`から始まる名前を指定すると，対応する見出しを出力します．（`_section`だと現在の`\section`を出力する．）
* `mark_format={[odd=<書式>/even=<書式>/_<見出し命令名>=<書式>],...}`：見出しを柱に出力する際のフォーマットを指定します．`mark_format={_section={節\thesection：#1},_chapter={第\thechapter 章\quad #1}}`のように指定します．見出し命令名の代わりに`odd`や`even`も指定でき，それぞれ奇数ページ/偶数ページの柱の書式になります．`\pagestyle`実行時に`\sectionmark`等を定義することで実現しています．
* `nombre_ii=<書式>`：二つ目のノンブルを指定します．`nombre_ii_position`で場所指定，`nombre_ii_font`でフォント設定もできます．指定方法は`nombre`や`nombre_position`と同じです．`odd_running_head_ii`，`even_running_head_ii`，`running_head_ii_position`，`running_head_ii_font`もあります．`nombre_ii_position`や`running_head_ii_position`が指定されなかった場合，`yoko`指定時にはそれぞれ`nombre_position`および`running_head_position`と同じ位置に設定されます．`tate`指定時は一つ目のノンブルや柱に続く場所に表示されます．
* `odd_head_format=<書式>`, `odd_foot_format=<書式>`, `even_head_format=<書式>`, `even_foot_format=<書式>`：ヘッダやフッタのフォーマットを指定します．`#1`がヘッダまたはフッタ全体に書き換えられます．ただし`#1`には位置調整用のコードが入っている場合もあるので，特に`\NewPageStyle`に`tate`を指定している場合には思うようにならないこともあります．例えば奇数ページのヘッダに罫線を引くためには`odd_head_format={\underline{\makebox[\jlreqyokoheadlength]{#1}}}`とするとよいでしょう．なお，ここで使った`\jlreqyokoheadlength`は本クラスファイル内で定義されているマクロで，ヘッダの横方向の長さを与えます．（フッタの長さも同じです．）縦方向の長さ，すなわち`\NewPageStyle`で`tate`が指定されている場合の長さは`\jlreqtateheadlength`で取得できます．


`\RenewPageStyle`，`\ProvidePageStyle`，`\DeclarePageStyle`もあります．`\ModifyPageStyle`により既存のページスタイルを改変することが可能です．

## JFM
以下のような独自のJFMを使います．パッケージによっては，パッケージ独自のJFMや，また標準のJFMを使うように設定がし直される場合があります．本クラスファイルで使用するJFMを使う場合には，パッケージオプションなどを適切に与えて設定をする必要があります．

### pLaTeX/upLaTeXの場合
JFMの名前は次の通りです．`[]`で囲まれている文字は設定により入ったり入らなかったりします．
```
[u][b][z]jlreq[g][-v]
```
それぞれの文字は以下の場合に入ります．

* `u`: upLaTeX利用時
* `b`: ぶら下げ組み利用時．（クラスオプションに`hanging_punctuation`が指定された時．）
* `z`: 行頭における開き括弧類の前の空きが，段落開始時が全角二分，折り返し時が二分の時．（クラスオプションに`open_bracket_pos=zenkakunibu_nibu`が指定された時．）
* `g`: ゴシック用フォント．
* `-v`: 縦書き用．

例えば，ぶら下げ組みを利用せず，クラスオプションに`open_bracket_pos=zenkakunibu_nibu`が指定されいてるソースをpLaTeXで処理した場合，横書き明朝体には`zjlreq`という名前のJFMが使われます．

### LuaLaTeXの場合
* 横書き用のJFMは`jlreq`
* 縦書き用のJFMは`jlreqv`

となります．ゴシックも同じJFMを使います．本クラスファイルは，LuaTeX-ja標準のJFMをこれらに変更します．


## その他
* クラスオプション`jlreq_notes`が渡されると，日本語組版処理の記述と矛盾する設定が行われた場合に通知がされます．

## jlreq-complements
`jlreq-complements`パッケージはLaTeXのドキュメントクラスで標準的に提供される環境などをカスタマイズ可能なものに変更するパッケージです．以下のように使います．次のオプションを受け付けます．
* `platex`, `uplatex`, `lulalatex`：エンジンの指定です．
* `setupname=<名前>`：カスタマイズするための命令名を指定します．デフォルトでは`jlreqcomplementssetup`で，`jlreqcomplementssetup{<設定項目>}`とプリアンブルに書くことで設定できます．

`jlreq`内では`\usepackage[<jlreq内で認識しているエンジン>,setupname=jlreqsetup]{jlreq-complements}`相当で読み込みがされていますので，今までの`\jlreqsetup`で環境のカスタマイズをすることができます．なお，このように既存の名前を指定してうまく行くためにはもともとの命令と整合的である必要があります．通常は避けた方がよいでしょう．

### `thebibliography`環境
* `thebibliography_heading=<コード>`：`thebibliography`環境の見出しを出力する命令を指定します．`thebibliography_heading={\section*{\refname}}`のように使います．
* `thebibliography_after_label_space=<寸法>`：`thebibliography`環境における各項目のラベル以降の空きを指定します．
* `thebibliography_indent=<寸法>`：`thebibliography`環境全体の字下げ量を指定します．
* `thebibliography_mark=<コード>`：`thebibliography`環境の見出しを柱に登録するためのコードを指定します．
* `thebibliography_precode=<コード>`，`thebibliography_postcode=<コード>`：それぞれ，`thebibliography`環境の前後に実行されるコードを指定します．

### `theindex`環境
* `theindex_heading=<コード>`：`theindex`環境の見出しを出力する命令を指定します．
* `theindex_mark=<コード>`：`theindex`環境の見出しを柱に登録するためのコードを指定します．
* `theindex_twocolumn=[true/false]`：`theindex`環境を二段組みで出力するかを指定します．
* `theindex_column_gap=<寸法>`：`theindex_twocolumn=true`の時の`theindex`環境内での段間を指定します．
* `theindex_column_rule_width=<寸法>`：`theindex_twocolumn=true`の時の`theindex`環境内での`\columnseprule`の値を指定します．
* `theindex_pagestyle=<ページスタイル名>`：`theindex`環境でのページスタイルを指定します．
* `theindex_postcode=<コード>`，`theindex_precode=<コード>`：それぞれ，`theindex`環境の前後に実行されるコードを指定します．

### 定理環境
* `theorem_beforeafter_space=<寸法>`：定理環境の前後の空きを指定します．
* `theorem_label_font=<フォント設定コード>`：定理環境のラベル部分のフォントを設定します．
* `theorem_font=<フォント設定コード>`：定理環境本体のフォントを設定します．
* `theorem_indent=<寸法>`：定理環境本体の字下げ量を指定します．
* `proof_label_font=<フォント設定コード>`：`amsthm`パッケージが読み込まれたときのみ有効な設定です．`proof`環境のラベルのフォントを指定します．

`amsthm`パッケージが読み込まれると，新しい定理スタイル`jlreq`が定義され，現在のスタイルが`jlreq`へと変更されます．このとき，上記設定はこの`jlreq`スタイルへの設定として機能します．

## ライセンス
このパッケージは二条項BSDライセンスの元で配布されています．詳しくは[LICENSE](LICENSE)をご覧ください．

## 履歴
* 2017-02-08
    - 最初のバージョン．
* 2017-02-17
    - いくつかバグを修正．
    - クラスオプション/`\jlreqsetup`にいくつかのキーを追加/変更．
    - `abstract`環境を実装．
    - パッケージを読み込んでいるだけのはやめた．
* 2017-03-14
    - いくつかバグを修正．
    - 和文ファミリを欧文ファミリに従属させるようにした．
    - `\DeclareBlockHeading`にオプションをたくさん追加．
    - quote環境などを調整するオプションを追加．
* 2017-03-20
    - バグ修正．
    - `\footnote / \sidenote / \endnote`の周りに必要ならば空白を挿入するようにした．
* 2017-04-04
    - バグ修正．
    - `\DeclarePageStyle`に`tate`と`font`オプションを追加．
* 2017-04-29
    - バグ修正
    - `jafontsize`と`jafontscale`をクラスオプションに，また`\jafontsize`を追加．
    - `\tatechuyoko`を追加．
    - クラスオプション`jlreq_warnings`を`jlreq_notes`に変更．
    - いくつかのクラスオプションを`\jlreqsetup`に移動．
    - いくつかのオプションを`\jlreqsetup`に追加．
    - クラスオプションの`paper={<縦>,<横>}`を`paper={<横>,<縦>}`に変更．
* 2017-06-11
    - `plext` / `lltjext`の読み込みを中止．
    - `\DeclareBlockHeading`に`align`を追加．`indent=center`や`end_indent=center`を廃止．
    - 一部の`\kcatcode` (upLaTeX時) を変更．
* 2017-08-13
    - `column_spanning`を`\DeclareBlockHeading`に追加．
    - ページレイアウトにおける「本文の長さ」に傍注の長さを入れるようにした．
    - 傍注の長さのデフォルトを0とした．
    - 傍注の長さが0の時には`\sidenote`を定義しないようにした．
    - 和字間隔を挿入する命令を追加．
* 2017-08-29
    - 縦書きでも著者名が横書きで出てしまうバグを修正．
* 2017-11-23
    - バグ修正
    - `\SetBlockHeadingSpaces`を追加．
    - `\contentsname` と `\indexname`に入っていたスペースを削除．
* 2017-12-02
    - バグ修正
* 2017-12-22
    - JFMを改善．
    - 別行見出しの間の`\label`の検出方法を変更．
    - `\theequation`，`\thefigure`，`\thetable`に章番号を追加．
* 2018-02-01
    - 縦書きの傍注は奇数ページにのみ出るようにした（改善の余地ありかも）．
    - LuaTeX時に`\fnfixbottomtrue`を追加．
    - キャプション関係のオプションを`\jlreqsetup`に追加．
    - `itemization_beforeafter_space`を拡張．
    - バグ修正．
* 2018-04-11
    - 縦書き二段組みの傍注を下段に出すようにした．
    - `begin_width_(odd|even)_page`を`\DeclareBlockHeading`に追加．
    - `\labelenumi`らをjarticleなどにあわせた．
    - `column_gap`クラスオプションを使うとコンパイルできなかったバグ修正．
    - `mark_format`を`\DeclarePageStyle`に追加．
* 2018-05-19
    - 目次内のラベルの長さを今までよりも長くした．
    - 一部のマクロをjlreq-helpers.styに分離した．
    - バグ修正．
* 2018-06-17
    - シリーズbもゴシックにするようにした．
    - バグ修正．
* 2018-08-08
    - `\DeclarePageStyle`に`nombre_ii`等を追加．
    - バグ修正．
    - `\jlreqsetup`に`footnote_second_indent`と`endnote_second_indent`を追加．
* 2018-08-15
    - バグ修正．
* 2018-09-01
    - `\mag`が`1000`でない場合も動くようにした（つもり）．
    - バグ修正．
* 2018-12-10
    - 見出し命令を作る命令に`number=[true/false]`を追加．
    - `\frontmatter`等の挙動を設定できるようにした．
    - `\jlreqHeadingLabel`等を扉見出しと別行見出しの`format`内で使えるようにした．
    - バグ修正
* 2019-01-15
    - `\NewPageStyle`に`nombre_font`などを追加．`font`もまだ有効だが以降非推奨とする．
    - `\NewBlockHeading`の`format`に`#1`が含まれてもエラーが起こらないようにした．
    - `\jlreqsetup`の`caption_label_format`などを拡張．
    - バグ修正．
* 2019-04-01
    - 逆ノンブルを利用可能にするクラスオプション`use_reverse_pagination`を追加．
    - `zref`パッケージの利用をやめた．
    - 新元号を追加．
    - バグ修正．
* 2019-05-07
    - わずかな誤差で行数が減ってしまうのを防ぐために，`\textwidth`と`\textheight`を少しだけ増やした．
    - `\DeclarePageStyle`内の`running_head_ii`などの実装を変更．
    - バグ修正
* 2019-09-24
    - `\@cite`と`\@biblabel`を再定義していたのをやめた．
    - 別行見出しの前に`\allowbreak`を追加．
    - バグ修正．
* 2020-02-07
    - `itemization_label_length`のデフォルト値を`\leftmargini`などにした．
    - `\rmfamily`などの再定義をやめ，`\@rmfamilyhook`などにコードを挿入することにした．
    - `\parskip`を`0pt`に変更．
    - バグ修正．
* 2020-05-01
    - `\jlreqsetup`に`theorem_label_font`と`theorem_font`を追加．
    - バグ修正．
* 2020-09-27
    - `\tatechuyoko`の`*`版を追加．
    - バグ修正
* 2020-12-29
    - クラスオプションの`fontsize`などで，LuaLaTeXでも`H`を使えるようにした．
    - `\jidori`を追加．
    - バグ修正．
* 2021-03-17
    - `\maketitle`でのページスタイルを`empty`でないときには`plain`にするようにした．
    - `\item`直後のJFMグルーをなくした．
    - 同行見出し直後のJFMグルーをなくした．
    - バグ修正．
* 2021-05-28
    - `\jlreqsetup`の`caption_align`を拡張．
    - `\ifthenelse`を少し削除．
* 2021-07-22
    - `\IfHookExistsTF`の利用を中止．
    - `\akigumi`を追加．
    - `xkeyval`パッケージと`ifthen`パッケージの利用をやめた．
    - expl3コードとの親和性を高めた．
    - `\DeclareBlockHeading`に`pagestyle`を追加．
    - バグ修正
* 2021-07-25
    - ifthenの読み込みを復活．（Re:VIEWのための一時的なもの．）
    - バグ修正
* 2021-07-30
    - バグ修正
* 2021-08-12
    - `etoolbox`への直接の依存をなくした．
    - バグ修正
* 2021-10-09
    - バグ修正
* 2021-11-05
    - `paper=b*`をISO系列とした．
    - LaTeXのフック関連コードの多くを削除．（まだ安定していなそうなので．）
    - `\RequirePackage{ifthen}`をやめた．
    - upLaTeXにおける`\kcatcode`の再設定をやめた．
* 2022-04-05
    - `\jlreqsetup`に`warichu_opening`と`warichu_closing`を追加．
    - 別行見出し周りのペナルティを少し調整．
    - `\DeclareFontShape`後の`\selectfont`でエラーが出るバグ修正．
    - `use_reverse_pagination`がうまく動いていなかったのを修正．
    - 二番目の柱を使うと不自然に消えることがあるバグの修正．ついでに`\DeclarePageStyle`を書き直した．
    - `\@makefntext`を調整．
    - その他バグ修正．
* 2022-04-11
    - バグ修正．
* 2022-07-13
    - 右側の柱が正しく配置されないバグ修正．
* 2022-11-28
    - `\SetBlockHeadingSpaces`時に柱への登録が行われなかったバグを修正．
    - ISO C4の用紙サイズが間違っていたのを修正．
    - `jlreq-complements`を追加．
    - その他バグ修正やその他のパッケージとの調整など．
* 2023-03-05
    - 窓見出しに関するバグ修正
* 2023-06-19
    - LuaLaTeX利用時の`everyhook'パッケージの利用をやめた（ドキュメントと整合的でなかった）．
    - `enumerate'環境直前の空白が入らないことがあったのを修正．
    - `use_reverse_pagination`に関するバグ修正．
* 2024-02-13
    - LaTeXのhookシステムのために\parをいくつか挿入．
    - `\jlreqsetup`に`tableofcontents_twocolumn`，`abstract_with_maketitle`を追加．
    - `everyhook`の機能が呼び出されていたのを削除．
    - jfmを少し修正．
    - 見出し内で無限ループが出ることがあったのを修正．
    - LuaLaTeX利用時に`stfloats`を読み込むようにした．
    - ページスタイル内の位置調整を改善．
    - そのほかいくつか改善など．
* 2024-02-16
    - バグ修正
* 2024-08-23
    - バグ修正
    - 内部変数名の変更
    - 英語ドキュメントに使い方を書いた
    - `\DeclareKeys`などを使うようにした．
    - 行見出しの内部処理をちょっとだけ変更．
* 2024-09-26
    - Makefileでのパターンマッチングの使用をやめた
* 2024-10-03
    - Makefile内のvf一覧にtfmが紛れていたのを修正．
* 2025-03-16
    - hyperrefパッケージへの対応を進めた．
    - 割注の深さと高さをまわりにあわせた．
    - 見出し内での`\addconentsline`の発行場所を変更．
    - 定理環境前後の空白や見出しのフォントなどのデフォルト値を少し変更．


--------------
Noriyuki Abe
https://github.com/abenori/jlreq
