summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/jlreq/README-ja.md
blob: f491a116eaaf13110ab2ec5134bdf7ff12fa9086 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# jlreq

## これは何?
[日本語組版処理の要件](https://www.w3.org/TR/jlreq/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 -> $TEXMF/tex/luatex/jlreq
* jlreq.cls -> $TEXMF/tex/latex/jlreq

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

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

その他,`oneside / twoside / onecolumn / twocolumn / titlepage / notitlepage / draft / final / openright / openany / leqno / fleqn`というよくあるオプションを受け付けます.

標準的な文書クラスと同じように中身を書くことができますが,次のような命令が追加 / 拡張されています.

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

### `\sidenote`
傍注(縦組みの場合は脚注)を出力します.デフォルトでは`\footnote`と同様の書式となりますが,クラスオプションに`sidenote_type=mark`が指定されている場合,その書式は`\sidenote{該当項目}{注}`となります.たとえば
````
刊行できる\sidenote{原稿}{印刷などの方法により……}を入手する仕事である.
````
とします.後の説明も参照してください.

デフォルトの基本版面では余白が少なく,実用にはならないかと思います.後の基本版面の設定を参考にしてください.

### `\endnote`
後注を指定します.`\footnote`と同様の書式です.デフォルトでは,注自身の出力は見出し直前に行われます.この動作はクラスオプションにより制御できます.また`\theendnotes`を実行するとその場に出力をします.

### `\warichu`
割注を出力します.行分割位置などは自動で計算されます.(複数回のコンパイルが必要.)`\warichu*`ではこれらの位置を手動で指定できます.書式は

``\warichu*{(一行目前) & (一行目後)\\ (二行目前) & (二行目後)...}``

です.`&`が省略されている場合は自動で調整されます.

### `\jlreqsetup`
設定用命令です.プリアンブルでしか使えません.文書に対する殆どの設定はクラスオプションにより行いますが,一部の設定はこの命令を通じて行います.

### その他
* ルビは提供されません.[PXrubrica](https://github.com/zr-tex8r/PXrubrica)またはluatexja-ruby(LuaTeX利用時のみ,LuaTeX-jaパッケージに付属)を使うと良いかと思います.
* 日本語組版処理の要件2.3.2.dによれば,二段組の最後のページの各段の行数は揃えることが望ましいとされていますが,この処理は行われません.`nidanfloat`パッケージを使い,
````
\usepackage[balance]{nidanfloat}
````
とするとこの処理が行われます.ただし,最終ページでの`\newpage`や`\clearpage`が正しく動作しません.詳しくは`nidanfloat`パッケージのマニュアルをご覧ください.

## 各種設計
設計はクラスオプションまたは`\jlreqsetup`によりkeyval形式で行います.以下では次の用法を使います.

* `[A/B]`: AまたはBです.`[A/B/C]`等も同様.
* `<寸法>`: TeXが認識する寸法です.簡単な式(10pt+10ptのような)を使うこともできます.また,場合によっては次のような特殊な値を使うこともできます.
	* `Q`: 0.25mmと解釈されます.
	* `zh`, `zw`: 全角幅として解釈されます.

たとえば`Q`が利用可能な場合は`<寸法;Q>`のように記述します.


### 基本版面
すべてクラスファイルへのオプションです.

* `paper=[<紙サイズ名>/{<寸法>,<寸法>}]`:紙サイズです.紙サイズ名はa0からa10,b0からb10,c2からc8を指定できます.B列はJIS B列です.また,`{<縦>,<横>}`と直接寸法を指定することもできます.
* `fontsize=<寸法;Q>` : フォントサイズ.デフォルトは10pt.
* `line_length=<寸法;zw,zh>` : 一行の長さ.デフォルトは紙の縦幅の0.75倍.実際の値は一文字の長さの整数倍になるように補正されます.
* `number_of_lines=<整数値>` : 一ページの行数.デフォルトは紙の横幅の0.75倍になるような値.
* `gutter=<寸法;zh,zw>` : のどの余白の大きさ.
    - `tate`無指定時は奇数ページ左,偶数ページ右の余白
    - `tate`指定時は奇数ページ右,偶数ページ左の余白
    - `twoside`が指定されていない時は,常に奇数ページ扱いで余白が設定される
* `head_space=<寸法;zh,zw>` : 天の空き量.デフォルトは中央寄せになるような値.
* `foot_space=<寸法;zh,zw>` : 地の空き量.デフォルトは中央寄せになるような値.
* `baselineskip=<寸法;Q,zh,zw>` : 行送り.デフォルトはfontsizeの1.7倍.
* `linegap=<寸法;Q,zh,zw>` : 行間.
* `headfoot_sidemargin=<寸法;zw,zh>`:柱やノンブルの左右の空き.
* `column_gap=<寸法;zw,zh>`: 段間(twocolumn指定時のみ).

### 組み方
* `open_bracket_pos=[zenkaku_tentsuki/zenkakunibu_nibu/nibu_tentsuki]`: 始め括弧が行頭に来た際の配置方法を指定します.それぞれ段落開始全角折り返し行頭天付き(デフォルト),段落開始全角二分折り返し行頭二分,段落開始二分折り返し行頭天付きを意味します.
* `hanging_punctuation`: ぶら下げ組をします.

### 注関係
* `reference_mark=[inline/interlinear]`: 合印の配置方法を指定します.`inline`にすると該当項目の後ろの行中に配置します.`interlinear`を指定すると該当項目の上(横組)または右(縦組)に配置します.
* `sidenote_type=[number/symbol]`: 傍注と本文との対応の方法を指定します.`number`が規定で,注の位置に通し番号が入り,それにより対応が示されます.`symbol`とすると,注の位置に特定の記号が入り,また注がついている単語が強調されます.ここに入る記号と単語の強調は`\jlreqsetup`に次を渡すことで指定します.

    - `sidenote_symbol`: 注の位置に入る記号.デフォルト*
    - `sidenote_keyword_font`: 注のついている単語のフォント命令.デフォルトは無し(強調しない)

* `sidenote_width=<寸法;zh,zw>`: 傍注の幅を指定します.基本版面の設定に合わせて設定してください.
* `endnote_position=[headings/paragraph/{_<見出し名1>,_<見出し名2>,...}]`:後注の出力場所を指定します.`headings`は各見出しの直前(デフォルト),`paragraph`は改段落の際に出力します.また,`endnote_position={_chapter,_section}`とすると,`\chapter`と`\section`の直前に出力します.

### キャプション
図表のキャプションを`\jlreqsetup`で変更できます.
* `caption_font=<命令>`: キャプション自身のフォントを指定します.
* `caption_label_font=<命令>`: キャプションのラベルのフォントを指定します.


## 見出し
見出しの設定は,`\Declare***Heading`という命令で行います(***には見出しの種類に応じた文字列が入る).書式はすべて

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

となっています.また,`\New***Heading`,`\Renew***Heading`,`\Provide***Heading`も同時に用意されます.それぞれ`\newcommand`,`\renewcommand`,`\providecommand`に対応した動きをします.

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

* `type=[han/naka]`: `han`だと半扉見出しを,`naka`だと中扉見出しを作ります.
* `pagestyle=<ページスタイル>`: 見出し箇所のページスタイルを指定します.
* `label_format=<書式>`: ラベルを出力する命令を指定します.たとえば`label_format={第\thechapter 章}`のように指定します.
* `format=<書式>`: 実際に出力する書式を指定します.`format={\null\vfill {\Huge\bfseries #1#2}}`のようにします.`#1`はラベルに,`#2`は見出し文字列に置き換えられます.

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

* `font=<命令>`: 見出しのフォントを指定します.
* `indent=<整数値>` 見出し全体の字下げ量を全角文字数で指定します.
* `subtitle_font=<命令>`: 副題のフォントを指定します.
* `pagebreak=[clearpage/cleardoublepage/clearcolumn/nariyuki]`: 見出し直前の改ページを指定します.それぞれ,改ページ,改丁,改段,なりゆきです.

また,行取りの指定を行うことができます.次のいずれかの方法で行います.

* 行数を指定し,その中央に配置する.`lines=<整数値>`により行数を指定します.`before_lines=<整数値>`や`after_lines=<整数値>`により,さらに前後に追加する行数を指定します.たとえば`lines=3,after_lines=1`とすれば,四行の中に配置され,前の空きよりも後ろの空きの方が一行分大きくなります.
* 行数と,前後いずれかの空きを指定します.`lines=<整数値>`により行数を,`before_space=<寸法>`または`after_space=<寸法>`のいずれかの指定によりそれぞれ前またら後ろの空きを指定します.
* 前後の空きを指定します.`before_space=<寸法>`および`after_space=<寸法>`を指定します.

### 同行見出し
`\DeclareRuninHeading`で作成します.`\section`と同様の書式の命令が作成されます.設定は以下の通り.

* `font=<命令>`: 見出しのフォントを指定します.
* `indent=<整数値>` 見出し文字列全体の字下げ量を全角文字数で指定します.

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

* `font=<命令>`: 見出しのフォントを指定します.
* `indent=<整数値>`: 見出し全体の字下げ量を全角文字数で指定します.
* `onelinemax=<寸法>`, `twolinemax=<寸法>`: 見出し文字列の長さが`onelinemax`以下ならば一行で,`twolinemax`以下ならば二行で窓見出しを出力します.それ以上の場合は三行です.デフォルトはそれぞれ6文字,20文字の長さ.

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

## ページスタイル

````
\DeclarePageStyle{<ページスタイル名>}{<設定>}
````
によりページスタイルを定義することができます.設定は以下の通り.

* `nombre_position`,`running_head_position`: ノンブルと柱の位置を指定します.`top-left`のように指定できます.`center/left/right/top/bottom`が使えます.
* `nombre=<書式>`: 出力するノンブルを指定します.デフォルトは`\thepage`.
* `odd_running_head=<書式>`,`even_running_head=<書式>`:それぞれ奇数ページ,偶数ページの柱を指定します.`_section`のように`_`から始まる名前を指定すると,対応する見出しを出力します.(`_section`だと現在の`\section`を出力する.)

`\ModifyPageStyle`により既存のページスタイルを改変することが可能です.

## その他
* クラスオプション`jlreq_warnings`を渡されると,日本語組版処理の要件に反する設定が行われた場合に警告がされます.

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

## 履歴
* 2017-02-08
    - 最初のバージョン.
* 2017-02-17
    - いくつかバグを修正.
    - クラスオプション/`\jlreqsetup`にいくつかのキーを追加/変更.
    - `abstract`環境を実装.
    - パッケージを読み込んでいるだけのはやめた.