doc/format.ja.md in review-5.5.0 vs doc/format.ja.md in review-5.6.0
- old
+ new
@@ -94,11 +94,11 @@
通常の段落との誤った結合を防ぐため、箇条書きの前後には空行を入れることをお勧めします（他の箇条書きも同様）。
## 番号付き箇条書き
-番号付きの箇条書き（HTML で言う ol）は「` 1. 〜`」「` 2. 〜`」「` 3. 〜`」のように示します。ネストはサポートしていません。
+番号付きの箇条書き（HTML で言う ol）は「` 1. 〜`」「` 2. 〜`」「` 3. 〜`」のように示します。`1-1` のようなネスト出力は標準では提供していません（ `//beginchild` 〜 `//endchild` を使った入れ子の表現は可能です）。
例:
```
1. 第1の条件
@@ -106,10 +106,27 @@
3. 第3の条件
```
番号付き箇条書きも、ただの箇条書きと同様、行頭に1つ以上の空白が必要です。
+数字が実際にそのとおり出るかは、出力を行うソフトウェアに依存します。
+
+- HTML (EPUB), TeX: 記入の数字にかかわらず1から始まる番号になります。
+- IDGXML, テキスト: 記入したとおりの番号が出力されます。よって、すべて「1.」にするといった形にしてしまうとおかしな結果になります。
+
+HTML (EPUB) や TeX ビルダにおいて最初の番号を 1 ではないものにしたいときには、`//olnum[番号]` を指定します。なお、番号箇条書きの途中の番号を変えることはできません。
+
+例:
+
+```
+//olnum[10]
+
+ 1. この箇条書きの番号は出力ソフトウェア上では10になる
+ 2. これは11になる
+ 6. 記入上で飛ばしても連続数で12となる
+```
+
## 用語リスト
用語リスト（HTML で言う dl）は空白→「:」→空白、で始まる行を使って示します。
例:
@@ -184,11 +201,11 @@
あくまでも代替であり、推奨する記法ではありません。濫用は避けてください。
## ソースコードなどのリスト
-ソースコードなどのリストには`//list`を使います。連番を付けたくない場合は先頭に `em`（embedded の略）、行番号を付ける場合は末尾に `num` を付加します。まとめると、以下の4種類になります。
+ソースコードなどのリストには `//list` を使います。連番を付けたくない場合は先頭に `em`（embedded の略）、行番号を付ける場合は末尾に `num` を付加します。まとめると、以下の4種類になります。
* `//list[識別子][キャプション][言語指定]{ 〜 //}`
* 通常のリスト。言語指定は省略できます。
* `//listnum[識別子][キャプション][言語指定]{ 〜 //}`
* 通常のリストに行番号をつけたもの。言語指定は省略できます。
@@ -469,11 +486,11 @@
complexmatrixという識別子に基づく画像ファイルが貼り込まれる。
探索ルールはimageと同じ
//}
```
-## 引用
+## 引用・中央揃え・右揃え
引用は「`//quote{ 〜 //}`」を使って記述します。
例:
@@ -483,10 +500,28 @@
//}
```
複数の段落を入れる場合は、空行で区切ります。
+中央揃えの段落を表現するには、「`//centering{ 〜 //}`」を使います。同様に右寄せにするには「`//flushright{ 〜 //}`」を使います。複数の段落を入れる場合は、空行で区切ります。
+
+例:
+
+```
+//centering{
+これは
+
+中央合わせ
+//}
+
+//flushright{
+これは
+
+右寄せ合わせ
+//}
+```
+
## 囲み記事
技術書でよくある、コラムにするほどではないけれども本文から独立したちょっとした記事を入れるために、以下の命令があります。
* `//note[キャプション]{ 〜 //}` : ノート
@@ -632,11 +667,11 @@
//}
```
参照するにはインライン命令 `@<eq>` を使います（たとえば `@<eq>{emc}`）。
-インライン命令では `@<m>{〜}` を使います。インライン命令の式中に「}」を含む場合、`\}` とエスケープする必要があることに注意してください（`{` はエスケープ不要）。「インライン命令のフェンス記法」も参照してください。
+インライン命令では `@<m>{〜}` を使います。インライン命令の式中に「}」を含む場合、`\}` とエスケープする必要があることに注意してください（`{` はエスケープ不要）。長い式を書くときにはフェンス記法（`@<m>$〜$` または `@<m>|〜|`）を使うと、エスケープが不要になり、記述が楽になります。「インライン命令のフェンス記法」を参照してください。
LaTeX の数式が正常に整形されるかどうかは処理系に依存します。LaTeX を利用する PDFMaker では問題なく利用できます。
EPUBMaker および WEBMaker では、MathML に変換する方法、MathJax に変換する方法、画像化する方法から選べます。
@@ -887,37 +922,12 @@
@<comment>{あとで書く}
```
## 生データ行
-Re:VIEW のタグ範囲を超えて何か特別な行を挿入したい場合、`//raw` ブロック命令や`//embed`ブロック命令、または `@<raw>` インライン命令や `@<embed>` インライン命令を使います。
+Re:VIEW のタグ範囲を超えて何か特別な行を挿入したい場合、`//embed`ブロック命令や `@<embed>` インライン命令を使います。ほかに従来の `//raw` ブロック命令および `@<raw>` インライン命令もありますが、IDGXML ビルダ以外での使用は推奨しません。
-### `//raw`行
-
-例:
-
-```
-//raw[|html|<div class="special">\nここは特別な行です。\n</div>]
-```
-
-ブロック命令は1つだけオプションをとり、「|ビルダ名|そのまま出力させる内容」という書式です。`\n`は改行文字に変換されます。
-
-ビルダ名には「`html`」「`latex`」「`idgxml`」「`markdown`」「`top`」のいずれかが入ります。ビルダ名は「,」で区切って複数指定することも可能です。該当のビルダを使用しているときのみ、内容が出力されます。
-
-例:
-
-```
-（HTMLビルダの場合:）
-<div class="special">
-ここは特別な行です。
-</div>
-
-（ほかのビルダの場合は単に無視されて何も出力されない）
-```
-
-インライン命令は、`@<raw>{|ビルダ名|〜}` という書式で、記述はブロック命令に同じです。
-
### `//embed`ブロック
例:
```
@@ -961,17 +971,42 @@
ここは特別なブロックとして扱われます
</div>
```
+### `//raw`行（IDGXML ビルダ以外では非推奨）
+
+例:
+
+```
+//raw[|html|<div class="special">\nここは特別な行です。\n</div>]
+```
+
+ブロック命令は1つだけオプションをとり、「|ビルダ名|そのまま出力させる内容」という書式です。`\n`は改行文字に変換されます。
+
+ビルダ名には「`html`」「`latex`」「`idgxml`」「`markdown`」「`top`」のいずれかが入ります。ビルダ名は「,」で区切って複数指定することも可能です。該当のビルダを使用しているときのみ、内容が出力されます。
+
+例:
+
+```
+（HTMLビルダの場合:）
+<div class="special">
+ここは特別な行です。
+</div>
+
+（ほかのビルダの場合は単に無視されて何も出力されない）
+```
+
+インライン命令は、`@<raw>{|ビルダ名|〜}` という書式で、記述はブロック命令に同じです。
+
`//raw`、`//embed`、`@<raw>` および `@<embed>` は、HTML、XML や TeX の文書構造を容易に壊す可能性があります。使用には十分に注意してください。
### 入れ子の箇条書き
Re:VIEW の箇条書きは `*` 型の箇条書きを除き、基本的に入れ子を表現できません。いずれの箇条書きも、別の箇条書き、あるいは図表・リストを箇条書きの途中に配置することを許容していません。
-この対策として、Re:VIEW 4.2 では試験的に `//beginchild`、`//endchild` というブロック命令を追加しています。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。
+この対策として、Re:VIEW 4.2 以降では `//beginchild`、`//endchild` というブロック命令があります。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。
```
* UL1
//beginchild
@@ -1052,10 +1087,12 @@
* `@<ttb>{〜}` : 等幅＋太字にします。
* `@<code>{〜}` : 等幅にします（コードの引用という性質）。
* `@<tcy>{〜}` : 縦書きの文書において文字を縦中横にします。
* `@<ins>{〜}` : 挿入箇所を明示します（デフォルトでは下線が引かれます）。
* `@<del>{〜}` : 削除箇所を明示します（デフォルトでは打ち消し線が引かれます）。
+* `@<sup>{〜}` : 上付き文字にします。
+* `@<sub>{〜}` : 下付き文字にします。
### 参照
* `@<chap>{章ファイル名}` : 「第17章」のような、章番号を含むテキストに置換されます。
* `@<title>{章ファイル名}` : その章の章題に置換されます。
* `@<chapref>{章ファイル名}` : 『第17章「さらに進んだ話題」』のように、章番号とタイトルを含むテキストに置換されます。
@@ -1065,19 +1102,19 @@
* `@<eq>{識別子}` : 式を参照します。
* `@<hd>{ラベルまたは見出し}` : 節や項を参照します。
* `@<column>{ラベルまたは見出し}` : コラムを参照します。
### その他
-* `@<ruby>{親文字, ルビ}` : ルビを振ります。たとえば `@<ruby>{愕然, がくぜん}` のように表記します。
+* `@<ruby>{親文字,ルビ}` : ルビを振ります。たとえば `@<ruby>{愕然,がくぜん}` のように表記します。
* `@<br>{}` : 段落途中で改行します。濫用は避けたいところですが、表のセル内や箇条書き内などで必要になることもあります。
* `@<uchar>{番号}` : Unicode文字を出力します。引数は16進数で指定します。
* `@<href>{URL}`, `@<href>{URL, 文字表現}` : ハイパーリンクを作成します（後述）。
* `@<icon>{識別子}` : インラインの画像を出力します。
* `@<m>{数式}` : インラインの数式を出力します。
* `@<w>{キー}` : キー文字列に対応する、単語ファイル内の値文字列を展開します。
* `@<wb>{キー}` : キー文字列に対応する、単語ファイル内の値文字列を展開し、太字にします。
-* `@<raw>{|ビルダ|〜}` : 生の文字列を出力します。`\}`は`}`に、`\\`は`\`に、`\n`は改行に置き換えられます。
* `@<embed>{|ビルダ|〜}` : 生の文字列を埋め込みます。`\}`は`}`に、`\\`は`\`に置き換えられます（`\n`はそのままです）。
+* `@<raw>{|ビルダ|〜}` : 生の文字列を出力します。`\}`は`}`に、`\\`は`\`に、`\n`は改行に置き換えられます（非推奨）。
* `@<idx>{文字列}` : 文字列を出力するとともに、索引として登録します。索引の使い方については、makeindex.ja.md を参照してください。
* `@<hidx>{文字列}` : 索引として登録します (idx と異なり、紙面内に出力はしません)。`親索引文字列<<>>子索引文字列` のように親子関係にある索引も定義できます。
* `@<balloon>{〜}` : コードブロック (emlist など) 内などでのいわゆる吹き出しを作成します。たとえば「`@<balloon>{ABC}`」とすると、「`←ABC`」となります。デフォルトの挙動および表現は簡素なので、より装飾されたものにするにはスタイルシートを改変するか、`review-ext.rb` を使って挙動を書き換える必要があります。
## 著者用タグ（プリプロセッサ命令）